GC_MakeHyperbola Class Reference

Implements construction algorithms for hyperbolas in 3D space. The result is a Geom_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 &theH)
	Creates a hyperbola from a gp_Hypr.
	GC_MakeHyperbola (const gp_Ax2 &theA2, const double theMajorRadius, const double theMinorRadius)
	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 &theS1, const gp_Pnt &theS2, const gp_Pnt &theCenter)
	Constructs a hyperbola centered on the point Center, where.
const occ::handle< Geom_Hyperbola > &	Value () const
	Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed.
	operator const occ::handle< Geom_Hyperbola > & () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from GC_Root
bool	IsDone () const
	Returns true if the construction is successful.
bool	IsError () const
	Returns true if the construction has failed.
gce_ErrorType	Status () const
	Returns the status of the construction:

Additional Inherited Members
Protected Attributes inherited from GC_Root
gce_ErrorType	TheError

Detailed Description

Implements construction algorithms for hyperbolas in 3D space. The result is a Geom_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 a 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 &

theH

)

Creates a hyperbola from a gp_Hypr.

Parameters

[in]

theH

source hyperbola

GC_MakeHyperbola() [2/3]

GC_MakeHyperbola::GC_MakeHyperbola	(	const gp_Ax2 &	theA2,
		const double	theMajorRadius,
		const double	theMinorRadius )

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.

  Parameters

  [in]	theA2	hyperbola local coordinate system
  [in]	theMajorRadius	major radius
  [in]	theMinorRadius	minor radius

GC_MakeHyperbola() [3/3]

GC_MakeHyperbola::GC_MakeHyperbola	(	const gp_Pnt &	theS1,
		const gp_Pnt &	theS2,
		const gp_Pnt &	theCenter )

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;

  Parameters

  [in]	theS1	point defining the major axis
  [in]	theS2	point defining the minor radius
  [in]	theCenter	hyperbola center

Member Function Documentation

operator const occ::handle< Geom_Hyperbola > &()

GC_MakeHyperbola::operator const occ::handle< Geom_Hyperbola > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_Hyperbola > & GC_MakeHyperbola::Value

(

)

const

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

Returns

resulting hyperbola

---

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

• GC_MakeHyperbola.hxx