gce_MakeParab2d Class Reference

Implements construction algorithms for gp_Parab2d. The parabola is infinite and represented in a local 2D coordinate system. The XAxis is the symmetry axis directed from vertex to focus, and the YAxis is parallel to the directrix. The equation in local coordinates is: Y**2 = (2*P) * X, where P is the distance between focus and directrix. The focal length F = P / 2 is the distance from vertex to focus. More...

#include <gce_MakeParab2d.hxx>

Inheritance diagram for gce_MakeParab2d:

Public Member Functions
	gce_MakeParab2d (const gp_Ax2d &MirrorAxis, const double Focal, const bool Sense=true)
	Creates a parabola from symmetry axis and focal length.
	gce_MakeParab2d (const gp_Ax22d &A, const double Focal)
	Creates a parabola from full local coordinate system and focal length.
	gce_MakeParab2d (const gp_Ax2d &D, const gp_Pnt2d &F, const bool Sense=true)
	Creates a parabola from directrix and focus.
	gce_MakeParab2d (const gp_Pnt2d &S1, const gp_Pnt2d &Center, const bool Sense=true)
	Creates a parabola from focus and vertex.
const gp_Parab2d &	Value () const
	Returns the constructed parabola.
gp_Parab2d	Operator () const
	Alias for Value() returning a copy.
	operator gp_Parab2d () const
	Conversion operator returning the constructed parabola.
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

Implements construction algorithms for gp_Parab2d. The parabola is infinite and represented in a local 2D coordinate system. The XAxis is the symmetry axis directed from vertex to focus, and the YAxis is parallel to the directrix. The equation in local coordinates is: Y**2 = (2*P) * X, where P is the distance between focus and directrix. The focal length F = P / 2 is the distance from vertex to focus.

Supported constructions:

• from symmetry axis and focal length;
• from full axis system and focal length;
• from directrix and focus;
• from focus and vertex.

Constructor & Destructor Documentation

gce_MakeParab2d() [1/4]

gce_MakeParab2d::gce_MakeParab2d	(	const gp_Ax2d &	MirrorAxis,
		const double	Focal,
		const bool	Sense = true )

Creates a parabola from symmetry axis and focal length.

Parameters

[in]	MirrorAxis	symmetry axis of the parabola
[in]	Focal	focal length
[in]	Sense	orientation of parametrization

Note

Focal = 0 is accepted.

TheError is set to gce_NullFocusLength if Focal < 0.0.

gce_MakeParab2d() [2/4]

gce_MakeParab2d::gce_MakeParab2d	(	const gp_Ax22d &	A,
		const double	Focal )

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

Parameters

[in]	A	local coordinate system of the parabola
[in]	Focal	focal length

Note

Focal = 0 is accepted.

TheError is set to gce_NullFocusLength if Focal < 0.0.

gce_MakeParab2d() [3/4]

gce_MakeParab2d::gce_MakeParab2d	(	const gp_Ax2d &	D,
		const gp_Pnt2d &	F,
		const bool	Sense = true )

Creates a parabola from directrix and focus.

Parameters

[in]	D	directrix of the parabola
[in]	F	focus point of the parabola
[in]	Sense	orientation of parametrization

gce_MakeParab2d() [4/4]

gce_MakeParab2d::gce_MakeParab2d	(	const gp_Pnt2d &	S1,
		const gp_Pnt2d &	Center,
		const bool	Sense = true )

Creates a parabola from focus and vertex.

Parameters

[in]	S1	focus point
[in]	Center	vertex point
[in]	Sense	orientation of parametrization

Note

The class does not prevent zero focal distance.

TheError is set to gce_NullAxis if S1 and Center are coincident.

Member Function Documentation

Operator()

gp_Parab2d gce_MakeParab2d::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting parabola

operator gp_Parab2d()

gce_MakeParab2d::operator gp_Parab2d ( ) const

inline

Conversion operator returning the constructed parabola.

Returns

resulting parabola

Value()

const gp_Parab2d & gce_MakeParab2d::Value

(

)

const

Returns the constructed parabola.

Returns

resulting parabola

Exceptions

StdFail_NotDone

if construction has failed

---

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

• gce_MakeParab2d.hxx