3DCoat Core API
The 3DCoat API documentation.
Public Member Functions | List of all members
coat::nut::base Class Reference
Inheritance diagram for coat::nut::base:
coat::nut::acorn coat::nut::clamplever coat::nut::flange coat::nut::hexa coat::nut::lamb coat::nut::quard coat::nut::radial coat::nut::rim coat::nut::slits

Public Member Functions

 base ()
 constructor.
 
 base (Type t, float d, float h)
 constructor. More...
 
basediameter (const float &d)
 set the diameter. More...
 
float diameter () const
 get the diameter. More...
 
baseheight (const float &h)
 set the height. More...
 
float height () const
 get the height. More...
 
 operator void * () const
 () operator
 
basetype (int t)
 set the nut type. More...
 
int type () const
 set the nut type. More...
 
virtual basecopy (base *p=nullptr)
 copies the object. More...
 

Constructor & Destructor Documentation

◆ base()

coat::nut::base::base ( Type  t,
float  d,
float  h 
)

constructor.

Parameters
ttype of the nut
ddiameter
hheight

Member Function Documentation

◆ copy()

virtual base * coat::nut::base::copy ( base 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::nut::acorn, coat::nut::flange, coat::nut::radial, coat::nut::lamb, coat::nut::slits, coat::nut::rim, and coat::nut::clamplever.

◆ diameter() [1/2]

float coat::nut::base::diameter ( ) const

get the diameter.

Returns
diameter

◆ diameter() [2/2]

base & coat::nut::base::diameter ( const float &  d)

set the diameter.

Parameters
ddiameter
Returns
base reference

◆ height() [1/2]

float coat::nut::base::height ( ) const

get the height.

Returns
height value

◆ height() [2/2]

base & coat::nut::base::height ( const float &  h)

set the height.

Parameters
hheight value.
Returns
base reference

◆ type() [1/2]

int coat::nut::base::type ( ) const

set the nut type.

Returns
type value.

◆ type() [2/2]

base & coat::nut::base::type ( int  t)

set the nut type.

Parameters
ttype value.
Returns
base reference

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