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

Public Member Functions

 NutFlangeParams ()
 constructor.
 
 NutFlangeParams (float d, float h)
 constructor.
 
 NutFlangeParams (float d, float h, float fw, float fh)
 constructor.
 
NutFlangeParamsfacetWidth (const float &w)
 set the width.
 
NutFlangeParamsfacetHeight (const float &h)
 set the facet height.
 
float facetWidth () const
 get the width.
 
float facetHeight () const
 get the height.
 
virtual NutHeadBaseParamscopy (NutHeadBaseParams *p=nullptr)
 copies the NutFlangeParams 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

◆ NutFlangeParams() [1/2]

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

constructor.

Parameters
ddiameter
hheight

◆ NutFlangeParams() [2/2]

coat::NutFlangeParams::NutFlangeParams ( float d,
float h,
float fw,
float fh )

constructor.

Parameters
ddiameter
hheight
fwfacet width
fhfacet height

Member Function Documentation

◆ copy()

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

copies the NutFlangeParams object.

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

Reimplemented from coat::NutHeadBaseParams.

◆ facetHeight() [1/2]

float coat::NutFlangeParams::facetHeight ( ) const

get the height.

Returns
height value.

◆ facetHeight() [2/2]

NutFlangeParams & coat::NutFlangeParams::facetHeight ( const float & h)

set the facet height.

Parameters
hheight value.
Returns
NutFlangeParams reference

◆ facetWidth() [1/2]

float coat::NutFlangeParams::facetWidth ( ) const

get the width.

Returns
width value.

◆ facetWidth() [2/2]

NutFlangeParams & coat::NutFlangeParams::facetWidth ( const float & w)

set the width.

Parameters
wwidth value.
Returns
NutFlangeParams reference

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