3DCoat Core API
The 3DCoat API documentation.
Public Member Functions | List of all members
coat::nut::rim Class Reference
Inheritance diagram for coat::nut::rim:
coat::nut::base

Public Member Functions

 rim ()
 constructor.
 
 rim (float d, float h)
 constructor. More...
 
riminRingDiameter (const float &_d)
 set the inner ring diameter. More...
 
rimoutRingDiameter (const float &_d)
 set the outer ring diameter. More...
 
float inRingDiameter () const
 get the inner ring diameter. More...
 
float outRingDiameter () const
 get the outer ring diameter. More...
 
virtual basecopy (base *p=nullptr)
 copies the rim object. More...
 
- Public Member Functions inherited from coat::nut::base
 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

◆ rim()

coat::nut::rim::rim ( float  d,
float  h 
)

constructor.

Parameters
ddiameter
hheight

Member Function Documentation

◆ copy()

virtual base * coat::nut::rim::copy ( base p = nullptr)
virtual

copies the rim object.

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

Reimplemented from coat::nut::base.

◆ inRingDiameter() [1/2]

float coat::nut::rim::inRingDiameter ( ) const

get the inner ring diameter.

Returns
inner diameter

◆ inRingDiameter() [2/2]

rim & coat::nut::rim::inRingDiameter ( const float &  _d)

set the inner ring diameter.

Parameters
_ddiameter
Returns
rim reference

◆ outRingDiameter() [1/2]

float coat::nut::rim::outRingDiameter ( ) const

get the outer ring diameter.

Returns
outer diameter

◆ outRingDiameter() [2/2]

rim & coat::nut::rim::outRingDiameter ( const float &  _d)

set the outer ring diameter.

Parameters
_ddiameter
Returns
rim reference

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