Describes a 2D Archimedean spiral curve. The polar equation is r = a + b*t, where a is the initial radius and b is the growth rate per radian. More...

#include <Geom2dEval_ArchimedeanSpiralCurve.hxx>

Inheritance diagram for Geom2dEval_ArchimedeanSpiralCurve:

[legend]

Public Member Functions
	Geom2dEval_ArchimedeanSpiralCurve (const gp_Ax2d &thePosition, double theInitialRadius, double theGrowthRate)
	Creates an Archimedean spiral.

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

double	InitialRadius () const
	Returns the initial radius.

double	GrowthRate () const
	Returns the growth rate per radian.

void	Reverse () final
	Reversal is not supported for this eval curve.

double	ReversedParameter (const double U) const final
	Reversal is not supported for this eval curve.

double	FirstParameter () const final
	Returns 0.

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_Pnt2d	EvalD0 (const double U) const final
	Computes the point at parameter U.

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

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

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

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

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

occ::handle< Geom2d_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 Geom2d_Curve
virtual double	TransformedParameter (const double U, const gp_Trsf2d &T) const
	Computes the parameter on the curve transformed by T for the point of parameter U on this curve. Note: this function generally returns U but it can be redefined (for example, on a line).

virtual double	ParametricTransformation (const gp_Trsf2d &T) const
	Returns the coefficient required to compute the parametric transformation of this curve when transformation T is applied. This coefficient is the ratio between the parameter of a point on this curve and the parameter of the transformed point on the new curve transformed by T. Note: this function generally returns 1. but it can be redefined (for example, on a line).

occ::handle< Geom2d_Curve >	Reversed () const
	Creates a reversed duplicate Changes the orientation of this curve. The first and last parameters are not changed, but the parametric direction of the curve is reversed. If the curve is bounded:

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

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

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

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

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

gp_Vec2d	DN (const double U, const int N) const
	Computes the Nth derivative vector.

gp_Pnt2d	Value (const double U) const
	Computes the point of parameter U on <me>. Implemented with D0.

Public Member Functions inherited from Geom2d_Geometry
void	Mirror (const gp_Pnt2d &P)
	Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry and assigns the result to this geometric object.

void	Mirror (const gp_Ax2d &A)
	Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry.

void	Rotate (const gp_Pnt2d &P, const double Ang)
	Rotates a Geometry. P is the center of the rotation. Ang is the angular value of the rotation in radians.

void	Scale (const gp_Pnt2d &P, const double S)
	Scales a Geometry. S is the scaling value.

void	Translate (const gp_Vec2d &V)
	Translates a Geometry. V is the vector of the translation.

void	Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
	Translates a Geometry from the point P1 to the point P2.

occ::handle< Geom2d_Geometry >	Mirrored (const gp_Pnt2d &P) const

occ::handle< Geom2d_Geometry >	Mirrored (const gp_Ax2d &A) const

occ::handle< Geom2d_Geometry >	Rotated (const gp_Pnt2d &P, const double Ang) const

occ::handle< Geom2d_Geometry >	Scaled (const gp_Pnt2d &P, const double S) const

occ::handle< Geom2d_Geometry >	Transformed (const gp_Trsf2d &T) const

occ::handle< Geom2d_Geometry >	Translated (const gp_Vec2d &V) const

occ::handle< Geom2d_Geometry >	Translated (const gp_Pnt2d &P1, const gp_Pnt2d &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 2D Archimedean spiral curve. The polar equation is r = a + b*t, where a is the initial radius and b is the growth rate per radian.

The parametric equation is:

C(t) = O + (a + b*t)*cos(t)*XDir + (a + b*t)*sin(t)*YDir

t

GLdouble GLdouble t

Definition OpenGl_glext.h:330

NCollection_ForwardRangeIterator

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

Definition NCollection_ForwardRange.hxx:142

where:

O, XDir are from the local coordinate system,
YDir is the perpendicular to XDir,
a is the initial radius (>= 0),
b is the growth rate per radian (> 0).

The parameter range is [0, +inf). The curve is neither periodic nor closed.

Constructor & Destructor Documentation

◆ Geom2dEval_ArchimedeanSpiralCurve()

Geom2dEval_ArchimedeanSpiralCurve::Geom2dEval_ArchimedeanSpiralCurve	(	const gp_Ax2d &	thePosition,
		double	theInitialRadius,
		double	theGrowthRate )

Creates an Archimedean spiral.

Parameters

[in]	thePosition	the local coordinate system
[in]	theInitialRadius	the initial radius (must be >= 0)
[in]	theGrowthRate	the growth rate per radian (must be > 0)

Exceptions

Standard_ConstructionError if theInitialRadius < 0 or theGrowthRate <= 0

Member Function Documentation

◆ Continuity()

GeomAbs_Shape Geom2dEval_ArchimedeanSpiralCurve::Continuity ( ) const

finalvirtual

Returns GeomAbs_CN.

Implements Geom2d_Curve.

◆ Copy()

occ::handle< Geom2d_Geometry > Geom2dEval_ArchimedeanSpiralCurve::Copy ( ) const

finalvirtual

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

Implements Geom2d_Geometry.

◆ DumpJson()

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

finalvirtual

Dumps the content of me into the stream.

Reimplemented from Geom2d_Curve.

◆ EvalD0()

gp_Pnt2d Geom2dEval_ArchimedeanSpiralCurve::EvalD0 ( const double U ) const

finalvirtual

Computes the point at parameter U.

Implements Geom2d_Curve.

◆ EvalD1()

Geom2d_Curve::ResD1 Geom2dEval_ArchimedeanSpiralCurve::EvalD1 ( const double U ) const

finalvirtual

Computes the point and first derivative at parameter U.

Implements Geom2d_Curve.

◆ EvalD2()

Geom2d_Curve::ResD2 Geom2dEval_ArchimedeanSpiralCurve::EvalD2 ( const double U ) const

finalvirtual

Computes the point and first two derivatives at parameter U.

Implements Geom2d_Curve.

◆ EvalD3()

Geom2d_Curve::ResD3 Geom2dEval_ArchimedeanSpiralCurve::EvalD3 ( const double U ) const

finalvirtual

Computes the point and first three derivatives at parameter U.

Implements Geom2d_Curve.

◆ EvalDN()

gp_Vec2d Geom2dEval_ArchimedeanSpiralCurve::EvalDN	(	const double	U,
		const int	N ) const

finalvirtual

Computes the N-th derivative at parameter U.

Exceptions

Standard_RangeError if N < 1

Implements Geom2d_Curve.

◆ FirstParameter()

double Geom2dEval_ArchimedeanSpiralCurve::FirstParameter ( ) const

finalvirtual

Returns 0.

Implements Geom2d_Curve.

◆ GrowthRate()

double Geom2dEval_ArchimedeanSpiralCurve::GrowthRate ( ) const

Returns the growth rate per radian.

◆ InitialRadius()

double Geom2dEval_ArchimedeanSpiralCurve::InitialRadius ( ) const

Returns the initial radius.

◆ IsClosed()

bool Geom2dEval_ArchimedeanSpiralCurve::IsClosed ( ) const

finalvirtual

Returns false.

Implements Geom2d_Curve.

◆ IsCN()

bool Geom2dEval_ArchimedeanSpiralCurve::IsCN ( const int N ) const

finalvirtual

Returns true for any N >= 0.

Implements Geom2d_Curve.

◆ IsPeriodic()

bool Geom2dEval_ArchimedeanSpiralCurve::IsPeriodic ( ) const

finalvirtual

Returns false.

Implements Geom2d_Curve.

◆ LastParameter()

double Geom2dEval_ArchimedeanSpiralCurve::LastParameter ( ) const

finalvirtual

Returns Precision::Infinite().

Implements Geom2d_Curve.

◆ Position()

const gp_Ax2d & Geom2dEval_ArchimedeanSpiralCurve::Position ( ) const

Returns the local coordinate system.

◆ Reverse()

void Geom2dEval_ArchimedeanSpiralCurve::Reverse ( )

finalvirtual

Reversal is not supported for this eval curve.

Exceptions

Standard_NotImplemented

Implements Geom2d_Curve.

◆ ReversedParameter()

double Geom2dEval_ArchimedeanSpiralCurve::ReversedParameter ( const double U ) const

finalvirtual

Reversal is not supported for this eval curve.

Exceptions

Standard_NotImplemented

Implements Geom2d_Curve.

◆ Transform()

void Geom2dEval_ArchimedeanSpiralCurve::Transform ( const gp_Trsf2d & T )

finalvirtual

Transformation is not supported for this eval geometry.

Exceptions

Standard_NotImplemented

Implements Geom2d_Geometry.

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

Geom2dEval_ArchimedeanSpiralCurve.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geom2dEval_ArchimedeanSpiralCurve()

Member Function Documentation

◆ Continuity()

◆ Copy()

◆ DumpJson()

◆ EvalD0()

◆ EvalD1()

◆ EvalD2()

◆ EvalD3()

◆ EvalDN()

◆ FirstParameter()

◆ GrowthRate()

◆ InitialRadius()

◆ IsClosed()

◆ IsCN()

◆ IsPeriodic()

◆ LastParameter()

◆ Position()

◆ Reverse()

◆ ReversedParameter()

◆ Transform()