3DCoat Core API
The 3DCoat API documentation.
Loading...
Searching...
No Matches
coat::NutRadialParams Class Reference
Inheritance diagram for coat::NutRadialParams:
coat::NutHeadBaseParams

Public Member Functions

 NutRadialParams ()
 constructor.
 
 NutRadialParams (float d, float h)
 constructor.
 
 NutRadialParams (float d, float h, float d1, float d2)
 constructor
 
NutRadialParamsholeDiameter (const float &d)
 set the hole diameter.
 
NutRadialParamsholeDepth (const float &d)
 set the hole depth.
 
float holeDiameter () const
 set the hole diameter.
 
float holeDepth () const
 get the hole depth.
 
NutRadialParamsholePlace (const int &place)
 set the hole place (0 - face, 1 - side).
 
int holePlace () const
 get the hole place.
 
virtual NutHeadBaseParamscopy (NutHeadBaseParams *p=nullptr)
 copies the radial object.
 
- Public Member Functions inherited from coat::NutHeadBaseParams
 NutHeadBaseParams ()
 constructor.
 
 NutHeadBaseParams (NutType t, float d, float h)
 constructor.
 
NutHeadBaseParamsdiameter (const float &d)
 set the diameter.
 
float diameter () const
 get the diameter.
 
NutHeadBaseParamsheight (const float &h)
 set the height.
 
float height () const
 get the height.
 
 operator void * () const
 () operator
 
NutHeadBaseParamstype (int t)
 set the nut type.
 
int type () const
 set the nut type.
 

Constructor & Destructor Documentation

◆ NutRadialParams() [1/2]

coat::NutRadialParams::NutRadialParams ( float d,
float h )

constructor.

Parameters
ddiameter
hheight

◆ NutRadialParams() [2/2]

coat::NutRadialParams::NutRadialParams ( float d,
float h,
float d1,
float d2 )

constructor

Parameters
ddiameter
hheight.
d1hole diameter
d2hole depth

Member Function Documentation

◆ copy()

virtual NutHeadBaseParams * coat::NutRadialParams::copy ( NutHeadBaseParams * p = nullptr)
virtual

copies the radial object.

Parameters
ppointer to the radial object to copy. If the pointer equals to null then the object is duplicated
Returns
the pointer to a copy of an radial object.

Reimplemented from coat::NutHeadBaseParams.

◆ holeDepth() [1/2]

float coat::NutRadialParams::holeDepth ( ) const

get the hole depth.

Returns
NutRadialParams hole depth

◆ holeDepth() [2/2]

NutRadialParams & coat::NutRadialParams::holeDepth ( const float & d)

set the hole depth.

Parameters
ddepth
Returns
NutRadialParams reference

◆ holeDiameter() [1/2]

float coat::NutRadialParams::holeDiameter ( ) const

set the hole diameter.

Returns
hole diameter

◆ holeDiameter() [2/2]

NutRadialParams & coat::NutRadialParams::holeDiameter ( const float & d)

set the hole diameter.

Parameters
ddiameter
Returns
NutRadialParams reference

◆ holePlace() [1/2]

int coat::NutRadialParams::holePlace ( ) const

get the hole place.

Returns
place flag 0 - face, 1 - side

◆ holePlace() [2/2]

NutRadialParams & coat::NutRadialParams::holePlace ( const int & place)

set the hole place (0 - face, 1 - side).

Parameters
placeplace flag
Returns
NutRadialParams reference

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