Adaptor class for calculation of helix curves with analytical expressions. More...

#include <HelixGeom_HelixCurve.hxx>

Inheritance diagram for HelixGeom_HelixCurve:

[legend]

Public Member Functions
	HelixGeom_HelixCurve ()
	implementation of analytical expressions

void	Load ()
	Sets default values for parameters.

void	Load (const double aT1, const double aT2, const double aPitch, const double aRStart, const double aTaperAngle, const bool aIsCW)
	Sets helix parameters.

double	FirstParameter () const override
	Gets first parameter.

double	LastParameter () const override
	Gets last parameter.

GeomAbs_Shape	Continuity () const override
	Gets continuity.

int	NbIntervals (const GeomAbs_Shape S) const override
	Gets number of intervals.

void	Intervals (NCollection_Array1< double > &T, const GeomAbs_Shape S) const override
	Gets parametric intervals.

double	Resolution (const double R3d) const override
	Gets parametric resolution.

bool	IsClosed () const override
	Returns False.

bool	IsPeriodic () const override
	Returns False.

double	Period () const override
	Returns 2*PI.

gp_Pnt	EvalD0 (const double theU) const final
	Computes the point of parameter theU on the curve.

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

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

gp_Vec	EvalDN (const double theU, const int theN) const final
	Returns the derivative of order theN at parameter theU.

Public Member Functions inherited from Adaptor3d_Curve
virtual occ::handle< Adaptor3d_Curve >	ShallowCopy () const
	Shallow copy of adaptor.

virtual occ::handle< Adaptor3d_Curve >	Trim (const double First, const double Last, const double Tol) const
	Returns a curve equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. If <First> >= <Last>

gp_Pnt	Value (const double theU) const
	Computes the point of parameter U on the curve.

void	D0 (const double theU, gp_Pnt &theP) const
	Computes the point of parameter U on the curve.

void	D1 (const double theU, gp_Pnt &theP, gp_Vec &theV) const
	Computes the point of parameter U on the curve with its first derivative. Raised if the continuity of the current interval is not C1.

void	D2 (const double theU, gp_Pnt &theP, gp_Vec &theV1, gp_Vec &theV2) const
	Returns the point P of parameter U, the first and second derivatives V1 and V2. Raised if the continuity of the current interval is not C2.

void	D3 (const double theU, gp_Pnt &theP, gp_Vec &theV1, gp_Vec &theV2, gp_Vec &theV3) const
	Returns the point P of parameter U, the first, the second and the third derivative. Raised if the continuity of the current interval is not C3.

gp_Vec	DN (const double theU, const int theN) const
	The returned vector gives the value of the derivative for the order of derivation N. Raised if the continuity of the current interval is not CN. Raised if N < 1.

virtual GeomAbs_CurveType	GetType () const
	Returns the type of the curve in the current interval: Line, Circle, Ellipse, Hyperbola, Parabola, BezierCurve, BSplineCurve, OtherCurve.

virtual gp_Lin	Line () const

virtual gp_Circ	Circle () const

virtual gp_Elips	Ellipse () const

virtual gp_Hypr	Hyperbola () const

virtual gp_Parab	Parabola () const

virtual int	Degree () const

virtual bool	IsRational () const

virtual int	NbPoles () const

virtual int	NbKnots () const

virtual occ::handle< Geom_BezierCurve >	Bezier () const

virtual occ::handle< Geom_BSplineCurve >	BSpline () const

virtual occ::handle< Geom_OffsetCurve >	OffsetCurve () const

virtual Geom_Curve::ResD3	EvalD3 (const double theU) const
	Computes the point and first three derivatives at parameter U. Raises an exception on failure.

	~Adaptor3d_Curve () override

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.

Protected Attributes
double	myFirst

double	myLast

double	myPitch

double	myRStart

double	myTaperAngle

bool	myIsClockWise

double	myC1

double	myTgBeta

double	myTolAngle

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

Adaptor class for calculation of helix curves with analytical expressions.

This class provides parametric representation of helix curves including:

Cylindrical helixes (constant radius)
Tapered helixes (variable radius with taper angle)
Both clockwise and counter-clockwise orientations

The helix is defined by parametric equations in cylindrical coordinates:

x(t) = r(t) * cos(t)
y(t) = r(t) * sin(t) [* direction factor]
z(t) = pitch * t / (2*PI) where r(t) = rStart + taper_factor * t

See also: HelixGeom_BuilderHelix, HelixGeom_BuilderHelixCoil

Constructor & Destructor Documentation

◆ HelixGeom_HelixCurve()

HelixGeom_HelixCurve::HelixGeom_HelixCurve ( )

implementation of analytical expressions

Member Function Documentation

◆ Continuity()

GeomAbs_Shape HelixGeom_HelixCurve::Continuity ( ) const

overridevirtual

Gets continuity.

Reimplemented from Adaptor3d_Curve.

◆ EvalD0()

gp_Pnt HelixGeom_HelixCurve::EvalD0 ( const double theU ) const

finalvirtual

Computes the point of parameter theU on the curve.

Reimplemented from Adaptor3d_Curve.

◆ EvalD1()

Geom_Curve::ResD1 HelixGeom_HelixCurve::EvalD1 ( const double theU ) const

finalvirtual

Computes the point and first derivative at parameter theU.

Reimplemented from Adaptor3d_Curve.

◆ EvalD2()

Geom_Curve::ResD2 HelixGeom_HelixCurve::EvalD2 ( const double theU ) const

finalvirtual

Computes the point and first two derivatives at parameter theU.

Reimplemented from Adaptor3d_Curve.

◆ EvalDN()

gp_Vec HelixGeom_HelixCurve::EvalDN	(	const double	theU,
		const int	theN ) const

finalvirtual

Returns the derivative of order theN at parameter theU.

Reimplemented from Adaptor3d_Curve.

◆ FirstParameter()

double HelixGeom_HelixCurve::FirstParameter ( ) const

overridevirtual

Gets first parameter.

Reimplemented from Adaptor3d_Curve.

◆ Intervals()

void HelixGeom_HelixCurve::Intervals	(	NCollection_Array1< double > &	T,
		const GeomAbs_Shape	S ) const

overridevirtual

Gets parametric intervals.

Reimplemented from Adaptor3d_Curve.

◆ IsClosed()

bool HelixGeom_HelixCurve::IsClosed ( ) const

overridevirtual

Returns False.

Reimplemented from Adaptor3d_Curve.

◆ IsPeriodic()

bool HelixGeom_HelixCurve::IsPeriodic ( ) const

overridevirtual

Returns False.

Reimplemented from Adaptor3d_Curve.

◆ LastParameter()

double HelixGeom_HelixCurve::LastParameter ( ) const

overridevirtual

Gets last parameter.

Reimplemented from Adaptor3d_Curve.

◆ Load() [1/2]

void HelixGeom_HelixCurve::Load ( )

Sets default values for parameters.

◆ Load() [2/2]

void HelixGeom_HelixCurve::Load	(	const double	aT1,
		const double	aT2,
		const double	aPitch,
		const double	aRStart,
		const double	aTaperAngle,
		const bool	aIsCW )

Sets helix parameters.

◆ NbIntervals()

int HelixGeom_HelixCurve::NbIntervals ( const GeomAbs_Shape S ) const

overridevirtual

Gets number of intervals.

Reimplemented from Adaptor3d_Curve.

◆ Period()

double HelixGeom_HelixCurve::Period ( ) const

overridevirtual

Returns 2*PI.

Reimplemented from Adaptor3d_Curve.

◆ Resolution()

double HelixGeom_HelixCurve::Resolution ( const double R3d ) const

overridevirtual

Gets parametric resolution.

Reimplemented from Adaptor3d_Curve.

Field Documentation

◆ myC1

double HelixGeom_HelixCurve::myC1

protected

◆ myFirst

double HelixGeom_HelixCurve::myFirst

protected

◆ myIsClockWise

bool HelixGeom_HelixCurve::myIsClockWise

protected

◆ myLast

double HelixGeom_HelixCurve::myLast

protected

◆ myPitch

double HelixGeom_HelixCurve::myPitch

protected

◆ myRStart

double HelixGeom_HelixCurve::myRStart

protected

◆ myTaperAngle

double HelixGeom_HelixCurve::myTaperAngle

protected

◆ myTgBeta

double HelixGeom_HelixCurve::myTgBeta

protected

◆ myTolAngle

double HelixGeom_HelixCurve::myTolAngle

protected

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

HelixGeom_HelixCurve.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HelixGeom_HelixCurve()

Member Function Documentation

◆ Continuity()

◆ EvalD0()

◆ EvalD1()

◆ EvalD2()

◆ EvalDN()

◆ FirstParameter()

◆ Intervals()

◆ IsClosed()

◆ IsPeriodic()

◆ LastParameter()

◆ Load() [1/2]

◆ Load() [2/2]

◆ NbIntervals()

◆ Period()

◆ Resolution()

Field Documentation

◆ myC1

◆ myFirst

◆ myIsClockWise

◆ myLast

◆ myPitch

◆ myRStart

◆ myTaperAngle

◆ myTgBeta

◆ myTolAngle