coat::NutRimParams Class Reference

Inheritance diagram for coat::NutRimParams:

Public Member Functions
	NutRimParams ()
	constructor.
	NutRimParams (float d, float h)
	constructor.
NutRimParams &	inRingDiameter (const float &_d)
	set the inner ring diameter.
NutRimParams &	outRingDiameter (const float &_d)
	set the outer ring diameter.
float	inRingDiameter () const
	get the inner ring diameter.
float	outRingDiameter () const
	get the outer ring diameter.
virtual NutHeadBaseParams *	copy (NutHeadBaseParams *p=nullptr)
	copies the NutRimParams object.
Public Member Functions inherited from coat::NutHeadBaseParams
	NutHeadBaseParams ()
	constructor.
	NutHeadBaseParams (NutType t, float d, float h)
	constructor.
NutHeadBaseParams &	diameter (const float &d)
	set the diameter.
float	diameter () const
	get the diameter.
NutHeadBaseParams &	height (const float &h)
	set the height.
float	height () const
	get the height.
	operator void * () const
	() operator
NutHeadBaseParams &	type (int t)
	set the nut type.
int	type () const
	set the nut type.

Constructor & Destructor Documentation

NutRimParams()

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

constructor.

Parameters

d	diameter
h	height

Member Function Documentation

copy()

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

virtual

copies the NutRimParams object.

Parameters

p	pointer to the NutRimParams object to copy. If the pointer equals to null then the object is duplicated

Returns

the pointer to a copy of an NutRimParams object.

Reimplemented from coat::NutHeadBaseParams.

inRingDiameter() [1/2]

float coat::NutRimParams::inRingDiameter

(

)

const

get the inner ring diameter.

Returns

inner diameter

inRingDiameter() [2/2]

NutRimParams & coat::NutRimParams::inRingDiameter

(

const float &

_d

)

set the inner ring diameter.

Parameters

_d

diameter

Returns

NutRimParams reference

outRingDiameter() [1/2]

float coat::NutRimParams::outRingDiameter

(

)

const

get the outer ring diameter.

Returns

outer diameter

outRingDiameter() [2/2]

NutRimParams & coat::NutRimParams::outRingDiameter

(

const float &

_d

)

set the outer ring diameter.

Parameters

_d

diameter

Returns

NutRimParams reference

---

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

• include/CorePrimAPI.h