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

Public Member Functions

 NutLambParams ()
 constructor.
 
 NutLambParams (float d, float h)
 constructor.
 
NutLambParamslength (const float &_l)
 set the length.
 
NutLambParamsdiameterBottom (const float &_d)
 set the bottom diameter.
 
NutLambParamsdiameterTop (const float &_d)
 set the top diameter.
 
NutLambParamsheadHeight (const float &_h)
 set the head height.
 
NutLambParamsthickness (const float &_t)
 set the thickness.
 
float length () const
 get the length.
 
float diameterBottom () const
 get the bottom diameter.
 
float diameterTop () const
 get the top diameter.
 
float headHeight () const
 get the head height.
 
float thickness () const
 get the thickness.
 
virtual NutHeadBaseParamscopy (NutHeadBaseParams *p=nullptr)
 copies the NutLambParams 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

◆ NutLambParams()

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

constructor.

Parameters
ddiameter
hheight

Member Function Documentation

◆ copy()

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

copies the NutLambParams object.

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

Reimplemented from coat::NutHeadBaseParams.

◆ diameterBottom() [1/2]

float coat::NutLambParams::diameterBottom ( ) const

get the bottom diameter.

Returns
bottom diameter

◆ diameterBottom() [2/2]

NutLambParams & coat::NutLambParams::diameterBottom ( const float & _d)

set the bottom diameter.

Parameters
_dbottom diameter
Returns
NutLambParams reference

◆ diameterTop() [1/2]

float coat::NutLambParams::diameterTop ( ) const

get the top diameter.

Returns
top diameter

◆ diameterTop() [2/2]

NutLambParams & coat::NutLambParams::diameterTop ( const float & _d)

set the top diameter.

Parameters
_dtop diameter
Returns
NutLambParams reference

◆ headHeight() [1/2]

float coat::NutLambParams::headHeight ( ) const

get the head height.

Parameters
_hheight
Returns
height value

◆ headHeight() [2/2]

NutLambParams & coat::NutLambParams::headHeight ( const float & _h)

set the head height.

Parameters
_hheight
Returns
NutLambParams reference

◆ length() [1/2]

float coat::NutLambParams::length ( ) const

get the length.

Returns
length value

◆ length() [2/2]

NutLambParams & coat::NutLambParams::length ( const float & _l)

set the length.

Parameters
_llength
Returns
NutLambParams reference

◆ thickness() [1/2]

float coat::NutLambParams::thickness ( ) const

get the thickness.

Returns
thickness value

◆ thickness() [2/2]

NutLambParams & coat::NutLambParams::thickness ( const float & _t)

set the thickness.

Parameters
_tthickness
Returns
NutLambParams reference

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