GC_MakeHyperbola2d Class Reference

This class implements construction algorithms for hyperbolas in the plane. The result is a Geom2d_Hyperbola (main branch). A GC_MakeHyperbola2d object provides a framework for: More...

#include <GC_MakeHyperbola2d.hxx>

Inheritance diagram for GC_MakeHyperbola2d:

Public Member Functions
	GC_MakeHyperbola2d (const gp_Hypr2d &theHyperbola)
	Creates a hyperbola from a non-persistent one from package gp.
	GC_MakeHyperbola2d (const gp_Ax2d &theMajorAxis, const double theMajorRadius, const double theMinorRadius, const bool theSense)
	Creates a hyperbola from major axis placement and radii.
	GC_MakeHyperbola2d (const gp_Ax22d &theAxis, const double theMajorRadius, const double theMinorRadius)
	Creates a hyperbola from local coordinate system and radii.
	GC_MakeHyperbola2d (const gp_Pnt2d &theS1, const gp_Pnt2d &theS2, const gp_Pnt2d &theCenter)
	Creates a hyperbola from two apex points and center point.
const occ::handle< Geom2d_Hyperbola > &	Value () const
	Returns the constructed hyperbola. Exceptions: StdFail_NotDone if no hyperbola is constructed.
	operator const occ::handle< Geom2d_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

This class implements construction algorithms for hyperbolas in the plane. The result is a Geom2d_Hyperbola (main branch). A GC_MakeHyperbola2d object provides a framework for:

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

  Note

  Hyperbola parameterization range is ]-infinite, +infinite[.

  In the local coordinate system, the X axis is the major axis and the Y axis is the minor axis.

Constructor & Destructor Documentation

GC_MakeHyperbola2d() [1/4]

GC_MakeHyperbola2d::GC_MakeHyperbola2d

(

const gp_Hypr2d &

theHyperbola

)

Creates a hyperbola from a non-persistent one from package gp.

Parameters

[in]

theHyperbola

source hyperbola

GC_MakeHyperbola2d() [2/4]

GC_MakeHyperbola2d::GC_MakeHyperbola2d	(	const gp_Ax2d &	theMajorAxis,
		const double	theMajorRadius,
		const double	theMinorRadius,
		const bool	theSense )

Creates a hyperbola from major axis placement and radii.

Parameters

[in]	theMajorAxis	major axis placement
[in]	theMajorRadius	major radius value
[in]	theMinorRadius	minor radius value
[in]	theSense	orientation flag

Note

Error status is provided by the underlying gce_MakeHypr2d (for example gce_NegativeRadius).

GC_MakeHyperbola2d() [3/4]

GC_MakeHyperbola2d::GC_MakeHyperbola2d	(	const gp_Ax22d &	theAxis,
		const double	theMajorRadius,
		const double	theMinorRadius )

Creates a hyperbola from local coordinate system and radii.

Parameters

[in]	theAxis	local coordinate system
[in]	theMajorRadius	major radius value
[in]	theMinorRadius	minor radius value

Note

Error status is provided by the underlying gce_MakeHypr2d (for example gce_NegativeRadius).

GC_MakeHyperbola2d() [4/4]

GC_MakeHyperbola2d::GC_MakeHyperbola2d	(	const gp_Pnt2d &	theS1,
		const gp_Pnt2d &	theS2,
		const gp_Pnt2d &	theCenter )

Creates a hyperbola from two apex points and center point.

Parameters

[in]	theS1	first apex point
[in]	theS2	second point defining conjugate radius
[in]	theCenter	center point

Note

Error status is provided by the underlying gce_MakeHypr2d (for example gce_ConfusedPoints or gce_ColinearPoints).

Member Function Documentation

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

GC_MakeHyperbola2d::operator const occ::handle< Geom2d_Hyperbola > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting hyperbola

Value()

const occ::handle< Geom2d_Hyperbola > & GC_MakeHyperbola2d::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_MakeHyperbola2d.hxx