coat.threadStud Class Reference

Inheritance diagram for coat.threadStud:

Public Member Functions
	__init__ (self)
threadStud	diameter (self, float d)
	set the diameter of the thread.
float	diameter (self)
	get the diameter of the thread.
threadStud	diameterTop (self, float d)
	get the top diameter of the thread.
float	diameterTop (self)
	get the top diameter of the thread.
threadStud	diameterBottom (self, float d)
	set the bottom diameter of the thread.
float	diameterBottom (self)
	get the bottom diameter of the thread.
threadStud	length (self, float l)
	set the stud length.
float	length (self)
	get the length of the stud.
float	threadLength (self)
	get the length of the thread.
threadStud	enableThread (self, bool enable)
	enabled or disabled thread in the stud.
bool	enableThread (self)
	get the indicator of the enabled thread.
threadStud	bodyType (self, ThreadStudBodyType bt)
	set the body type.
ThreadStudBodyType	bodyType (self)
	get the body type.
Public Member Functions inherited from coat.thread
thread	pitch (self, float p)
	set the pitch of the thread.
float	pitch (self)
	set the pitch of the thread.
thread	stub (self, float l)
	set the stub length of the thread.
float	stub (self)
	get the stub length of the thread.
thread	height (self, float h)
	set the height of the thread.
float	height (self)
	get the height of the thread.
thread	turns (self, int n)
	set the number of the thread turns.
int	turns (self)
	get the number of the thread turns.
thread	clockwise (self, bool cw)
	set the clockwise flag of the thread.
bool	clockwise (self)
	get the clockwise of the thread.
thread	close (self, bool b)
	set the closed thread.
bool	close (self)
	set the closed thread.
thread	profile (self, ThreadProfile prf)
	set the thread profile type.
ThreadProfile	profile (self)
	get the thread profile type.
Public Member Functions inherited from coat.prim
any	class_name (self)
	get the primitive class name.
prim	name (self, str s)
	set the primitive object name.
any	name (self)
	get the primitive object name.
	add (self, Volume v)
	add the prim into scene
	subtract (self, Volume v)
	subtract the prim from scene
	intersect (self, Volume v)
	intersect the prim into scene
	merge (self, Volume v, BoolOpType op)
	merge the prim into scene
Mesh	mesh (self)
	get the mesh prim
prim	color (self, int CL)
	assign the color to the primitive (in voxels)
prim	color (self, float r, float g, float b, float a)
	assign the color to the primitive (in voxels)
prim	color (self, float r, float g, float b)
	assign the color to the primitive (in voxels)
prim	color (self, str colorid)
	assign the color to the primitive (in voxels)
prim	gloss (self, float value)
	assign the gloss for the voxel primitive, it will work only if the color already assigned
prim	roughness (self, float value)
	assign the roughness for the voxel primitive, it will work only if the color already assigned
prim	metal (self, float value)
	the metalliclty value for the voxel primitive, it will work only if the color already assigned
prim	opacity (self, float value)
	assign the opacity of the color over the voxel primitive.
prim	details (self, float det_level)
	set the detail level
float	details (self)
	get the detail level
prim	transform (self, mat4 t)
	set the transform matrix
mat4	transform (self)
	get the transform matrix
prim	scale (self, float scale)
	set the scale
prim	scale (self, vec3 v)
	set the scale
vec3	scale (self)
	get the scale
prim	translate (self, vec3 _pos)
	Set the primitive translation.
vec3	translate (self)
	get the primitive translation
prim	translate (self, float x, float y, float z)
	Set the primitive translation.
prim	x (self, float x)
	shift the primitive along the x - axis
prim	y (self, float y)
	shift the primitive along the y - axis
prim	z (self, float z)
	shift the primitive along the z - axis
prim	auto_divide (self, float average_div)
	set the auto devide
prim	step_divide (self, float step)
	set the step devide
prim	fillet (self, float radius)
	set the fillet
float	fillet_relative (self)
	calculates a fillet relative value (0..1).

Additional Inherited Members
Static Public Member Functions inherited from coat.prim
	debug_on (bool isOn=True)
	indicates whether to turn on or off the debug mode.
	debug_clear ()
	clear the debug info for primitive operations
	push_transform (mat4 t)
	set the global transform matrix to all primitives
	push_translate (vec3 d)
	Set the translation to all primitives.
	push_scale (float scale)
	Set the scale to all primitives.
	push_scale (vec3 s)
	Set the scale to all primitives.
	push_details (float details_modulator)
	set the detail level to all primitives
	reset_transform ()
	reset the global transform matrix

Constructor & Destructor Documentation

__init__()

coat.threadStud.__init__

(

self

)

Reimplemented from coat.thread.

Member Function Documentation

bodyType() [1/2]

ThreadStudBodyType coat.threadStud.bodyType

(

self

)

get the body type.

Returns

type value

bodyType() [2/2]

threadStud coat.threadStud.bodyType	(		self,
		ThreadStudBodyType	bt )

set the body type.

Parameters

bt

body type

Returns

thread stud reference

diameter() [1/2]

float coat.threadStud.diameter

(

self

)

get the diameter of the thread.

Returns

diameter value

Reimplemented from coat.thread.

diameter() [2/2]

threadStud coat.threadStud.diameter	(		self,
		float	d )

set the diameter of the thread.

Parameters

d	diameter value

Returns

thread stud reference

Reimplemented from coat.thread.

diameterBottom() [1/2]

float coat.threadStud.diameterBottom

(

self

)

get the bottom diameter of the thread.

Returns

diameter value

diameterBottom() [2/2]

threadStud coat.threadStud.diameterBottom	(		self,
		float	d )

set the bottom diameter of the thread.

Parameters

d	diameter value

Returns

thread stud reference

diameterTop() [1/2]

float coat.threadStud.diameterTop

(

self

)

get the top diameter of the thread.

Returns

diameter value

diameterTop() [2/2]

threadStud coat.threadStud.diameterTop	(		self,
		float	d )

get the top diameter of the thread.

Parameters

d	diameter value

Returns

thread stud reference

enableThread() [1/2]

bool coat.threadStud.enableThread

(

self

)

get the indicator of the enabled thread.

Returns

enabled/disabled value

enableThread() [2/2]

threadStud coat.threadStud.enableThread	(		self,
		bool	enable )

enabled or disabled thread in the stud.

Returns

thread stud reference

length() [1/2]

float coat.threadStud.length

(

self

)

get the length of the stud.

Returns

length value

length() [2/2]

threadStud coat.threadStud.length	(		self,
		float	l )

set the stud length.

Parameters

l	length value

Returns

thread stud reference

threadLength()

float coat.threadStud.threadLength

(

self

)

get the length of the thread.

Returns

length value

---

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

• doxy/src/coat.py