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

Public Member Functions

 radial ()
 constructor.
 
 radial (float d, float h)
 constructor. More...
 
 radial (float d, float h, float d1, float d2)
 constructor More...
 
radialholeDiameter (const float &d)
 set the hole diameter. More...
 
radialholeDepth (const float &d)
 set the hole depth. More...
 
float holeDiameter () const
 set the hole diameter. More...
 
float holeDepth () const
 get the hole depth. More...
 
radialholePlace (const int &place)
 set the hole place (0 - face, 1 - side). More...
 
int holePlace () const
 get the hole place. More...
 
virtual basecopy (base *p=nullptr)
 copies the radial 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

◆ radial() [1/2]

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

constructor.

Parameters
ddiameter
hheight

◆ radial() [2/2]

coat::nut::radial::radial ( float  d,
float  h,
float  d1,
float  d2 
)

constructor

Parameters
ddiameter
hheight.
d1hole diameter
d2hole depth

Member Function Documentation

◆ copy()

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

copies the radial object.

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

Reimplemented from coat::nut::base.

◆ holeDepth() [1/2]

float coat::nut::radial::holeDepth ( ) const

get the hole depth.

Returns
radial hole depth

◆ holeDepth() [2/2]

radial & coat::nut::radial::holeDepth ( const float &  d)

set the hole depth.

Parameters
ddepth
Returns
radial reference

◆ holeDiameter() [1/2]

float coat::nut::radial::holeDiameter ( ) const

set the hole diameter.

Returns
hole diameter

◆ holeDiameter() [2/2]

radial & coat::nut::radial::holeDiameter ( const float &  d)

set the hole diameter.

Parameters
ddiameter
Returns
radial reference

◆ holePlace() [1/2]

int coat::nut::radial::holePlace ( ) const

get the hole place.

Returns
place flag 0 - face, 1 - side

◆ holePlace() [2/2]

radial & coat::nut::radial::holePlace ( const int &  place)

set the hole place (0 - face, 1 - side).

Parameters
placeplace flag
Returns
radial reference

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