3DCoat Core API
The 3DCoat API documentation.
Loading...
Searching...
No Matches
coat::NutHeadBaseParams Class Reference
Inheritance diagram for coat::NutHeadBaseParams:
coat::NutAcornParams coat::NutClampLever coat::NutFlangeParams coat::NutHexaParams coat::NutLambParams coat::NutQuardParams coat::NutRadialParams coat::NutRimParams coat::NutSlitsParams

Public Member Functions

 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.
 
virtual NutHeadBaseParamscopy (NutHeadBaseParams *p=nullptr)
 copies the object.
 

Constructor & Destructor Documentation

◆ NutHeadBaseParams()

coat::NutHeadBaseParams::NutHeadBaseParams ( NutType t,
float d,
float h )

constructor.

Parameters
ttype of the nut
ddiameter
hheight

Member Function Documentation

◆ copy()

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

copies the object.

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

Reimplemented in coat::NutAcornParams, coat::NutClampLever, coat::NutFlangeParams, coat::NutLambParams, coat::NutRadialParams, coat::NutRimParams, and coat::NutSlitsParams.

◆ diameter() [1/2]

float coat::NutHeadBaseParams::diameter ( ) const

get the diameter.

Returns
diameter

◆ diameter() [2/2]

NutHeadBaseParams & coat::NutHeadBaseParams::diameter ( const float & d)

set the diameter.

Parameters
ddiameter
Returns
NutRadialParams reference

◆ height() [1/2]

float coat::NutHeadBaseParams::height ( ) const

get the height.

Returns
height value

◆ height() [2/2]

NutHeadBaseParams & coat::NutHeadBaseParams::height ( const float & h)

set the height.

Parameters
hheight value.
Returns
NutHeadBaseParams reference

◆ type() [1/2]

int coat::NutHeadBaseParams::type ( ) const

set the nut type.

Returns
type value.

◆ type() [2/2]

NutHeadBaseParams & coat::NutHeadBaseParams::type ( int t)

set the nut type.

Parameters
ttype value.
Returns
NutHeadBaseParams reference

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