GC_MakeHyperbola Class Reference

This class implements construction algorithms for a hyperbola in 3D space. The result is a Geom_Hyperbola hyperbola. A MakeHyperbola object provides a framework for: More...

#include <GC_MakeHyperbola.hxx>

Inheritance diagram for GC_MakeHyperbola:

Public Member Functions
	GC_MakeHyperbola (const gp_Hypr &H)
	Creates an Hyperbola from a non persistent hyperbola from package gp by conversion.
	GC_MakeHyperbola (const gp_Ax2 &A2, const Standard_Real MajorRadius, const Standard_Real MinorRadius)
	Constructs a hyperbola centered on the origin of the coordinate system A2, with major and minor radii MajorRadius and MinorRadius, where: the plane of the hyperbola is defined by the "X Axis" and "Y Axis" of A2,.
	GC_MakeHyperbola (const gp_Pnt &S1, const gp_Pnt &S2, const gp_Pnt &Center)
	Constructs a hyperbola centered on the point Center, where.
const Handle< Geom_Hyperbola > &	Value () const
	Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed.
	operator const Handle< Geom_Hyperbola > & () const
Public Member Functions inherited from GC_Root
Standard_Boolean	IsDone () const
	Returns true if the construction is successful.
gce_ErrorType	Status () const
	Returns the status of the construction:

Additional Inherited Members
Protected Attributes inherited from GC_Root
gce_ErrorType	TheError

Detailed Description

This class implements construction algorithms for a hyperbola in 3D space. The result is a Geom_Hyperbola hyperbola. A MakeHyperbola object provides a framework for:

• defining the construction of the hyperbola,
• implementing the construction algorithm, and
• consulting the results. In particular, the Value function returns the constructed hyperbola. To define the main branch of an hyperbola. The parameterization range is ]-infinite,+infinite[ It is possible to get the other branch and the two conjugate branches of the main branch.

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

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

Constructor & Destructor Documentation

GC_MakeHyperbola() [1/3]

GC_MakeHyperbola::GC_MakeHyperbola

(

const gp_Hypr &

H

)

Creates an Hyperbola from a non persistent hyperbola from package gp by conversion.

GC_MakeHyperbola() [2/3]

GC_MakeHyperbola::GC_MakeHyperbola	(	const gp_Ax2 &	A2,
		const Standard_Real	MajorRadius,
		const Standard_Real	MinorRadius )

Constructs a hyperbola centered on the origin of the coordinate system A2, with major and minor radii MajorRadius and MinorRadius, where: the plane of the hyperbola is defined by the "X Axis" and "Y Axis" of A2,.

• its major axis is the "X Axis" of A2.

GC_MakeHyperbola() [3/3]

GC_MakeHyperbola::GC_MakeHyperbola	(	const gp_Pnt &	S1,
		const gp_Pnt &	S2,
		const gp_Pnt &	Center )

Constructs a hyperbola centered on the point Center, where.

• the plane of the hyperbola is defined by Center, S1 and S2,
• its major axis is defined by Center and S1,
• its major radius is the distance between Center and S1, and
• its minor radius is the distance between S2 and the major axis;

Member Function Documentation

operator const Handle< Geom_Hyperbola > &()

GC_MakeHyperbola::operator const Handle< Geom_Hyperbola > & ( ) const

inline

Value()

const Handle< Geom_Hyperbola > & GC_MakeHyperbola::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:

• GC_MakeHyperbola.hxx