Describes a circular helix in 3D space. A circular helix is an unbounded curve defined by a radius R, a pitch P (axial advance per full 2*Pi turn), and a coordinate system. More...

#include <GeomEval_CircularHelixCurve.hxx>

Inheritance diagram for GeomEval_CircularHelixCurve:

[legend]

Public Member Functions
	GeomEval_CircularHelixCurve (const gp_Ax2 &thePosition, double theRadius, double thePitch)
	Creates a circular helix with the given coordinate system, radius, and pitch.

const gp_Ax2 &	Position () const
	Returns the local coordinate system.

double	Radius () const
	Returns the helix radius.

double	Pitch () const
	Returns the pitch (axial advance per 2*Pi turn).

void	Reverse () final
	Reversal of parametrization is not supported for this eval geometry.

double	ReversedParameter (const double U) const final
	Reversal of parametrization is not supported for this eval geometry.

double	FirstParameter () const final
	Returns -Precision::Infinite().

double	LastParameter () const final
	Returns Precision::Infinite().

bool	IsClosed () const final
	Returns false.

bool	IsPeriodic () const final
	Returns false.

GeomAbs_Shape	Continuity () const final
	Returns GeomAbs_CN.

bool	IsCN (const int N) const final
	Returns true for any N >= 0.

gp_Pnt	EvalD0 (const double U) const final
	Computes the point at parameter U.

Geom_Curve::ResD1	EvalD1 (const double U) const final
	Computes the point and first derivative at parameter U.

Geom_Curve::ResD2	EvalD2 (const double U) const final
	Computes the point and first two derivatives at parameter U.

Geom_Curve::ResD3	EvalD3 (const double U) const final
	Computes the point and first three derivatives at parameter U.

gp_Vec	EvalDN (const double U, const int N) const final
	Computes the N-th derivative at parameter U.

void	Transform (const gp_Trsf &T) final
	Transformation is not supported for this eval geometry.

occ::handle< Geom_Geometry >	Copy () const final
	Creates a new object which is a copy of this curve.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const final
	Dumps the content of me into the stream.

Public Member Functions inherited from Geom_Curve
virtual double	TransformedParameter (const double 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 double	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>.

occ::handle< Geom_Curve >	Reversed () const
	Returns a copy of <me> reversed.

virtual double	Period () const
	Returns the period of this curve. Exceptions Standard_NoSuchObject if this curve is not periodic.

void	D0 (const double U, gp_Pnt &P) const
	Returns in P the point of parameter U.

void	D1 (const double U, gp_Pnt &P, gp_Vec &V1) const
	Returns the point P of parameter U and the first derivative V1.

void	D2 (const double U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2) const
	Returns the point P of parameter U, the first and second derivatives V1 and V2.

void	D3 (const double U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const
	Returns the point P of parameter U, the first, the second and the third derivative.

gp_Vec	DN (const double U, const int N) const
	The returned vector gives the value of the derivative for the order of derivation N.

gp_Pnt	Value (const double U) const
	Computes the point of parameter U on <me>.

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 double 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 double 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.

occ::handle< Geom_Geometry >	Mirrored (const gp_Pnt &P) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax1 &A1) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax2 &A2) const

occ::handle< Geom_Geometry >	Rotated (const gp_Ax1 &A1, const double Ang) const

occ::handle< Geom_Geometry >	Scaled (const gp_Pnt &P, const double S) const

occ::handle< Geom_Geometry >	Transformed (const gp_Trsf &T) const

occ::handle< Geom_Geometry >	Translated (const gp_Vec &V) const

occ::handle< Geom_Geometry >	Translated (const gp_Pnt &P1, const gp_Pnt &P2) const

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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_Transient *	This () 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

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 constexpr 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.

Detailed Description

Describes a circular helix in 3D space. A circular helix is an unbounded curve defined by a radius R, a pitch P (axial advance per full 2*Pi turn), and a coordinate system.

The parametric equation is:

C(t) = O + R*cos(t)*XDir + R*sin(t)*YDir + (P*t/(2*Pi))*ZDir

NCollection_ForwardRangeIterator

STL input iterator that wraps an OCCT More()/Next() iterator.

Definition NCollection_ForwardRange.hxx:142

where:

O, XDir, YDir, ZDir are the origin and directions of the local coordinate system,
R is the radius (> 0),
P is the pitch (can be negative for left-handed helix).

The parameter range is (-inf, +inf). The curve is neither periodic nor closed. Continuity is GeomAbs_CN.

Constructor & Destructor Documentation

◆ GeomEval_CircularHelixCurve()

GeomEval_CircularHelixCurve::GeomEval_CircularHelixCurve	(	const gp_Ax2 &	thePosition,
		double	theRadius,
		double	thePitch )

Creates a circular helix with the given coordinate system, radius, and pitch.

Parameters

[in]	thePosition	the local coordinate system
[in]	theRadius	the helix radius (must be > 0)
[in]	thePitch	the axial advance per 2*Pi turn (can be negative)

Exceptions

Standard_ConstructionError if theRadius <= 0

Member Function Documentation

◆ Continuity()

GeomAbs_Shape GeomEval_CircularHelixCurve::Continuity ( ) const

finalvirtual

Returns GeomAbs_CN.

Implements Geom_Curve.

◆ Copy()

occ::handle< Geom_Geometry > GeomEval_CircularHelixCurve::Copy ( ) const

finalvirtual

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

Implements Geom_Geometry.

◆ DumpJson()

void GeomEval_CircularHelixCurve::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

finalvirtual

Dumps the content of me into the stream.

Reimplemented from Geom_Curve.

◆ EvalD0()

gp_Pnt GeomEval_CircularHelixCurve::EvalD0 ( const double U ) const

finalvirtual

Computes the point at parameter U.

Implements Geom_Curve.

◆ EvalD1()

Geom_Curve::ResD1 GeomEval_CircularHelixCurve::EvalD1 ( const double U ) const

finalvirtual

Computes the point and first derivative at parameter U.

Implements Geom_Curve.

◆ EvalD2()

Geom_Curve::ResD2 GeomEval_CircularHelixCurve::EvalD2 ( const double U ) const

finalvirtual

Computes the point and first two derivatives at parameter U.

Implements Geom_Curve.

◆ EvalD3()

Geom_Curve::ResD3 GeomEval_CircularHelixCurve::EvalD3 ( const double U ) const

finalvirtual

Computes the point and first three derivatives at parameter U.

Implements Geom_Curve.

◆ EvalDN()

gp_Vec GeomEval_CircularHelixCurve::EvalDN	(	const double	U,
		const int	N ) const

finalvirtual

Computes the N-th derivative at parameter U.

Parameters

[in]	U	the parameter value
[in]	N	the derivative order (must be >= 1)

Returns: the N-th derivative vector

Exceptions

Standard_RangeError if N < 1

Implements Geom_Curve.

◆ FirstParameter()

double GeomEval_CircularHelixCurve::FirstParameter ( ) const

finalvirtual

Returns -Precision::Infinite().

Implements Geom_Curve.

◆ IsClosed()

bool GeomEval_CircularHelixCurve::IsClosed ( ) const

finalvirtual

Returns false.

Implements Geom_Curve.

◆ IsCN()

bool GeomEval_CircularHelixCurve::IsCN ( const int N ) const

finalvirtual

Returns true for any N >= 0.

Implements Geom_Curve.

◆ IsPeriodic()

bool GeomEval_CircularHelixCurve::IsPeriodic ( ) const

finalvirtual

Returns false.

Implements Geom_Curve.

◆ LastParameter()

double GeomEval_CircularHelixCurve::LastParameter ( ) const

finalvirtual

Returns Precision::Infinite().

Implements Geom_Curve.

◆ Pitch()

double GeomEval_CircularHelixCurve::Pitch ( ) const

Returns the pitch (axial advance per 2*Pi turn).

◆ Position()

const gp_Ax2 & GeomEval_CircularHelixCurve::Position ( ) const

Returns the local coordinate system.

◆ Radius()

double GeomEval_CircularHelixCurve::Radius ( ) const

Returns the helix radius.

◆ Reverse()

void GeomEval_CircularHelixCurve::Reverse ( )

finalvirtual

Reversal of parametrization is not supported for this eval geometry.

Exceptions

Standard_NotImplemented

Implements Geom_Curve.

◆ ReversedParameter()

double GeomEval_CircularHelixCurve::ReversedParameter ( const double U ) const

finalvirtual

Reversal of parametrization is not supported for this eval geometry.

Exceptions

Standard_NotImplemented

Implements Geom_Curve.

◆ Transform()

void GeomEval_CircularHelixCurve::Transform ( const gp_Trsf & T )

finalvirtual

Transformation is not supported for this eval geometry.

Exceptions

Standard_NotImplemented

Implements Geom_Geometry.

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

GeomEval_CircularHelixCurve.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GeomEval_CircularHelixCurve()

Member Function Documentation

◆ Continuity()

◆ Copy()

◆ DumpJson()

◆ EvalD0()

◆ EvalD1()

◆ EvalD2()

◆ EvalD3()

◆ EvalDN()

◆ FirstParameter()

◆ IsClosed()

◆ IsCN()

◆ IsPeriodic()

◆ LastParameter()

◆ Pitch()

◆ Position()

◆ Radius()

◆ Reverse()

◆ ReversedParameter()

◆ Transform()