GC_MakeArcOfHyperbola2d Class Reference

This class implements construction algorithms for arcs of hyperbolas in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeArcOfHyperbola2d object provides a framework for: More...

#include <GC_MakeArcOfHyperbola2d.hxx>

Inheritance diagram for GC_MakeArcOfHyperbola2d:

Public Member Functions
	GC_MakeArcOfHyperbola2d (const gp_Hypr2d &theHyperbola, const double theAlpha1, const double theAlpha2, const bool theSense=true)
	Constructs an arc from angular bounds on a hyperbola.
	GC_MakeArcOfHyperbola2d (const gp_Hypr2d &theHyperbola, const gp_Pnt2d &thePoint, const double theAlpha, const bool theSense=true)
	Constructs an arc from a point and angular bound on a hyperbola.
	GC_MakeArcOfHyperbola2d (const gp_Hypr2d &theHyperbola, const gp_Pnt2d &theP1, const gp_Pnt2d &theP2, const bool theSense=true)
	Constructs an arc between two points on a hyperbola.
const occ::handle< Geom2d_TrimmedCurve > &	Value () const
	Returns the constructed arc of hyperbola.
	operator const occ::handle< Geom2d_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

This class implements construction algorithms for arcs of hyperbolas in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeArcOfHyperbola2d object provides a framework for:

• defining the construction parameters;
• running the construction algorithm;
• querying the construction status and the resulting arc via Value().

  Note

  Angular parameters are expressed in radians.

Constructor & Destructor Documentation

GC_MakeArcOfHyperbola2d() [1/3]

GC_MakeArcOfHyperbola2d::GC_MakeArcOfHyperbola2d	(	const gp_Hypr2d &	theHyperbola,
		const double	theAlpha1,
		const double	theAlpha2,
		const bool	theSense = true )

Constructs an arc from angular bounds on a hyperbola.

Parameters

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

GC_MakeArcOfHyperbola2d() [2/3]

GC_MakeArcOfHyperbola2d::GC_MakeArcOfHyperbola2d	(	const gp_Hypr2d &	theHyperbola,
		const gp_Pnt2d &	thePoint,
		const double	theAlpha,
		const bool	theSense = true )

Constructs an arc from a point and angular bound on a hyperbola.

Parameters

[in]	theHyperbola	source hyperbola
[in]	thePoint	point on source hyperbola
[in]	theAlpha	angle value (radians)
[in]	theSense	orientation of resulting arc

GC_MakeArcOfHyperbola2d() [3/3]

GC_MakeArcOfHyperbola2d::GC_MakeArcOfHyperbola2d	(	const gp_Hypr2d &	theHyperbola,
		const gp_Pnt2d &	theP1,
		const gp_Pnt2d &	theP2,
		const bool	theSense = true )

Constructs an arc between two points on a hyperbola.

Parameters

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

Note

Orientation is trigonometric when theSense is true, otherwise opposite.

IsDone always returns true.

Member Function Documentation

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

GC_MakeArcOfHyperbola2d::operator const occ::handle< Geom2d_TrimmedCurve > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting trimmed curve

Value()

const occ::handle< Geom2d_TrimmedCurve > & GC_MakeArcOfHyperbola2d::Value

(

)

const

Returns the constructed arc of hyperbola.

Returns

resulting trimmed curve

---

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

• GC_MakeArcOfHyperbola2d.hxx