Implements construction algorithms for gp_Parab. The parabola is infinite in the parameter range ]-infinite, +infinite[. The vertex is the Location point of the local coordinate system. More...

#include <gce_MakeParab.hxx>

Inheritance diagram for gce_MakeParab:

[legend]

Public Member Functions
	gce_MakeParab (const gp_Ax2 &A2, const double Focal)
	Creates a parabola from local coordinate system and focal length.

	gce_MakeParab (const gp_Ax1 &D, const gp_Pnt &F)
	Creates a parabola from directrix and focus.

const gp_Parab &	Value () const
	Returns the constructed parabola.

gp_Parab	Operator () const
	Alias for Value() returning a copy.

	operator gp_Parab () 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_Parab. The parabola is infinite in the parameter range ]-infinite, +infinite[. The vertex is the Location point of the local coordinate system.

The XDirection and YDirection define the parabola plane.

The XAxis (Location, XDirection) is the symmetry axis and is oriented from the vertex to the focus.

The YAxis (Location, YDirection) is parallel to the directrix.

The equation in the local coordinate system is: Y**2 = (2*P) * X, where P is the parameter (distance between focus and directrix). The focal length F = P / 2 is the distance from vertex to focus.

Supported constructions:

from local coordinate system and focal length;
from directrix and focus.

Constructor & Destructor Documentation

◆ gce_MakeParab() [1/2]

gce_MakeParab::gce_MakeParab	(	const gp_Ax2 &	A2,
		const double	Focal )

Creates a parabola from local coordinate system and focal length.

Parameters

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

Note: TheError is set to gce_NullFocusLength if Focal < 0.0.

◆ gce_MakeParab() [2/2]

gce_MakeParab::gce_MakeParab	(	const gp_Ax1 &	D,
		const gp_Pnt &	F )

Creates a parabola from directrix and focus.

Parameters

[in]	D	directrix of the parabola
[in]	F	focus point of the parabola

Member Function Documentation

◆ Operator()

gp_Parab gce_MakeParab::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns: resulting parabola

◆ operator gp_Parab()

gce_MakeParab::operator gp_Parab ( ) const

inline

Conversion operator returning the constructed parabola.

Returns: resulting parabola

◆ Value()

const gp_Parab & gce_MakeParab::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_MakeParab.hxx

Public Member Functions

Additional Inherited Members