GC_MakeArcOfHyperbola Class Reference

Implements construction algorithms for hyperbola arcs in 3D space. The result is a Geom_TrimmedCurve. A MakeArcOfHyperbola object provides a framework for: More...

#include <GC_MakeArcOfHyperbola.hxx>

Inheritance diagram for GC_MakeArcOfHyperbola:

Public Member Functions
	GC_MakeArcOfHyperbola (const gp_Hypr &theHypr, const double theAlpha1, const double theAlpha2, const bool theSense)
	Constructs an arc from angular bounds on a hyperbola.
	GC_MakeArcOfHyperbola (const gp_Hypr &theHypr, const gp_Pnt &theP, const double theAlpha, const bool theSense)
	Constructs an arc from a point and angle on a hyperbola.
	GC_MakeArcOfHyperbola (const gp_Hypr &theHypr, const gp_Pnt &theP1, const gp_Pnt &theP2, const bool theSense)
	Constructs an arc between two points on a hyperbola.
const occ::handle< Geom_TrimmedCurve > &	Value () const
	Returns the constructed arc of hyperbola.
	operator const occ::handle< Geom_TrimmedCurve > & () 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 hyperbola arcs in 3D space. The result is a Geom_TrimmedCurve. A MakeArcOfHyperbola object provides a framework for:

• defining the construction of the arc of hyperbola,
• implementing the construction algorithm, and
• consulting the results. In particular, the Value function returns the constructed arc of hyperbola.

Constructor & Destructor Documentation

GC_MakeArcOfHyperbola() [1/3]

GC_MakeArcOfHyperbola::GC_MakeArcOfHyperbola	(	const gp_Hypr &	theHypr,
		const double	theAlpha1,
		const double	theAlpha2,
		const bool	theSense )

Constructs an arc from angular bounds on a hyperbola.

Parameters

[in]	theHypr	source hyperbola
[in]	theAlpha1	first angle (radians)
[in]	theAlpha2	second angle (radians)
[in]	theSense	orientation of resulting arc

GC_MakeArcOfHyperbola() [2/3]

GC_MakeArcOfHyperbola::GC_MakeArcOfHyperbola	(	const gp_Hypr &	theHypr,
		const gp_Pnt &	theP,
		const double	theAlpha,
		const bool	theSense )

Constructs an arc from a point and angle on a hyperbola.

Parameters

[in]	theHypr	source hyperbola
[in]	theP	point on hyperbola
[in]	theAlpha	target angle (radians)
[in]	theSense	orientation of resulting arc

GC_MakeArcOfHyperbola() [3/3]

GC_MakeArcOfHyperbola::GC_MakeArcOfHyperbola	(	const gp_Hypr &	theHypr,
		const gp_Pnt &	theP1,
		const gp_Pnt &	theP2,
		const bool	theSense )

Constructs an arc between two points on a hyperbola.

Parameters

[in]	theHypr	source hyperbola
[in]	theP1	first point
[in]	theP2	second point
[in]	theSense	orientation of resulting arc

Note

The orientation of the arc of hyperbola is:

• the orientation of hyperbola if theSense is true, or
• the opposite orientation if theSense is false.

Member Function Documentation

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

GC_MakeArcOfHyperbola::operator const occ::handle< Geom_TrimmedCurve > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_TrimmedCurve > & GC_MakeArcOfHyperbola::Value

(

)

const

Returns the constructed arc of hyperbola.

Returns

resulting arc

---

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

• GC_MakeArcOfHyperbola.hxx