gce_MakeHypr Class Reference

This class implements construction algorithms for gp_Hypr. Supported constructions include: More...

#include <gce_MakeHypr.hxx>

Inheritance diagram for gce_MakeHypr:

Public Member Functions
	gce_MakeHypr (const gp_Ax2 &A2, const double MajorRadius, const double MinorRadius)
	Creates a hyperbola from a local coordinate system and radii.
	gce_MakeHypr (const gp_Pnt &S1, const gp_Pnt &S2, const gp_Pnt &Center)
	Creates a hyperbola from center and two points.
const gp_Hypr &	Value () const
	Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed.
gp_Hypr	Operator () const
	Alias for Value() returning a copy.
	operator gp_Hypr () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from gce_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 gce_Root
gce_ErrorType	TheError

Detailed Description

This class implements construction algorithms for gp_Hypr. Supported constructions include:

• hyperbola from center and two points (one on major axis);
• hyperbola from local coordinate system and radii.

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

The local Cartesian coordinate system of the hyperbola is an axis placement (two axes).

The "XDirection" and the "YDirection" of the axis placement define the plane of the hyperbola.

The "Direction" of the axis placement defines the normal axis to the hyperbola's plane.

The "XAxis" of the hyperbola ("Location", "XDirection") is the major axis and the "YAxis" of the hyperbola ("Location", "YDirection") is the minor axis.

Note

The major radius (on major axis) can be lower than the minor radius (on minor axis).

Constructor & Destructor Documentation

gce_MakeHypr() [1/2]

gce_MakeHypr::gce_MakeHypr	(	const gp_Ax2 &	A2,
		const double	MajorRadius,
		const double	MinorRadius )

Creates a hyperbola from a local coordinate system and radii.

Note

In the local coordinate system of A2, the equation is X*X / (MajorRadius*MajorRadius) - Y*Y / (MinorRadius*MinorRadius) = 1.0.

Construction with MajorRadius == MinorRadius is valid.

Construction fails with gce_NegativeRadius if MajorRadius < 0.0 or MinorRadius < 0.0.

Parameters

[in]	A2	local coordinate system
[in]	MajorRadius	major radius value
[in]	MinorRadius	minor radius value

gce_MakeHypr() [2/2]

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

Creates a hyperbola from center and two points.

Note

Center is the hyperbola center, Center-S1 defines the major axis, major radius is Distance(Center, S1), and minor radius is distance from S2 to this major axis.

Construction fails with gce_ConfusedPoints if any two of S1, S2, and Center are coincident.

Construction fails with gce_ColinearPoints if S1, S2, and Center are collinear.

Parameters

[in]	S1	first point
[in]	S2	second point
[in]	Center	center point

Member Function Documentation

Operator()

gp_Hypr gce_MakeHypr::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Hypr()

gce_MakeHypr::operator gp_Hypr ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Hypr & gce_MakeHypr::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:

• gce_MakeHypr.hxx