HelixGeom_BuilderHelixGen Class Reference

Base class for helix curve building algorithms with parameter management. More...

#include <HelixGeom_BuilderHelixGen.hxx>

Inheritance diagram for HelixGeom_BuilderHelixGen:

Public Member Functions
void	SetCurveParameters (const double aT1, const double aT2, const double aPitch, const double aRStart, const double aTaperAngle, const bool bIsClockwise)
	Sets parameters for building helix curves.
void	CurveParameters (double &aT1, double &aT2, double &aPitch, double &aRStart, double &aTaperAngle, bool &bIsClockwise) const
	Gets parameters for building helix curves.
Public Member Functions inherited from HelixGeom_BuilderApproxCurve
void	SetApproxParameters (const GeomAbs_Shape aCont, const int aMaxDegree, const int aMaxSeg)
	Sets approximation parameters.
void	ApproxParameters (GeomAbs_Shape &aCont, int &aMaxDegree, int &aMaxSeg) const
	Gets approximation parameters.
void	SetTolerance (const double aTolerance)
	Sets approximation tolerance.
double	Tolerance () const
	Gets approximation tolerance.
double	ToleranceReached () const
	Gets actual tolerance reached by approximation algorithm.
const NCollection_Sequence< occ::handle< Geom_Curve > > &	Curves () const
	Gets sequence of BSpline curves representing helix coils.
int	ErrorStatus () const
	Returns error status of algorithm.
int	WarningStatus () const
	Returns warning status of algorithm.
virtual void	Perform ()=0
	Performs calculations. Must be redefined.

Protected Member Functions
	HelixGeom_BuilderHelixGen ()
	Sets default parameters.
	~HelixGeom_BuilderHelixGen () override
Protected Member Functions inherited from HelixGeom_BuilderApproxCurve
	HelixGeom_BuilderApproxCurve ()
	Sets default values of approximation parameters.
virtual	~HelixGeom_BuilderApproxCurve ()

Protected Attributes
double	myT1
double	myT2
double	myPitch
double	myRStart
double	myTaperAngle
bool	myIsClockWise
Protected Attributes inherited from HelixGeom_BuilderApproxCurve
int	myErrorStatus
int	myWarningStatus
double	myTolerance
GeomAbs_Shape	myCont
int	myMaxDegree
int	myMaxSeg
double	myTolReached
NCollection_Sequence< occ::handle< Geom_Curve > >	myCurves

Detailed Description

Base class for helix curve building algorithms with parameter management.

This class extends HelixGeom_BuilderApproxCurve by adding helix-specific geometric parameters:

• Parameter range (T1, T2) - angular range in radians
• Pitch - vertical distance per full turn (2*PI radians)
• Start radius (RStart) - radius at parameter T1
• Taper angle - angle for radius variation (0 = cylindrical)
• Orientation - clockwise or counter-clockwise

Concrete implementations include:

• HelixGeom_BuilderHelix: Single helix approximation
• HelixGeom_BuilderHelixCoil: Multi-coil helix approximation

See also

HelixGeom_BuilderApproxCurve, HelixGeom_HelixCurve

Constructor & Destructor Documentation

HelixGeom_BuilderHelixGen()

HelixGeom_BuilderHelixGen::HelixGeom_BuilderHelixGen ( )

protected

Sets default parameters.

~HelixGeom_BuilderHelixGen()

HelixGeom_BuilderHelixGen::~HelixGeom_BuilderHelixGen ( )

overrideprotected

Member Function Documentation

CurveParameters()

void HelixGeom_BuilderHelixGen::CurveParameters	(	double &	aT1,
		double &	aT2,
		double &	aPitch,
		double &	aRStart,
		double &	aTaperAngle,
		bool &	bIsClockwise ) const

Gets parameters for building helix curves.

SetCurveParameters()

void HelixGeom_BuilderHelixGen::SetCurveParameters	(	const double	aT1,
		const double	aT2,
		const double	aPitch,
		const double	aRStart,
		const double	aTaperAngle,
		const bool	bIsClockwise )

Sets parameters for building helix curves.

Field Documentation

myIsClockWise

bool HelixGeom_BuilderHelixGen::myIsClockWise

protected

myPitch

double HelixGeom_BuilderHelixGen::myPitch

protected

myRStart

double HelixGeom_BuilderHelixGen::myRStart

protected

myT1

double HelixGeom_BuilderHelixGen::myT1

protected

myT2

double HelixGeom_BuilderHelixGen::myT2

protected

myTaperAngle

double HelixGeom_BuilderHelixGen::myTaperAngle

protected

---

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

• HelixGeom_BuilderHelixGen.hxx