Open CASCADE Technology  7.3.1.dev
Public Member Functions
gce_MakeHypr2d Class Reference

This class implements the following algorithms used to create a 2d Hyperbola from gp. More...

#include <gce_MakeHypr2d.hxx>

Inheritance diagram for gce_MakeHypr2d:
Inheritance graph
[legend]

Public Member Functions

 gce_MakeHypr2d (const gp_Pnt2d &S1, const gp_Pnt2d &S2, const gp_Pnt2d &Center)
 Constructs a hyperbola centered on the point Center, where: More...
 
 gce_MakeHypr2d (const gp_Ax2d &MajorAxis, const Standard_Real MajorRadius, const Standard_Real MinorRadius, const Standard_Boolean Sense)
 Constructs a hyperbola with major and minor radii MajorRadius and MinorRadius, where: More...
 
 gce_MakeHypr2d (const gp_Ax22d &A, const Standard_Real MajorRadius, const Standard_Real MinorRadius)
 Creates a Hypr2d centered on the origin of the coordinate system A, with major and minor radii MajorRadius and MinorRadius, where its major axis is the "X Axis" of A (A is the local coordinate system of the hyperbola). More...
 
const gp_Hypr2dValue () const
 Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed. More...
 
const gp_Hypr2dOperator () const
 
 operator gp_Hypr2d () const
 
- Public Member Functions inherited from gce_Root
Standard_Boolean IsDone () const
 Returns true if the construction is successful. More...
 
gce_ErrorType Status () const
 Returns the status of the construction: More...
 

Additional Inherited Members

- Protected Attributes inherited from gce_Root
gce_ErrorType TheError
 

Detailed Description

This class implements the following algorithms used to create a 2d Hyperbola from gp.

^YAxis | FirstConjugateBranch | Other | Main ------------------— C ---------------------------—>XAxis Branch | Branch | | SecondConjugateBranch |

An axis placement (one axis) is associated with the hyperbola. This axis is the "XAxis" or major axis of the hyperbola. It is the symmetry axis of the main branch of hyperbola. The "YAxis" is normal to this axis and pass throught its location point. It is the minor axis.

The major radius is the distance between the Location point of the hyperbola C and the vertex of the Main Branch (or the Other branch). The minor radius is the distance between the Location point of the hyperbola C and the vertex of the First (or Second) Conjugate branch. The major radius can be lower than the minor radius.

Constructor & Destructor Documentation

◆ gce_MakeHypr2d() [1/3]

gce_MakeHypr2d::gce_MakeHypr2d ( const gp_Pnt2d S1,
const gp_Pnt2d S2,
const gp_Pnt2d Center 
)

Constructs a hyperbola centered on the point Center, where:

  • the major axis of the hyperbola is defined by Center and point S1,
  • the major radius is the distance between Center and S1, and
  • the minor radius is the distance between point S2 and the major axis.

◆ gce_MakeHypr2d() [2/3]

gce_MakeHypr2d::gce_MakeHypr2d ( const gp_Ax2d MajorAxis,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius,
const Standard_Boolean  Sense 
)

Constructs a hyperbola with major and minor radii MajorRadius and MinorRadius, where:

  • the center of the hyperbola is the origin of the axis MajorAxis, and
  • the major axis is defined by MajorAxis if Sense is true, or the opposite axis to MajorAxis if Sense is false; or
  • centered on the origin of the coordinate system A, with major and minor radii MajorRadius and MinorRadius, where its major axis is the "X Axis" of A (A is the local coordinate system of the hyperbola).

◆ gce_MakeHypr2d() [3/3]

gce_MakeHypr2d::gce_MakeHypr2d ( const gp_Ax22d A,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius 
)

Creates a Hypr2d centered on the origin of the coordinate system A, with major and minor radii MajorRadius and MinorRadius, where its major axis is the "X Axis" of A (A is the local coordinate system of the hyperbola).

Member Function Documentation

◆ Operator()

const gp_Hypr2d& gce_MakeHypr2d::Operator ( ) const

◆ operator gp_Hypr2d()

gce_MakeHypr2d::operator gp_Hypr2d ( ) const

◆ Value()

const gp_Hypr2d& gce_MakeHypr2d::Value ( ) const

Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed.


The documentation for this class was generated from the following file: