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

Public Member Functions

 __init__ (self)
 
bolt head (self, boltHead _h)
 set the head object.
 
boltHead head (self)
 get the head object.
 
bolt diameter (self, float _d)
 set the bolt diameter.
 
float diameter (self)
 get the bolt diameter.
 
bolt pitch (self, float _p)
 set the thread pitch.
 
float pitch (self)
 get the thread pitch.
 
bolt threadHeight (self, float _h)
 set the thread height.
 
float threadHeight (self)
 get the thread height.
 
bolt length (self, float _l)
 set the bolt length.
 
float length (self)
 get the bolt length.
 
bolt threadLength (self, float _l)
 set the thread length.
 
float threadLength (self)
 get the thread length.
 
bolt threadType (self, int _t)
 set the screw thread profile.
 
int threadType (self)
 get the screw thread profile.
 
bolt underhead (self, int _uh)
 set the under head type.
 
int underhead (self)
 get the under head type.
 
bolt uwidth (self, int _uw)
 set the underhead width.
 
float uwidth (self)
 get the underhead width.
 
bolt uheight (self, int _uh)
 set the underhead height.
 
float uheight (self)
 get the underhead height.
 
bolt nutType (self, int _t)
 set the nut type.
 
int nutType (self)
 get the nut type.
 
bolt nutLocation (self, float _loc)
 set the nut location on the bolt.
 
float nutLocation (self)
 get the nut location on the bolt.
 
bolt nutHeight (self, float _h)
 set the nut height on the bolt.
 
float nutHeight (self)
 get the nut height on the bolt.
 
- 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.bolt.__init__ ( self)

Reimplemented from coat.prim.

Member Function Documentation

◆ diameter() [1/2]

float coat.bolt.diameter ( self)

get the bolt diameter.

Returns
diameter

◆ diameter() [2/2]

bolt coat.bolt.diameter ( self,
float _d )

set the bolt diameter.

Parameters
_ddiameter
Returns
bolt reference

◆ head() [1/2]

boltHead coat.bolt.head ( self)

get the head object.

Returns
head obj reference

◆ head() [2/2]

bolt coat.bolt.head ( self,
boltHead _h )

set the head object.

Parameters
_hhead obj reference
Returns
bolt reference

◆ length() [1/2]

float coat.bolt.length ( self)

get the bolt length.

◆ length() [2/2]

bolt coat.bolt.length ( self,
float _l )

set the bolt length.

Parameters
_llength
Returns
bolt reference

◆ nutHeight() [1/2]

float coat.bolt.nutHeight ( self)

get the nut height on the bolt.

Returns
location value

◆ nutHeight() [2/2]

bolt coat.bolt.nutHeight ( self,
float _h )

set the nut height on the bolt.

Parameters
_hheight value
Returns
bolt reference

◆ nutLocation() [1/2]

float coat.bolt.nutLocation ( self)

get the nut location on the bolt.

Returns
location value

◆ nutLocation() [2/2]

bolt coat.bolt.nutLocation ( self,
float _loc )

set the nut location on the bolt.

Parameters
_loclocation value
Returns
bolt reference

◆ nutType() [1/2]

int coat.bolt.nutType ( self)

get the nut type.

Returns
type value

◆ nutType() [2/2]

bolt coat.bolt.nutType ( self,
int _t )

set the nut type.

Parameters
_ttype value (see nut.Type enumarate)
Returns
bolt reference

◆ pitch() [1/2]

float coat.bolt.pitch ( self)

get the thread pitch.

Returns
pitch

◆ pitch() [2/2]

bolt coat.bolt.pitch ( self,
float _p )

set the thread pitch.

Parameters
_ppitch
Returns
bolt reference

◆ threadHeight() [1/2]

float coat.bolt.threadHeight ( self)

get the thread height.

Returns
height value

◆ threadHeight() [2/2]

bolt coat.bolt.threadHeight ( self,
float _h )

set the thread height.

Parameters
_hheight
Returns
bolt reference

◆ threadLength() [1/2]

float coat.bolt.threadLength ( self)

get the thread length.

Returns
length

◆ threadLength() [2/2]

bolt coat.bolt.threadLength ( self,
float _l )

set the thread length.

Parameters
_llength
Returns
bolt reference

◆ threadType() [1/2]

int coat.bolt.threadType ( self)

get the screw thread profile.

Returns
thread type value.

◆ threadType() [2/2]

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

set the screw thread profile.

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

◆ uheight() [1/2]

float coat.bolt.uheight ( self)

get the underhead height.

Returns
height value

◆ uheight() [2/2]

bolt coat.bolt.uheight ( self,
int _uh )

set the underhead height.

Parameters
_uhheight
Returns
bolt reference

◆ underhead() [1/2]

int coat.bolt.underhead ( self)

get the under head type.

Returns
under head type value

◆ underhead() [2/2]

bolt coat.bolt.underhead ( self,
int _uh )

set the under head type.

Parameters
_uhtype value (0-cylinder,1-rect)
Returns
bolt reference

◆ uwidth() [1/2]

float coat.bolt.uwidth ( self)

get the underhead width.

Returns
width value

◆ uwidth() [2/2]

bolt coat.bolt.uwidth ( self,
int _uw )

set the underhead width.

Parameters
_uwwidth
Returns
bolt reference

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