GC_MakeParabola2d Class Reference

This class implements construction algorithms for parabolas in the plane. The result is a Geom2d_Parabola. A GC_MakeParabola2d object provides a framework for: More...

#include <GC_MakeParabola2d.hxx>

Inheritance diagram for GC_MakeParabola2d:

Public Member Functions
	GC_MakeParabola2d (const gp_Parab2d &theParabola)
	Creates a parabola from a non-persistent one from package gp.
	GC_MakeParabola2d (const gp_Ax22d &theAxis, const double theFocal)
	Creates a parabola from a local coordinate system and focal length.
	GC_MakeParabola2d (const gp_Ax2d &theMirrorAxis, const double theFocal, const bool theSense)
	Creates a parabola from symmetry axis and focal length.
	GC_MakeParabola2d (const gp_Ax2d &theDirectrix, const gp_Pnt2d &theFocus, const bool theSense=true)
	Creates a parabola from directrix and focus point.
	GC_MakeParabola2d (const gp_Pnt2d &theFocus, const gp_Pnt2d &theVertex)
	Creates a parabola from focus and vertex points.
const occ::handle< Geom2d_Parabola > &	Value () const
	Returns the constructed parabola. Exceptions StdFail_NotDone if no parabola is constructed.
	operator const occ::handle< Geom2d_Parabola > & () 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 parabolas in the plane. The result is a Geom2d_Parabola. A GC_MakeParabola2d object provides a framework for:

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

  Note

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

  In the local coordinate system, the parabola equation is Y**2 = (2*P) * X, where P is the parameter and F = P/2 is focal length.

Constructor & Destructor Documentation

GC_MakeParabola2d() [1/5]

GC_MakeParabola2d::GC_MakeParabola2d

(

const gp_Parab2d &

theParabola

)

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

Parameters

[in]

theParabola

source parabola

GC_MakeParabola2d() [2/5]

GC_MakeParabola2d::GC_MakeParabola2d	(	const gp_Ax22d &	theAxis,
		const double	theFocal )

Creates a parabola from a local coordinate system and focal length.

Parameters

[in]	theAxis	local coordinate system
[in]	theFocal	focal length

Note

Construction fails with gce_NullFocusLength if theFocal is negative.

GC_MakeParabola2d() [3/5]

GC_MakeParabola2d::GC_MakeParabola2d	(	const gp_Ax2d &	theMirrorAxis,
		const double	theFocal,
		const bool	theSense )

Creates a parabola from symmetry axis and focal length.

Parameters

[in]	theMirrorAxis	symmetry axis placement
[in]	theFocal	focal length
[in]	theSense	orientation flag

Note

Construction fails with gce_NullFocusLength if theFocal is negative.

GC_MakeParabola2d() [4/5]

GC_MakeParabola2d::GC_MakeParabola2d	(	const gp_Ax2d &	theDirectrix,
		const gp_Pnt2d &	theFocus,
		const bool	theSense = true )

Creates a parabola from directrix and focus point.

Parameters

[in]	theDirectrix	directrix axis
[in]	theFocus	focus point
[in]	theSense	orientation flag

GC_MakeParabola2d() [5/5]

GC_MakeParabola2d::GC_MakeParabola2d	(	const gp_Pnt2d &	theFocus,
		const gp_Pnt2d &	theVertex )

Creates a parabola from focus and vertex points.

Parameters

[in]	theFocus	focus point
[in]	theVertex	vertex point

Note

Error status is provided by the underlying gce_MakeParab2d (for example gce_NullAxis).

Member Function Documentation

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

GC_MakeParabola2d::operator const occ::handle< Geom2d_Parabola > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting parabola

Value()

const occ::handle< Geom2d_Parabola > & GC_MakeParabola2d::Value

(

)

const

Returns the constructed parabola. Exceptions StdFail_NotDone if no parabola is constructed.

Returns

resulting parabola

---

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

• GC_MakeParabola2d.hxx