gce_MakeHypr2d Class Reference

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

#include <gce_MakeHypr2d.hxx>

Inheritance diagram for gce_MakeHypr2d:

Public Member Functions
	gce_MakeHypr2d (const gp_Pnt2d &S1, const gp_Pnt2d &S2, const gp_Pnt2d &Center)
	Creates a hyperbola from center and two points.
	gce_MakeHypr2d (const gp_Ax2d &MajorAxis, const double MajorRadius, const double MinorRadius, const bool Sense)
	Creates a hyperbola from major axis and radii.
	gce_MakeHypr2d (const gp_Ax22d &A, const double MajorRadius, const double MinorRadius)
	Creates a hyperbola from local coordinate system and radii.
const gp_Hypr2d &	Value () const
	Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed.
gp_Hypr2d	Operator () const
	Alias for Value() returning a copy.
	operator gp_Hypr2d () 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_Hypr2d. Supported constructions include:

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

^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. The "YAxis" is normal to this axis and passes through 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 )

Creates a hyperbola from center and two points.

Note

Center is the hyperbola center, Center-S1 defines 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

gce_MakeHypr2d() [2/3]

gce_MakeHypr2d::gce_MakeHypr2d	(	const gp_Ax2d &	MajorAxis,
		const double	MajorRadius,
		const double	MinorRadius,
		const bool	Sense )

Creates a hyperbola from major axis and radii.

Note

Center is located at MajorAxis.Location().

If Sense is false, the opposite direction of MajorAxis is used.

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

Parameters

[in]	MajorAxis	major axis placement
[in]	MajorRadius	major radius value
[in]	MinorRadius	minor radius value
[in]	Sense	orientation flag

gce_MakeHypr2d() [3/3]

gce_MakeHypr2d::gce_MakeHypr2d	(	const gp_Ax22d &	A,
		const double	MajorRadius,
		const double	MinorRadius )

Creates a hyperbola from local coordinate system and radii.

Note

The result is centered at A.Location(), and its major axis follows the X axis direction of A.

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

Parameters

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

Member Function Documentation

Operator()

gp_Hypr2d gce_MakeHypr2d::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Hypr2d()

gce_MakeHypr2d::operator gp_Hypr2d ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Hypr2d & gce_MakeHypr2d::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_MakeHypr2d.hxx