coat::NutRadialParams Class Reference

Inheritance diagram for coat::NutRadialParams:

Public Member Functions
	NutRadialParams ()
	constructor.
	NutRadialParams (float d, float h)
	constructor.
	NutRadialParams (float d, float h, float d1, float d2)
	constructor
NutRadialParams &	holeDiameter (const float &d)
	set the hole diameter.
NutRadialParams &	holeDepth (const float &d)
	set the hole depth.
float	holeDiameter () const
	set the hole diameter.
float	holeDepth () const
	get the hole depth.
NutRadialParams &	holePlace (const int &place)
	set the hole place (0 - face, 1 - side).
int	holePlace () const
	get the hole place.
virtual NutHeadBaseParams *	copy (NutHeadBaseParams *p=nullptr)
	copies the radial 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.
virtual NutHeadBaseParams *	copy (NutHeadBaseParams *p=nullptr)
	copies the object.

Constructor & Destructor Documentation

NutRadialParams() [1/2]

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

constructor.

Parameters

d	diameter
h	height

NutRadialParams() [2/2]

coat::NutRadialParams::NutRadialParams	(	float	d,
		float	h,
		float	d1,
		float	d2
	)

constructor

Parameters

d	diameter
h	height.
d1	hole diameter
d2	hole depth

Member Function Documentation

copy()

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

virtual

copies the radial object.

Parameters

p	pointer 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::NutHeadBaseParams.

holeDepth() [1/2]

float coat::NutRadialParams::holeDepth

(

)

const

get the hole depth.

Returns

NutRadialParams hole depth

holeDepth() [2/2]

NutRadialParams & coat::NutRadialParams::holeDepth

(

const float &

d

)

set the hole depth.

Parameters

d

depth

Returns

NutRadialParams reference

holeDiameter() [1/2]

float coat::NutRadialParams::holeDiameter

(

)

const

set the hole diameter.

Returns

hole diameter

holeDiameter() [2/2]

NutRadialParams & coat::NutRadialParams::holeDiameter

(

const float &

d

)

set the hole diameter.

Parameters

d

diameter

Returns

NutRadialParams reference

holePlace() [1/2]

int coat::NutRadialParams::holePlace

(

)

const

get the hole place.

Returns

place flag 0 - face, 1 - side

holePlace() [2/2]

NutRadialParams & coat::NutRadialParams::holePlace

(

const int &

place

)

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

Parameters

place

place flag

Returns

NutRadialParams reference

---

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

• include/CorePrimAPI.h