3DCoat Python API
The 3DCoat Python API documentation.
Loading...
Searching...
No Matches
coat.box Class Reference
Inheritance diagram for coat.box:
coat.prim coat.lathe coat.torus

Public Member Functions

 __init__ (self)
 
 __init__ (self, float sizeX, float sizeY, float sizeZ)
 
 __init__ (self, vec3 size)
 
 __init__ (self, vec3 pos, vec3 size)
 
 __init__ (self, vec3 pos, vec3 size, float fillet)
 
box axis (self, vec3 directionX)
 set the x-direction
 
box axis (self, vec3 directionX, vec3 directionY)
 set the x and y direction
 
box axis (self, vec3 directionX, vec3 directionY, vec3 directionZ)
 set the x, y and z direction
 
box reset_axis (self)
 reset the x, y and z direction
 
vec3 axis_x (self)
 get the x-axis
 
vec3 axis_y (self)
 get the y-axis
 
vec3 axis_z (self)
 get the z-axis
 
box divide (self, int nx, int ny, int nz)
 set the number deviding
 
box size (self, vec3 _size)
 set the box size
 
box size (self, float x, float y, float z)
 set the box size
 
vec3 size (self)
 get the box size.
 
float fillet_relative (self)
 calculates a fillet relative value (0..1).
 
- 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
 

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/5]

coat.box.__init__ ( self)

Reimplemented from coat.prim.

Reimplemented in coat.lathe, coat.lathe, coat.torus, coat.torus, and coat.torus.

◆ __init__() [2/5]

coat.box.__init__ ( self,
float sizeX,
float sizeY,
float sizeZ )

Reimplemented from coat.prim.

Reimplemented in coat.lathe, coat.lathe, coat.torus, coat.torus, and coat.torus.

◆ __init__() [3/5]

coat.box.__init__ ( self,
vec3 size )

Reimplemented from coat.prim.

Reimplemented in coat.lathe, coat.lathe, coat.torus, coat.torus, and coat.torus.

◆ __init__() [4/5]

coat.box.__init__ ( self,
vec3 pos,
vec3 size )

Reimplemented from coat.prim.

Reimplemented in coat.lathe, coat.lathe, coat.torus, coat.torus, and coat.torus.

◆ __init__() [5/5]

coat.box.__init__ ( self,
vec3 pos,
vec3 size,
float fillet )

Reimplemented from coat.prim.

Reimplemented in coat.lathe, coat.lathe, coat.torus, coat.torus, and coat.torus.

Member Function Documentation

◆ axis() [1/3]

box coat.box.axis ( self,
vec3 directionX )

set the x-direction

Parameters
directionXthe x-direction
Returns
box reference

◆ axis() [2/3]

box coat.box.axis ( self,
vec3 directionX,
vec3 directionY )

set the x and y direction

Parameters
directionXthe x-direction
directionYthe y-direction
Returns
box reference

◆ axis() [3/3]

box coat.box.axis ( self,
vec3 directionX,
vec3 directionY,
vec3 directionZ )

set the x, y and z direction

Parameters
directionXthe x-direction
directionYthe y-direction
directionZthe z-direction
Returns
box reference

◆ axis_x()

vec3 coat.box.axis_x ( self)

get the x-axis

Returns
vec3 axis

◆ axis_y()

vec3 coat.box.axis_y ( self)

get the y-axis

Returns
vec3 axis

◆ axis_z()

vec3 coat.box.axis_z ( self)

get the z-axis

Returns
vec3 axis

◆ divide()

box coat.box.divide ( self,
int nx,
int ny,
int nz )

set the number deviding

Parameters
nxnumber deviding along the x-axis
nynumber deviding along the y-axis
nznumber deviding along the z-axis
Returns
box reference

◆ fillet_relative()

float coat.box.fillet_relative ( self)

calculates a fillet relative value (0..1).

Returns
fillet relative value

Reimplemented from coat.prim.

◆ reset_axis()

box coat.box.reset_axis ( self)

reset the x, y and z direction

Returns
box reference

◆ size() [1/3]

vec3 coat.box.size ( self)

get the box size.

Returns
size

◆ size() [2/3]

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

set the box size

Parameters
xsize x
ysize y
zsize z
Returns
box reference

◆ size() [3/3]

box coat.box.size ( self,
vec3 _size )

set the box size

Parameters
_sizesize
Returns
box reference

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