coat.spiral Class Reference

Inheritance diagram for coat.spiral:

Public Member Functions
	__init__ (self)
	__init__ (self, float out_radius, float in_radius, float _sstep, float nturns)
spiral	radius (self, float r)
	set the outer radius of the spiral.
float	radius (self)
	get the outer radius.
spiral	profile_radius (self, float r)
	set the profile radius.
float	profile_radius (self)
	get the profile radius.
spiral	diameter (self, float d)
	set the outer diameter of the spiral.
float	diameter (self)
	get the outer diameter.
spiral	profile_diameter (self, float d)
	set the profile diameter.
float	profile_diameter (self)
	get the profile diameter.
spiral	turns (self, int nturns)
	set the number of turns.
int	turns (self)
	get the number of turns.
spiral	step (self, float vstep)
	set the spiral step.
float	step (self)
	get the spiral step.
spiral	profile_type (self, SpiralProfile type)
	set the type of profile (circle or rectangle).
spiral	profile_rect (self, float width, float height)
	set the dimensions for the rectangle profile.
spiral	clock_wise (self, bool clockWise)
	set the clockwise direction of the spiral.
bool	clock_wise (self)
	get the clokwise direction of the spiral.
float	profile_height (self)
	get the profile height for rectangle profile.
float	profile_width (self)
	get the profile width for rectangle profile.
spiral	slices (self, int nslices)
	set the number of slices in the mesh.
int	slices (self)
	get the number of slices in the mesh.
spiral	rings (self, int nrings)
	set the number of rings in the mesh.
int	rings (self)
	get the number of rings in the mesh.
spiral	caps (self, int ncaps)
	set the number of caps in the mesh.
int	caps (self)
	get the number of caps in the mesh.
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__() [1/2]

coat.spiral.__init__

(

self

)

Reimplemented from coat.prim.

__init__() [2/2]

coat.spiral.__init__	(		self,
		float	out_radius,
		float	in_radius,
		float	_sstep,
		float	nturns )

Reimplemented from coat.prim.

Member Function Documentation

caps() [1/2]

int coat.spiral.caps

(

self

)

get the number of caps in the mesh.

Returns

number of caps

caps() [2/2]

spiral coat.spiral.caps	(		self,
		int	ncaps )

set the number of caps in the mesh.

Parameters

ncaps

number of caps.

Returns

spiral reference

clock_wise() [1/2]

bool coat.spiral.clock_wise

(

self

)

get the clokwise direction of the spiral.

Returns

the clokwise direction( true or false)

clock_wise() [2/2]

spiral coat.spiral.clock_wise	(		self,
		bool	clockWise )

set the clockwise direction of the spiral.

Parameters

clockWise

the indicator of the clockwise direction

Returns

spiral reference

diameter() [1/2]

float coat.spiral.diameter

(

self

)

get the outer diameter.

Returns

outer diameter

diameter() [2/2]

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

set the outer diameter of the spiral.

Parameters

d	diameter value

Returns

spiral reference

profile_diameter() [1/2]

float coat.spiral.profile_diameter

(

self

)

get the profile diameter.

Returns

profile diameter

profile_diameter() [2/2]

spiral coat.spiral.profile_diameter	(		self,
		float	d )

set the profile diameter.

Parameters

d	diameter value

Returns

spiral reference

profile_height()

float coat.spiral.profile_height

(

self

)

get the profile height for rectangle profile.

Returns

the profile height

profile_radius() [1/2]

float coat.spiral.profile_radius

(

self

)

get the profile radius.

Returns

profile radius

profile_radius() [2/2]

spiral coat.spiral.profile_radius	(		self,
		float	r )

set the profile radius.

Parameters

r	radius value

Returns

spiral reference

profile_rect()

spiral coat.spiral.profile_rect	(		self,
		float	width,
		float	height )

set the dimensions for the rectangle profile.

Parameters

width	the width value
height	the height value

Returns

spiral reference

profile_type()

spiral coat.spiral.profile_type	(		self,
		SpiralProfile	type )

set the type of profile (circle or rectangle).

Parameters

type	profile type

Returns

spiral reference

profile_width()

float coat.spiral.profile_width

(

self

)

get the profile width for rectangle profile.

Returns

the profile width

radius() [1/2]

float coat.spiral.radius

(

self

)

get the outer radius.

Returns

outer radius

radius() [2/2]

spiral coat.spiral.radius	(		self,
		float	r )

set the outer radius of the spiral.

Parameters

r	radius value

Returns

spiral reference

rings() [1/2]

int coat.spiral.rings

(

self

)

get the number of rings in the mesh.

Returns

number of rings

rings() [2/2]

spiral coat.spiral.rings	(		self,
		int	nrings )

set the number of rings in the mesh.

Parameters

nrings

number of rings.

Returns

spiral reference

slices() [1/2]

int coat.spiral.slices

(

self

)

get the number of slices in the mesh.

Returns

number of slices

slices() [2/2]

spiral coat.spiral.slices	(		self,
		int	nslices )

set the number of slices in the mesh.

Parameters

nslices

number of slices.

Returns

spiral reference

step() [1/2]

float coat.spiral.step

(

self

)

get the spiral step.

Returns

step value

step() [2/2]

spiral coat.spiral.step	(		self,
		float	vstep )

set the spiral step.

Parameters

vstep

step value

Returns

spiral reference

turns() [1/2]

int coat.spiral.turns

(

self

)

get the number of turns.

Returns

turns count

turns() [2/2]

spiral coat.spiral.turns	(		self,
		int	nturns )

set the number of turns.

Parameters

nturns

turns count

Returns

spiral reference

---

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

• doxy/src/coat.py