coat.image Class Reference

Inheritance diagram for coat.image:

Public Member Functions
	__init__ (self)
image	topTexture (self, str _texture)
	set the top texture
any	topTexture (self)
	get the top texture
image	topBumpTexture (self, str _texture)
	set the top bump texture
any	topBumpTexture (self)
	get the top bump texture
image	bottomTexture (self, str _texture)
	set the bottom texture
any	bottomTexture (self)
	get the bottom texture
image	bottomBumpTexture (self, str _texture)
	set the bottom bump texture
any	bottomBumpTexture (self)
	get the bottom bump texture
image	strencilTexture (self, str _texture)
	set the strencil texture
any	strencilTexture (self)
	get the strencil texture
image	bottomStrencilTexture (self, str _texture)
	set the bottom strencil texture
any	bottomStrencilTexture (self)
	get the bottom strencil texture
image	basicThickness (self, float _thickness)
	set the basic thickness of image
float	basicThickness (self)
	get the basic thickness of image
image	bumpThickness (self, float _thickness)
	set the bump thickness of image
float	bumpThickness (self)
	get the bump thickness of image
image	taperAngle (self, float _angle)
	set the angle of tapering
float	taperAngle (self)
	get the angle of tapering of image
image	topBottomWeight (self, float weight)
	set the weight of the top and bottom image
float	topBottomWeight (self)
	get the weight of the top and bottom image
image	sizeInScene (self, float _size)
	set the size of image in the scene
float	sizeInScene (self)
	get the size of image in the scene
Public Member Functions inherited from coat.text
text	string (self, str s)
	set the text's string.
any	string (self)
	get the text's string.
text	font (self, Font f)
	set the text font
Font	font (self)
	get the font object
text	width (self, float w)
	set the text width in the pixels
float	width (self)
	get the text width
text	depth (self, float d)
	set the text depth in the pixels
float	depth (self)
	get the text depth
text	bendRadius (self, float radius)
	set the bend radius.
float	bendRadius (self)
	get the bend radius.
text	extraRotation (self, float rotation)
	set the rotate angle around the x-axis.
float	extraRotation (self)
	get the rotate angle around the x-axis.
text	invertBending (self, bool _binvert)
	set the invert of the text bending.
float	invertBending (self)
	get the invert of the text bending.
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.image.__init__

(

self

)

Reimplemented from coat.text.

Member Function Documentation

basicThickness() [1/2]

float coat.image.basicThickness

(

self

)

get the basic thickness of image

Returns

the thickness value

basicThickness() [2/2]

image coat.image.basicThickness	(		self,
		float	_thickness )

set the basic thickness of image

Parameters

_thickness

thickness value

Returns

the image reference

bottomBumpTexture() [1/2]

any coat.image.bottomBumpTexture

(

self

)

get the bottom bump texture

Returns

the string of the image file name

bottomBumpTexture() [2/2]

image coat.image.bottomBumpTexture	(		self,
		str	_texture )

set the bottom bump texture

Parameters

_texture

image file name

Returns

the image reference

bottomStrencilTexture() [1/2]

any coat.image.bottomStrencilTexture

(

self

)

get the bottom strencil texture

Returns

the string of the image file name

bottomStrencilTexture() [2/2]

image coat.image.bottomStrencilTexture	(		self,
		str	_texture )

set the bottom strencil texture

Parameters

_texture

image file name

Returns

the image reference

bottomTexture() [1/2]

any coat.image.bottomTexture

(

self

)

get the bottom texture

Returns

the string of the image file name

bottomTexture() [2/2]

image coat.image.bottomTexture	(		self,
		str	_texture )

set the bottom texture

Parameters

_texture

image file name

Returns

the image reference

bumpThickness() [1/2]

float coat.image.bumpThickness

(

self

)

get the bump thickness of image

Returns

the thickness value

bumpThickness() [2/2]

image coat.image.bumpThickness	(		self,
		float	_thickness )

set the bump thickness of image

Parameters

_thickness

thickness value

Returns

the image reference

sizeInScene() [1/2]

float coat.image.sizeInScene

(

self

)

get the size of image in the scene

Returns

the size value

sizeInScene() [2/2]

image coat.image.sizeInScene	(		self,
		float	_size )

set the size of image in the scene

Parameters

_size

size value

Returns

the image reference

strencilTexture() [1/2]

any coat.image.strencilTexture

(

self

)

get the strencil texture

Returns

the string of the image file name

strencilTexture() [2/2]

image coat.image.strencilTexture	(		self,
		str	_texture )

set the strencil texture

Parameters

_texture

image file name

Returns

the image reference

taperAngle() [1/2]

float coat.image.taperAngle

(

self

)

get the angle of tapering of image

Returns

the taper angle value

taperAngle() [2/2]

image coat.image.taperAngle	(		self,
		float	_angle )

set the angle of tapering

Parameters

_angle

taper angle value

Returns

the image reference

topBottomWeight() [1/2]

float coat.image.topBottomWeight

(

self

)

get the weight of the top and bottom image

Returns

the weight value

topBottomWeight() [2/2]

image coat.image.topBottomWeight	(		self,
		float	weight )

set the weight of the top and bottom image

Parameters

weight

weight value

Returns

the image reference

topBumpTexture() [1/2]

any coat.image.topBumpTexture

(

self

)

get the top bump texture

Returns

the string of the image file name

topBumpTexture() [2/2]

image coat.image.topBumpTexture	(		self,
		str	_texture )

set the top bump texture

Parameters

_texture

image file name

Returns

the image reference

topTexture() [1/2]

any coat.image.topTexture

(

self

)

get the top texture

Returns

the string of the image file name

topTexture() [2/2]

image coat.image.topTexture	(		self,
		str	_texture )

set the top texture

Parameters

_texture

image file name

Returns

the image reference

---

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

• doxy/src/coat.py