Open CASCADE Technology 7.7.2
Public Member Functions
Geom_Parabola Class Reference

Describes a parabola in 3D space. A parabola is defined by its focal length (i.e. the distance between its focus and its apex) and is positioned in space with a coordinate system (gp_Ax2 object) where: More...

#include <Geom_Parabola.hxx>

Inheritance diagram for Geom_Parabola:
Inheritance graph
[legend]

Public Member Functions

 Geom_Parabola (const gp_Parab &Prb)
 Creates a parabola from a non transient one.
 
 Geom_Parabola (const gp_Ax2 &A2, const Standard_Real Focal)
 Creates a parabola with its local coordinate system "A2" and it's focal length "Focal". The XDirection of A2 defines the axis of symmetry of the parabola. The YDirection of A2 is parallel to the directrix of the parabola. The Location point of A2 is the vertex of the parabola Raised if Focal < 0.0.
 
 Geom_Parabola (const gp_Ax1 &D, const gp_Pnt &F)
 D is the directrix of the parabola and F the focus point. The symmetry axis (XAxis) of the parabola is normal to the directrix and pass through the focus point F, but its location point is the vertex of the parabola. The YAxis of the parabola is parallel to D and its location point is the vertex of the parabola. The normal to the plane of the parabola is the cross product between the XAxis and the YAxis.
 
void SetFocal (const Standard_Real Focal)
 Assigns the value Focal to the focal distance of this parabola. Exceptions Standard_ConstructionError if Focal is negative.
 
void SetParab (const gp_Parab &Prb)
 Converts the gp_Parab parabola Prb into this parabola.
 
gp_Parab Parab () const
 Returns the non transient parabola from gp with the same geometric properties as <me>.
 
Standard_Real ReversedParameter (const Standard_Real U) const override
 Computes the parameter on the reversed parabola, for the point of parameter U on this parabola. For a parabola, the returned value is: -U.
 
Standard_Real FirstParameter () const override
 Returns the value of the first or last parameter of this parabola. This is, respectively:
 
Standard_Real LastParameter () const override
 Returns the value of the first or last parameter of this parabola. This is, respectively:
 
Standard_Boolean IsClosed () const override
 Returns False.
 
Standard_Boolean IsPeriodic () const override
 Returns False.
 
gp_Ax1 Directrix () const
 Computes the directrix of this parabola. This is a line normal to the axis of symmetry, in the plane of this parabola, located on the negative side of its axis of symmetry, at a distance from the apex equal to the focal length. The directrix is returned as an axis (gp_Ax1 object), where the origin is located on the "X Axis" of this parabola.
 
Standard_Real Eccentricity () const override
 Returns 1. (which is the eccentricity of any parabola).
 
gp_Pnt Focus () const
 Computes the focus of this parabola. The focus is on the positive side of the "X Axis" of the local coordinate system of the parabola.
 
Standard_Real Focal () const
 Computes the focal distance of this parabola The focal distance is the distance between the apex and the focus of the parabola.
 
Standard_Real Parameter () const
 Computes the parameter of this parabola which is the distance between its focus and its directrix. This distance is twice the focal length. If P is the parameter of the parabola, the equation of the parabola in its local coordinate system is: Y**2 = 2.*P*X.
 
void D0 (const Standard_Real U, gp_Pnt &P) const override
 Returns in P the point of parameter U. If U = 0 the returned point is the origin of the XAxis and the YAxis of the parabola and it is the vertex of the parabola. P = S + F * (U * U * XDir + * U * YDir) where S is the vertex of the parabola, XDir the XDirection and YDir the YDirection of the parabola's local coordinate system.
 
void D1 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1) const override
 Returns the point P of parameter U and the first derivative V1.
 
void D2 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2) const override
 Returns the point P of parameter U, the first and second derivatives V1 and V2.
 
void D3 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const override
 Returns the point P of parameter U, the first second and third derivatives V1 V2 and V3.
 
gp_Vec DN (const Standard_Real U, const Standard_Integer N) const override
 For the point of parameter U of this parabola, computes the vector corresponding to the Nth derivative. Exceptions Standard_RangeError if N is less than 1.
 
void Transform (const gp_Trsf &T) override
 Applies the transformation T to this parabola.
 
Standard_Real TransformedParameter (const Standard_Real U, const gp_Trsf &T) const override
 Returns the parameter on the transformed curve for the transform of the point of parameter U on <me>.
 
Standard_Real ParametricTransformation (const gp_Trsf &T) const override
 Returns a coefficient to compute the parameter on the transformed curve for the transform of the point on <me>.
 
Handle< Geom_GeometryCopy () const override
 Creates a new object which is a copy of this parabola.
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Geom_Conic
void SetAxis (const gp_Ax1 &theA1)
 Changes the orientation of the conic's plane. The normal axis to the plane is A1. The XAxis and the YAxis are recomputed.
 
void SetLocation (const gp_Pnt &theP)
 changes the location point of the conic.
 
void SetPosition (const gp_Ax2 &theA2)
 changes the local coordinate system of the conic.
 
const gp_Ax1Axis () const
 Returns the "main Axis" of this conic. This axis is normal to the plane of the conic.
 
const gp_PntLocation () const
 Returns the location point of the conic. For the circle, the ellipse and the hyperbola it is the center of the conic. For the parabola it is the Apex of the parabola.
 
const gp_Ax2Position () const
 Returns the local coordinates system of the conic. The main direction of the Axis2Placement is normal to the plane of the conic. The X direction of the Axis2placement is in the plane of the conic and corresponds to the origin for the conic's parametric value u.
 
virtual Standard_Real Eccentricity () const =0
 Returns the eccentricity value of the conic e. e = 0 for a circle 0 < e < 1 for an ellipse (e = 0 if MajorRadius = MinorRadius) e > 1 for a hyperbola e = 1 for a parabola Exceptions Standard_DomainError in the case of a hyperbola if its major radius is null.
 
gp_Ax1 XAxis () const
 Returns the XAxis of the conic. This axis defines the origin of parametrization of the conic. This axis is perpendicular to the Axis of the conic. This axis and the Yaxis define the plane of the conic.
 
gp_Ax1 YAxis () const
 Returns the YAxis of the conic. The YAxis is perpendicular to the Xaxis. This axis and the Xaxis define the plane of the conic.
 
void Reverse () override
 Reverses the direction of parameterization of <me>. The local coordinate system of the conic is modified.
 
virtual Standard_Real ReversedParameter (const Standard_Real U) const override=0
 Returns the parameter on the reversed curve for the point of parameter U on <me>.
 
GeomAbs_Shape Continuity () const override
 The continuity of the conic is Cn.
 
Standard_Boolean IsCN (const Standard_Integer N) const override
 Returns True. Raised if N < 0.
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Geom_Curve
virtual void Reverse ()=0
 Changes the direction of parametrization of <me>. The "FirstParameter" and the "LastParameter" are not changed but the orientation of the curve is modified. If the curve is bounded the StartPoint of the initial curve becomes the EndPoint of the reversed curve and the EndPoint of the initial curve becomes the StartPoint of the reversed curve.
 
virtual Standard_Real ReversedParameter (const Standard_Real U) const =0
 Returns the parameter on the reversed curve for the point of parameter U on <me>.
 
virtual Standard_Real TransformedParameter (const Standard_Real U, const gp_Trsf &T) const
 Returns the parameter on the transformed curve for the transform of the point of parameter U on <me>.
 
virtual Standard_Real ParametricTransformation (const gp_Trsf &T) const
 Returns a coefficient to compute the parameter on the transformed curve for the transform of the point on <me>.
 
Handle< Geom_CurveReversed () const
 Returns a copy of <me> reversed.
 
virtual Standard_Real FirstParameter () const =0
 Returns the value of the first parameter. Warnings : It can be RealFirst from package Standard if the curve is infinite.
 
virtual Standard_Real LastParameter () const =0
 Returns the value of the last parameter. Warnings : It can be RealLast from package Standard if the curve is infinite.
 
virtual Standard_Boolean IsClosed () const =0
 Returns true if the curve is closed. Some curves such as circle are always closed, others such as line are never closed (by definition). Some Curves such as OffsetCurve can be closed or not. These curves are considered as closed if the distance between the first point and the last point of the curve is lower or equal to the Resolution from package gp which is a fixed criterion independent of the application.
 
virtual Standard_Boolean IsPeriodic () const =0
 Is the parametrization of the curve periodic ? It is possible only if the curve is closed and if the following relation is satisfied : for each parametric value U the distance between the point P(u) and the point P (u + T) is lower or equal to Resolution from package gp, T is the period and must be a constant. There are three possibilities : . the curve is never periodic by definition (SegmentLine) . the curve is always periodic by definition (Circle) . the curve can be defined as periodic (BSpline). In this case a function SetPeriodic allows you to give the shape of the curve. The general rule for this case is : if a curve can be periodic or not the default periodicity set is non periodic and you have to turn (explicitly) the curve into a periodic curve if you want the curve to be periodic.
 
virtual Standard_Real Period () const
 Returns the period of this curve. Exceptions Standard_NoSuchObject if this curve is not periodic.
 
virtual GeomAbs_Shape Continuity () const =0
 It is the global continuity of the curve C0 : only geometric continuity, C1 : continuity of the first derivative all along the Curve, C2 : continuity of the second derivative all along the Curve, C3 : continuity of the third derivative all along the Curve, G1 : tangency continuity all along the Curve, G2 : curvature continuity all along the Curve, CN : the order of continuity is infinite.
 
virtual Standard_Boolean IsCN (const Standard_Integer N) const =0
 Returns true if the degree of continuity of this curve is at least N. Exceptions - Standard_RangeError if N is less than 0.
 
virtual void D0 (const Standard_Real U, gp_Pnt &P) const =0
 Returns in P the point of parameter U. If the curve is periodic then the returned point is P(U) with U = Ustart + (U - Uend) where Ustart and Uend are the parametric bounds of the curve.
 
virtual void D1 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1) const =0
 Returns the point P of parameter U and the first derivative V1. Raised if the continuity of the curve is not C1.
 
virtual void D2 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2) const =0
 Returns the point P of parameter U, the first and second derivatives V1 and V2. Raised if the continuity of the curve is not C2.
 
virtual void D3 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const =0
 Returns the point P of parameter U, the first, the second and the third derivative. Raised if the continuity of the curve is not C3.
 
virtual gp_Vec DN (const Standard_Real U, const Standard_Integer N) const =0
 The returned vector gives the value of the derivative for the order of derivation N. Raised if the continuity of the curve is not CN.
 
gp_Pnt Value (const Standard_Real U) const
 Computes the point of parameter U on <me>. If the curve is periodic then the returned point is P(U) with U = Ustart + (U - Uend) where Ustart and Uend are the parametric bounds of the curve. it is implemented with D0.
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Geom_Geometry
void Mirror (const gp_Pnt &P)
 Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry.
 
void Mirror (const gp_Ax1 &A1)
 Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry.
 
void Mirror (const gp_Ax2 &A2)
 Performs the symmetrical transformation of a Geometry with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection).
 
void Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
 Rotates a Geometry. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.
 
void Scale (const gp_Pnt &P, const Standard_Real S)
 Scales a Geometry. S is the scaling value.
 
void Translate (const gp_Vec &V)
 Translates a Geometry. V is the vector of the translation.
 
void Translate (const gp_Pnt &P1, const gp_Pnt &P2)
 Translates a Geometry from the point P1 to the point P2.
 
virtual void Transform (const gp_Trsf &T)=0
 Transformation of a geometric object. This tansformation can be a translation, a rotation, a symmetry, a scaling or a complex transformation obtained by combination of the previous elementaries transformations. (see class Transformation of the package Geom).
 
Handle< Geom_GeometryMirrored (const gp_Pnt &P) const
 
Handle< Geom_GeometryMirrored (const gp_Ax1 &A1) const
 
Handle< Geom_GeometryMirrored (const gp_Ax2 &A2) const
 
Handle< Geom_GeometryRotated (const gp_Ax1 &A1, const Standard_Real Ang) const
 
Handle< Geom_GeometryScaled (const gp_Pnt &P, const Standard_Real S) const
 
Handle< Geom_GeometryTransformed (const gp_Trsf &T) const
 
Handle< Geom_GeometryTranslated (const gp_Vec &V) const
 
Handle< Geom_GeometryTranslated (const gp_Pnt &P1, const gp_Pnt &P2) const
 
virtual Handle< Geom_GeometryCopy () const =0
 Creates a new object which is a copy of this geometric object.
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object.
 
void IncrementRefCounter () const
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 
- Protected Attributes inherited from Geom_Conic
gp_Ax2 pos
 

Detailed Description

Describes a parabola in 3D space. A parabola is defined by its focal length (i.e. the distance between its focus and its apex) and is positioned in space with a coordinate system (gp_Ax2 object) where:

Constructor & Destructor Documentation

◆ Geom_Parabola() [1/3]

Geom_Parabola::Geom_Parabola ( const gp_Parab Prb)

Creates a parabola from a non transient one.

◆ Geom_Parabola() [2/3]

Geom_Parabola::Geom_Parabola ( const gp_Ax2 A2,
const Standard_Real  Focal 
)

Creates a parabola with its local coordinate system "A2" and it's focal length "Focal". The XDirection of A2 defines the axis of symmetry of the parabola. The YDirection of A2 is parallel to the directrix of the parabola. The Location point of A2 is the vertex of the parabola Raised if Focal < 0.0.

◆ Geom_Parabola() [3/3]

Geom_Parabola::Geom_Parabola ( const gp_Ax1 D,
const gp_Pnt F 
)

D is the directrix of the parabola and F the focus point. The symmetry axis (XAxis) of the parabola is normal to the directrix and pass through the focus point F, but its location point is the vertex of the parabola. The YAxis of the parabola is parallel to D and its location point is the vertex of the parabola. The normal to the plane of the parabola is the cross product between the XAxis and the YAxis.

Member Function Documentation

◆ Copy()

Handle< Geom_Geometry > Geom_Parabola::Copy ( ) const
overridevirtual

Creates a new object which is a copy of this parabola.

Implements Geom_Geometry.

◆ D0()

void Geom_Parabola::D0 ( const Standard_Real  U,
gp_Pnt P 
) const
overridevirtual

Returns in P the point of parameter U. If U = 0 the returned point is the origin of the XAxis and the YAxis of the parabola and it is the vertex of the parabola. P = S + F * (U * U * XDir + * U * YDir) where S is the vertex of the parabola, XDir the XDirection and YDir the YDirection of the parabola's local coordinate system.

Implements Geom_Curve.

◆ D1()

void Geom_Parabola::D1 ( const Standard_Real  U,
gp_Pnt P,
gp_Vec V1 
) const
overridevirtual

Returns the point P of parameter U and the first derivative V1.

Implements Geom_Curve.

◆ D2()

void Geom_Parabola::D2 ( const Standard_Real  U,
gp_Pnt P,
gp_Vec V1,
gp_Vec V2 
) const
overridevirtual

Returns the point P of parameter U, the first and second derivatives V1 and V2.

Implements Geom_Curve.

◆ D3()

void Geom_Parabola::D3 ( const Standard_Real  U,
gp_Pnt P,
gp_Vec V1,
gp_Vec V2,
gp_Vec V3 
) const
overridevirtual

Returns the point P of parameter U, the first second and third derivatives V1 V2 and V3.

Implements Geom_Curve.

◆ Directrix()

gp_Ax1 Geom_Parabola::Directrix ( ) const

Computes the directrix of this parabola. This is a line normal to the axis of symmetry, in the plane of this parabola, located on the negative side of its axis of symmetry, at a distance from the apex equal to the focal length. The directrix is returned as an axis (gp_Ax1 object), where the origin is located on the "X Axis" of this parabola.

◆ DN()

gp_Vec Geom_Parabola::DN ( const Standard_Real  U,
const Standard_Integer  N 
) const
overridevirtual

For the point of parameter U of this parabola, computes the vector corresponding to the Nth derivative. Exceptions Standard_RangeError if N is less than 1.

Implements Geom_Curve.

◆ DumpJson()

virtual void Geom_Parabola::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from Geom_Conic.

◆ Eccentricity()

Standard_Real Geom_Parabola::Eccentricity ( ) const
overridevirtual

Returns 1. (which is the eccentricity of any parabola).

Implements Geom_Conic.

◆ FirstParameter()

Standard_Real Geom_Parabola::FirstParameter ( ) const
overridevirtual

Returns the value of the first or last parameter of this parabola. This is, respectively:

  • Standard_Real::RealFirst(), or
  • Standard_Real::RealLast().

Implements Geom_Curve.

◆ Focal()

Standard_Real Geom_Parabola::Focal ( ) const

Computes the focal distance of this parabola The focal distance is the distance between the apex and the focus of the parabola.

◆ Focus()

gp_Pnt Geom_Parabola::Focus ( ) const

Computes the focus of this parabola. The focus is on the positive side of the "X Axis" of the local coordinate system of the parabola.

◆ IsClosed()

Standard_Boolean Geom_Parabola::IsClosed ( ) const
overridevirtual

Returns False.

Implements Geom_Curve.

◆ IsPeriodic()

Standard_Boolean Geom_Parabola::IsPeriodic ( ) const
overridevirtual

Returns False.

Implements Geom_Curve.

◆ LastParameter()

Standard_Real Geom_Parabola::LastParameter ( ) const
overridevirtual

Returns the value of the first or last parameter of this parabola. This is, respectively:

  • Standard_Real::RealFirst(), or
  • Standard_Real::RealLast().

Implements Geom_Curve.

◆ Parab()

gp_Parab Geom_Parabola::Parab ( ) const

Returns the non transient parabola from gp with the same geometric properties as <me>.

◆ Parameter()

Standard_Real Geom_Parabola::Parameter ( ) const

Computes the parameter of this parabola which is the distance between its focus and its directrix. This distance is twice the focal length. If P is the parameter of the parabola, the equation of the parabola in its local coordinate system is: Y**2 = 2.*P*X.

◆ ParametricTransformation()

Standard_Real Geom_Parabola::ParametricTransformation ( const gp_Trsf T) const
overridevirtual

Returns a coefficient to compute the parameter on the transformed curve for the transform of the point on <me>.

Transformed(T)->Value(U * ParametricTransformation(T))

is the same point as

Value(U).Transformed(T)

This methods returns T.ScaleFactor()

Reimplemented from Geom_Curve.

◆ ReversedParameter()

Standard_Real Geom_Parabola::ReversedParameter ( const Standard_Real  U) const
overridevirtual

Computes the parameter on the reversed parabola, for the point of parameter U on this parabola. For a parabola, the returned value is: -U.

Implements Geom_Conic.

◆ SetFocal()

void Geom_Parabola::SetFocal ( const Standard_Real  Focal)

Assigns the value Focal to the focal distance of this parabola. Exceptions Standard_ConstructionError if Focal is negative.

◆ SetParab()

void Geom_Parabola::SetParab ( const gp_Parab Prb)

Converts the gp_Parab parabola Prb into this parabola.

◆ Transform()

void Geom_Parabola::Transform ( const gp_Trsf T)
overridevirtual

Applies the transformation T to this parabola.

Implements Geom_Geometry.

◆ TransformedParameter()

Standard_Real Geom_Parabola::TransformedParameter ( const Standard_Real  U,
const gp_Trsf T 
) const
overridevirtual

Returns the parameter on the transformed curve for the transform of the point of parameter U on <me>.

me->Transformed(T)->Value(me->TransformedParameter(U,T))

is the same point as

me->Value(U).Transformed(T)

This methods returns * T.ScaleFactor()

Reimplemented from Geom_Curve.


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