include/opencascade/GC_MakeHyperbola.hxx

0001 // Created on: 1992-09-28
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _GC_MakeHyperbola_HeaderFile
0018 #define _GC_MakeHyperbola_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GC_Root.hxx>
0025 #include <Geom_Hyperbola.hxx>
0026
0027 class gp_Hypr;
0028 class gp_Ax2;
0029 class gp_Pnt;
0030
0031 //! Implements construction algorithms for hyperbolas in 3D space.
0032 //! The result is a `Geom_Hyperbola`.
0033 //! A MakeHyperbola object provides a framework for:
0034 //! -   defining the construction of the hyperbola,
0035 //! -   implementing the construction algorithm, and
0036 //! -   consulting the results. In particular, the Value
0037 //! function returns the constructed hyperbola.
0038 //! To define the main branch of a hyperbola.
0039 //! The parameterization range is ]-infinite,+infinite[
0040 //! It is possible to get the other branch and the two conjugate
0041 //! branches of the main branch.
0042 //!
0043 //! ^YAxis
0044 //! |
0045 //! FirstConjugateBranch
0046 //! |
0047 //! Other            |                Main
0048 //! --------------------- C ------------------------------>XAxis
0049 //! Branch           |                Branch
0050 //! |
0051 //! SecondConjugateBranch
0052 //! |
0053 //!
0054 //! The major radius is the distance between the Location point
0055 //! of the hyperbola C and the apex of the Main Branch (or the
0056 //! Other branch). The major axis is the XAxis.
0057 //! The minor radius is the distance between the Location point
0058 //! of the hyperbola C and the apex of the First (or Second)
0059 //! Conjugate branch. The minor axis is the YAxis.
0060 //! The major radius can be lower than the minor radius.
0061 class GC_MakeHyperbola : public GC_Root
0062 {
0063 public:
0064   DEFINE_STANDARD_ALLOC
0065
0066   //! Creates a hyperbola from a `gp_Hypr`.
0067   //! @param[in] theH source hyperbola
0068   Standard_EXPORT GC_MakeHyperbola(const gp_Hypr& theH);
0069
0070   //! Constructs a hyperbola centered on the origin of the coordinate system
0071   //! A2, with major and minor radii MajorRadius and MinorRadius, where:
0072   //! the plane of the hyperbola is defined by the "X Axis" and "Y Axis" of A2,
0073   //! -   its major axis is the "X Axis" of A2.
0074   //! @param[in] theA2 hyperbola local coordinate system
0075   //! @param[in] theMajorRadius major radius
0076   //! @param[in] theMinorRadius minor radius
0077   Standard_EXPORT GC_MakeHyperbola(const gp_Ax2& theA2,
0078                                    const double  theMajorRadius,
0079                                    const double  theMinorRadius);
0080
0081   //! Constructs a hyperbola centered on the point Center, where
0082   //! -   the plane of the hyperbola is defined by Center, S1 and S2,
0083   //! -   its major axis is defined by Center and S1,
0084   //! -   its major radius is the distance between Center and S1, and
0085   //! -   its minor radius is the distance between S2 and the major axis;
0086   //! @param[in] theS1 point defining the major axis
0087   //! @param[in] theS2 point defining the minor radius
0088   //! @param[in] theCenter hyperbola center
0089   Standard_EXPORT GC_MakeHyperbola(const gp_Pnt& theS1,
0090                                    const gp_Pnt& theS2,
0091                                    const gp_Pnt& theCenter);
0092
0093   //! Returns the constructed hyperbola.
0094   //! Exceptions StdFail_NotDone if no hyperbola is constructed.
0095   //! @return resulting hyperbola
0096   Standard_EXPORT const occ::handle<Geom_Hyperbola>& Value() const;
0097
0098   //! Conversion operator returning the constructed object.
0099   //! @return resulting object
0100   operator const occ::handle<Geom_Hyperbola>&() const { return Value(); }
0101
0102 private:
0103   occ::handle<Geom_Hyperbola> TheHyperbola;
0104 };
0105
0106 #endif // _GC_MakeHyperbola_HeaderFile