3DCoat Core API
The 3DCoat API documentation.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
coat::threadStud Class Reference

thread stud primitive More...

#include <CorePrimAPI.h>

Inheritance diagram for coat::threadStud:
coat::thread coat::prim

Public Member Functions

 threadStud ()
 constructor
 
threadStuddiameter (const float &d)
 set the diameter of the thread.
 
float diameter () const
 get the diameter of the thread.
 
threadStuddiameterTop (const float &d)
 get the top diameter of the thread.
 
float diameterTop () const
 get the top diameter of the thread.
 
threadStuddiameterBottom (const float &d)
 set the bottom diameter of the thread.
 
float diameterBottom () const
 get the bottom diameter of the thread.
 
threadStudlength (const float &l)
 set the stud length.
 
float length () const
 get the length of the stud.
 
float threadLength () const
 get the length of the thread.
 
threadStudenableThread (const bool &enable)
 enabled or disabled thread in the stud.
 
bool enableThread () const
 get the indicator of the enabled thread.
 
threadStudbodyType (const ThreadStudBodyType &bt)
 set the body type.
 
ThreadStudBodyType bodyType () const
 get the body type.
 
- Public Member Functions inherited from coat::thread
 thread ()
 constructor
 
threaddiameter (const float d)
 set the diameter of the thread.
 
float diameter () const
 get the diameter of the thread.
 
threadpitch (const float p)
 set the pitch of the thread.
 
float pitch () const
 set the pitch of the thread.
 
threadstub (const float &l)
 set the stub length of the thread.
 
float stub () const
 get the stub length of the thread.
 
threadheight (const float &h)
 set the height of the thread.
 
float height () const
 get the height of the thread.
 
threadturns (const int &n)
 set the number of the thread turns.
 
int turns () const
 get the number of the thread turns.
 
threadclockwise (const bool &cw)
 set the clockwise flag of the thread.
 
bool clockwise () const
 get the clockwise of the thread.
 
threadclose (const bool &b)
 set the closed thread.
 
bool close () const
 set the closed thread.
 
threadprofile (const ThreadProfile &prf)
 set the thread profile type.
 
ThreadProfile profile () const
 get the thread profile type.
 
- Public Member Functions inherited from coat::prim
 prim ()
 constructs a new prim object.
 
str class_name ()
 get the primitive class name.
 
primname (const char *s)
 set the primitive object name.
 
str name () const
 get the primitive object name.
 
void add (Volume &v)
 add the prim into scene
 
void subtract (Volume &v)
 subtract the prim from scene
 
void intersect (Volume &v)
 intersect the prim into scene
 
void merge (Volume &v, const BoolOpType op)
 merge the prim into scene
 
Mesh mesh ()
 get the mesh prim
 
primcolor (DWORD CL)
 assign the color to the primitive (in voxels)
 
primcolor (float r, float g, float b, float a)
 assign the color to the primitive (in voxels)
 
primcolor (float r, float g, float b)
 assign the color to the primitive (in voxels)
 
primcolor (const char *colorid)
 assign the color to the primitive (in voxels)
 
primgloss (float value)
 assign the gloss for the voxel primitive, it will work only if the color already assigned
 
primroughness (float value)
 assign the roughness for the voxel primitive, it will work only if the color already assigned
 
primmetal (float value)
 the metalliclty value for the voxel primitive, it will work only if the color already assigned
 
primopacity (float value)
 assign the opacity of the color over the voxel primitive. The color should be assigned before you assign the opacity, for example p.color("red").opacity(0.5)
 
primdetails (const float det_level)
 set the detail level
 
float details ()
 get the detail level
 
primtransform (const mat4 &t)
 set the transform matrix
 
mat4 transform () const
 get the transform matrix
 
primscale (float scale)
 set the scale
 
primscale (const vec3 &v)
 set the scale
 
vec3 scale () const
 get the scale
 
primtranslate (const vec3 &_pos)
 Set the primitive translation.
 
vec3 translate () const
 get the primitive translation
 
primtranslate (float x, float y, float z)
 Set the primitive translation.
 
primx (float x)
 shift the primitive along the x - axis
 
primy (float y)
 shift the primitive along the y - axis
 
primz (float z)
 shift the primitive along the z - axis
 
primauto_divide (float average_div)
 set the auto devide
 
primstep_divide (float step)
 set the step devide
 
primfillet (float radius)
 set the fillet
 
template<typename T >
T & Obj ()
 Get the primitive object reference.
 
template<typename T >
bool isAs ()
 Check the prim's type.
 
virtual float fillet_relative ()
 calculates a fillet relative value (0..1).
 

Protected Member Functions

virtual cMeshContainer * create_mesh ()
 creates a mesh container for the thread stud.
 
virtual cMeshContainer * create_mesh ()
 creates a mesh container for the thread.
 
- Protected Member Functions inherited from coat::prim
template<class T >
T & to_cast_this ()
 cast this prim to the obj type T
 
virtual cMeshContainer * create_mesh ()
 abstract method to create a mesh container.
 
void merge_debug (Volume &vol, Mesh &mesh)
 merge the mesh debug into scene
 

Additional Inherited Members

- Static Public Member Functions inherited from coat::prim
static void debug_on (bool isOn=true)
 indicates whether to turn on or off the debug mode.
 
static void debug_clear ()
 clear the debug info for primitive operations
 
static void push_transform (const mat4 &t)
 set the global transform matrix to all primitives
 
static void push_translate (const vec3 &d)
 Set the translation to all primitives.
 
static void push_scale (float scale)
 Set the scale to all primitives.
 
static void push_scale (const vec3 &s)
 Set the scale to all primitives.
 
static void push_details (float details_modulator)
 set the detail level to all primitives
 
static void reset_transform ()
 reset the global transform matrix
 
- Protected Attributes inherited from coat::prim
prim_this
 

Detailed Description

thread stud primitive

Examples
bolt_binary.cpp, and threadStud.cpp.

Member Function Documentation

◆ bodyType() [1/2]

ThreadStudBodyType coat::threadStud::bodyType ( ) const

get the body type.

Returns
type value

◆ bodyType() [2/2]

threadStud & coat::threadStud::bodyType ( const ThreadStudBodyType bt)

set the body type.

Parameters
btbody type
Returns
thread stud reference
Examples
threadStud.cpp.

◆ create_mesh()

virtual cMeshContainer * coat::threadStud::create_mesh ( )
protectedvirtual

creates a mesh container for the thread stud.

Returns
mesh pointer

Reimplemented from coat::thread.

◆ diameter() [1/2]

float coat::threadStud::diameter ( ) const

get the diameter of the thread.

Returns
diameter value

◆ diameter() [2/2]

threadStud & coat::threadStud::diameter ( const float &  d)

set the diameter of the thread.

Parameters
ddiameter value
Returns
thread stud reference
Examples
bolt_binary.cpp.

◆ diameterBottom() [1/2]

float coat::threadStud::diameterBottom ( ) const

get the bottom diameter of the thread.

Returns
diameter value

◆ diameterBottom() [2/2]

threadStud & coat::threadStud::diameterBottom ( const float &  d)

set the bottom diameter of the thread.

Parameters
ddiameter value
Returns
thread stud reference
Examples
threadStud.cpp.

◆ diameterTop() [1/2]

float coat::threadStud::diameterTop ( ) const

get the top diameter of the thread.

Returns
diameter value

◆ diameterTop() [2/2]

threadStud & coat::threadStud::diameterTop ( const float &  d)

get the top diameter of the thread.

Parameters
ddiameter value
Returns
thread stud reference

◆ enableThread() [1/2]

bool coat::threadStud::enableThread ( ) const

get the indicator of the enabled thread.

Returns
enabled/disabled value

◆ enableThread() [2/2]

threadStud & coat::threadStud::enableThread ( const bool &  enable)

enabled or disabled thread in the stud.

Parameters
bEnableIndicates whether to enable or disable the thread. If this parameter is true, the thread is enabled. If the parameter is false, the thread is disabled.
Returns
thread stud reference

◆ length() [1/2]

float coat::threadStud::length ( ) const

get the length of the stud.

Returns
length value

◆ length() [2/2]

threadStud & coat::threadStud::length ( const float &  l)

set the stud length.

Parameters
llength value
Returns
thread stud reference
Examples
bolt_binary.cpp, and threadStud.cpp.

◆ threadLength()

float coat::threadStud::threadLength ( ) const

get the length of the thread.

Returns
length value

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