coat.screw Class Reference

Inheritance diagram for coat.screw:

Public Member Functions
	__init__ (self)
screw	head (self, boltHead _h)
	set the bolt head object.
boltHead	head (self)
	get the bolt head object.
screw	diameter (self, float _d)
	set the screw diameter.
float	diameter (self)
	get the screw diameter.
screw	pitch (self, float _p)
	set the screw thread step(pitch).
float	pitch (self)
	get the screw thread step(pitch).
screw	threadDiameter (self, float _d)
	set the thread diameter.
float	threadDiameter (self)
	get the thread diameter.
screw	threadHeight (self, float _h)
	set the screw thread height.
float	threadHeight (self)
	get the screw thread height.
screw	threadLength (self, float _l)
	set the screw thread length.
float	threadLength (self)
	get the screw thread length.
screw	length (self, float _l)
	set the screw length.
float	length (self)
	get the screw length.
screw	underhead (self, int _uh)
	set the underhead type.
int	underhead (self)
	get the underhead type.
screw	uwidth (self, int _uw)
	set the underhead width.
float	uwidth (self)
	get the underhead width.
screw	uheight (self, int _uh)
	set the underhead height.
float	uheight (self)
	get the underhead height.
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.screw.__init__

(

self

)

Reimplemented from coat.prim.

Member Function Documentation

diameter() [1/2]

float coat.screw.diameter

(

self

)

get the screw diameter.

Returns

diameter

diameter() [2/2]

screw coat.screw.diameter	(		self,
		float	_d )

set the screw diameter.

Parameters

_d

diameter

Returns

screw reference

head() [1/2]

boltHead coat.screw.head

(

self

)

get the bolt head object.

Returns

bolt head obj reference

head() [2/2]

screw coat.screw.head	(		self,
		boltHead	_h )

set the bolt head object.

Parameters

_h	bolt head obj reference

Returns

screw reference

length() [1/2]

float coat.screw.length

(

self

)

get the screw length.

Returns

length

length() [2/2]

screw coat.screw.length	(		self,
		float	_l )

set the screw length.

Parameters

_l

length

Returns

screw reference

pitch() [1/2]

float coat.screw.pitch

(

self

)

get the screw thread step(pitch).

Returns

step value

pitch() [2/2]

screw coat.screw.pitch	(		self,
		float	_p )

set the screw thread step(pitch).

Parameters

_p

step

Returns

screw reference

threadDiameter() [1/2]

float coat.screw.threadDiameter

(

self

)

get the thread diameter.

Returns

diameter

threadDiameter() [2/2]

screw coat.screw.threadDiameter	(		self,
		float	_d )

set the thread diameter.

Parameters

_d

diameter

Returns

screw reference

threadHeight() [1/2]

float coat.screw.threadHeight

(

self

)

get the screw thread height.

Returns

thread height value

threadHeight() [2/2]

screw coat.screw.threadHeight	(		self,
		float	_h )

set the screw thread height.

Parameters

_h

height

Returns

screw reference

threadLength() [1/2]

float coat.screw.threadLength

(

self

)

get the screw thread length.

Returns

length value

threadLength() [2/2]

screw coat.screw.threadLength	(		self,
		float	_l )

set the screw thread length.

Parameters

_l

length

Returns

screw reference

uheight() [1/2]

float coat.screw.uheight

(

self

)

get the underhead height.

Returns

height value

uheight() [2/2]

screw coat.screw.uheight	(		self,
		int	_uh )

set the underhead height.

Parameters

_uh

height

Returns

screw reference

underhead() [1/2]

int coat.screw.underhead

(

self

)

get the underhead type.

Returns

type value

underhead() [2/2]

screw coat.screw.underhead	(		self,
		int	_uh )

set the underhead type.

Parameters

_uh	type (0-cylinder,1-rect)

Returns

screw reference

uwidth() [1/2]

float coat.screw.uwidth

(

self

)

get the underhead width.

Returns

width value

uwidth() [2/2]

screw coat.screw.uwidth	(		self,
		int	_uw )

set the underhead width.

Parameters

_uw

width

Returns

screw reference

---

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

• doxy/src/coat.py