Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
HelixGeom_BuilderHelix Class Reference

Upper level class for geometrical algorithm of building helix curves using arbitrary axis. More...

#include <HelixGeom_BuilderHelix.hxx>

Inheritance diagram for HelixGeom_BuilderHelix:
Inheritance graph
[legend]

Public Member Functions

 HelixGeom_BuilderHelix ()
 Empty constructor.
 
 ~HelixGeom_BuilderHelix () override
 
void SetPosition (const gp_Ax2 &aAx2)
 Sets coordinate axes for helix.
 
const gp_Ax2Position () const
 Gets coordinate axes for helix.
 
void Perform () override
 Performs calculations.
 
- Public Member Functions inherited from HelixGeom_BuilderHelixGen
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.
 

Protected Attributes

gp_Ax2 myPosition
 
- Protected Attributes inherited from HelixGeom_BuilderHelixGen
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
 

Additional Inherited Members

- Protected Member Functions inherited from HelixGeom_BuilderHelixGen
 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 ()
 

Detailed Description

Upper level class for geometrical algorithm of building helix curves using arbitrary axis.

Constructor & Destructor Documentation

◆ HelixGeom_BuilderHelix()

HelixGeom_BuilderHelix::HelixGeom_BuilderHelix ( )

Empty constructor.

◆ ~HelixGeom_BuilderHelix()

HelixGeom_BuilderHelix::~HelixGeom_BuilderHelix ( )
override

Member Function Documentation

◆ Perform()

void HelixGeom_BuilderHelix::Perform ( )
overridevirtual

Performs calculations.

Implements HelixGeom_BuilderApproxCurve.

◆ Position()

const gp_Ax2 & HelixGeom_BuilderHelix::Position ( ) const

Gets coordinate axes for helix.

◆ SetPosition()

void HelixGeom_BuilderHelix::SetPosition ( const gp_Ax2 & aAx2)

Sets coordinate axes for helix.

Field Documentation

◆ myPosition

gp_Ax2 HelixGeom_BuilderHelix::myPosition
protected

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