3DCoat Python API
The 3DCoat Python API documentation.
Loading...
Searching...
No Matches
coat.text Class Reference
Inheritance diagram for coat.text:
coat.prim coat.image

Public Member Functions

 __init__ (self)
 
 __init__ (self, str s)
 
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__() [1/2]

coat.text.__init__ ( self)

Reimplemented from coat.prim.

Reimplemented in coat.image.

◆ __init__() [2/2]

coat.text.__init__ ( self,
str s )

Reimplemented from coat.prim.

Reimplemented in coat.image.

Member Function Documentation

◆ bendRadius() [1/2]

float coat.text.bendRadius ( self)

get the bend radius.

Returns
the bend radius of the text

◆ bendRadius() [2/2]

text coat.text.bendRadius ( self,
float radius )

set the bend radius.

Parameters
radiusbend radius of the text
Returns
the text reference

◆ depth() [1/2]

float coat.text.depth ( self)

get the text depth

Returns
the depth value

◆ depth() [2/2]

text coat.text.depth ( self,
float d )

set the text depth in the pixels

Parameters
ddepth
Returns
the text reference

◆ extraRotation() [1/2]

float coat.text.extraRotation ( self)

get the rotate angle around the x-axis.

Returns
the rotate angle

◆ extraRotation() [2/2]

text coat.text.extraRotation ( self,
float rotation )

set the rotate angle around the x-axis.

Returns
the text reference

◆ font() [1/2]

Font coat.text.font ( self)

get the font object

Returns
font object

◆ font() [2/2]

text coat.text.font ( self,
Font f )

set the text font

Parameters
ffont object
Returns
the text reference

◆ invertBending() [1/2]

float coat.text.invertBending ( self)

get the invert of the text bending.

Returns
the invert bending

◆ invertBending() [2/2]

text coat.text.invertBending ( self,
bool _binvert )

set the invert of the text bending.

Returns
the text reference

◆ string() [1/2]

any coat.text.string ( self)

get the text's string.

Returns
the string

◆ string() [2/2]

text coat.text.string ( self,
str s )

set the text's string.

Parameters
sthe string

◆ width() [1/2]

float coat.text.width ( self)

get the text width

Returns
the width value

◆ width() [2/2]

text coat.text.width ( self,
float w )

set the text width in the pixels

Parameters
wwidth
Returns
the text reference

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