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

Public Member Functions

 __init__ (self)
 
 __init__ (self)
 
nut setTypeData (self, any data)
 set the typed data.
 
any getTypeData (self)
 get the typed data.
 
nut threadDiameter (self, float d)
 set the hole thread diameter.
 
float threadDiameter (self)
 get the hole thread diameter.
 
nut pitch (self, float p)
 set the thread pitch.
 
float pitch (self)
 get the thread pitch.
 
nut enableThread (self, bool f)
 set the enabled thread.
 
bool enableThread (self)
 get the enabled thread.
 
nut threadType (self, int _t)
 set the nut thread profile.
 
int threadType (self)
 get the nut thread profile.
 
- 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.nut.__init__ ( self)

Reimplemented from coat.prim.

◆ __init__() [2/2]

coat.nut.__init__ ( self)

Reimplemented from coat.prim.

Member Function Documentation

◆ enableThread() [1/2]

bool coat.nut.enableThread ( self)

get the enabled thread.

Returns
enabled flag

◆ enableThread() [2/2]

nut coat.nut.enableThread ( self,
bool f )

set the enabled thread.

Returns
nut reference

◆ getTypeData()

any coat.nut.getTypeData ( self)

get the typed data.

Returns
pointer to the data

◆ pitch() [1/2]

float coat.nut.pitch ( self)

get the thread pitch.

Returns
pitch

◆ pitch() [2/2]

nut coat.nut.pitch ( self,
float p )

set the thread pitch.

Returns
nut reference

◆ setTypeData()

nut coat.nut.setTypeData ( self,
any data )

set the typed data.

Parameters
datapointer to the data
Returns
nut reference

◆ threadDiameter() [1/2]

float coat.nut.threadDiameter ( self)

get the hole thread diameter.

Returns
diameter

◆ threadDiameter() [2/2]

nut coat.nut.threadDiameter ( self,
float d )

set the hole thread diameter.

Returns
nut reference

◆ threadType() [1/2]

int coat.nut.threadType ( self)

get the nut thread profile.

Returns
thread type value.

◆ threadType() [2/2]

nut coat.nut.threadType ( self,
int _t )

set the nut thread profile.

Parameters
_tprofile type value (triangle,trapeze,rectangular,round,persistent)
Returns
nut reference

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