coat.freeform Class Reference

Inheritance diagram for coat.freeform:

Public Member Functions
	__init__ (self)
	__init__ (self, str _ffname, str _ffsubname)
	__init__ (self)
freeform	symx (self, bool x)
	Enable the XYZ-mirror symmetry.
freeform	symy (self, bool y)
	Enable the XYZ-mirror symmetry.
freeform	symz (self, bool z)
	Enable the XYZ-mirror symmetry.
freeform	size (self, float x, float y, float z)
	set the free form size
freeform	size (self, vec3 v)
	set the free form size
freeform	ffname (self, str name)
	set the free form name.
str	ffname (self)
	get the free form name.
freeform	ffsubname (self, str name)
	set the free form sub name.
str	ffsubname (self)
	get the free form sub name.
freeform	SetPoint (self, int i, vec3 point)
	set the knot point of the primitive.
int	CountPoints (self)
	get the account of the knot points
	ResetPoints (self)
	reset the knot points
any	objsList (self)
	gets the object's list.
any	ffControlPoints (self)
	get the knot(control) points of the primitive.
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/3]

coat.freeform.__init__

(

self

)

Reimplemented from coat.prim.

__init__() [2/3]

coat.freeform.__init__	(		self,
		str	_ffname,
		str	_ffsubname )

Reimplemented from coat.prim.

__init__() [3/3]

coat.freeform.__init__

(

self

)

Reimplemented from coat.prim.

Member Function Documentation

CountPoints()

int coat.freeform.CountPoints

(

self

)

get the account of the knot points

Returns

count of points

ffControlPoints()

any coat.freeform.ffControlPoints

(

self

)

get the knot(control) points of the primitive.

Returns

the points reference

ffname() [1/2]

str coat.freeform.ffname

(

self

)

get the free form name.

Returns

the name

ffname() [2/2]

freeform coat.freeform.ffname	(		self,
		str	name )

set the free form name.

set of names {"Cube","Patch,"Blob","Round","Ring",Torus","Tube2","Tube3","Disc","Cylinder"}

Parameters

name	the name string

Returns

the freeform reference

ffsubname() [1/2]

str coat.freeform.ffsubname

(

self

)

get the free form sub name.

Returns

the name

ffsubname() [2/2]

freeform coat.freeform.ffsubname	(		self,
		str	name )

set the free form sub name.

Parameters

name	the name string

Returns

the freeform reference

objsList()

any coat.freeform.objsList

(

self

)

gets the object's list.

Returns

objs list reference

ResetPoints()

coat.freeform.ResetPoints

(

self

)

reset the knot points

SetPoint()

freeform coat.freeform.SetPoint	(		self,
		int	i,
		vec3	point )

set the knot point of the primitive.

Parameters

i	point index
point	the coordinates of the point

Returns

the freeform reference

size() [1/2]

freeform coat.freeform.size	(		self,
		float	x,
		float	y,
		float	z )

set the free form size

Parameters

x	size in the x - axis
y	size in the y - axis
z	size in the z - axis

Returns

freeform reference

size() [2/2]

freeform coat.freeform.size	(		self,
		vec3	v )

set the free form size

Parameters

v	vector size

Returns

freeform reference

symx()

freeform coat.freeform.symx	(		self,
		bool	x )

Enable the XYZ-mirror symmetry.

Parameters

x	true to enable x-symmetry, false to disable

Returns

freeform reference

symy()

freeform coat.freeform.symy	(		self,
		bool	y )

Enable the XYZ-mirror symmetry.

Parameters

y	true to enable y-symmetry, false to disable

Returns

freeform reference

symz()

freeform coat.freeform.symz	(		self,
		bool	z )

Enable the XYZ-mirror symmetry.

Parameters

z	true to enable z-symmetry, false to disable

Returns

freeform reference

---

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

• doxy/src/coat.py