coat::thread Class Reference

thread primitive More...

#include <CorePrimAPI.h>

Inheritance diagram for coat::thread:

Public Member Functions
	thread ()
	constructor
thread &	diameter (const float d)
	set the diameter of the thread.
float	diameter () const
	get the diameter of the thread.
thread &	pitch (const float p)
	set the pitch of the thread.
float	pitch () const
	set the pitch of the thread.
thread &	stub (const float &l)
	set the stub length of the thread.
float	stub () const
	get the stub length of the thread.
thread &	height (const float &h)
	set the height of the thread.
float	height () const
	get the height of the thread.
thread &	turns (const int &n)
	set the number of the thread turns.
int	turns () const
	get the number of the thread turns.
thread &	clockwise (const bool &cw)
	set the clockwise flag of the thread.
bool	clockwise () const
	get the clockwise of the thread.
thread &	close (const bool &b)
	set the closed thread.
bool	close () const
	set the closed thread.
thread &	profile (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.
prim &	name (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
prim &	color (DWORD CL)
	assign the color to the primitive (in voxels)
prim &	color (float r, float g, float b, float a)
	assign the color to the primitive (in voxels)
prim &	color (float r, float g, float b)
	assign the color to the primitive (in voxels)
prim &	color (const char *colorid)
	assign the color to the primitive (in voxels)
prim &	gloss (float value)
	assign the gloss for the voxel primitive, it will work only if the color already assigned
prim &	roughness (float value)
	assign the roughness for the voxel primitive, it will work only if the color already assigned
prim &	metal (float value)
	the metalliclty value for the voxel primitive, it will work only if the color already assigned
prim &	opacity (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)
prim &	details (const float det_level)
	set the detail level
float	details ()
	get the detail level
prim &	transform (const mat4 &t)
	set the transform matrix
mat4	transform () const
	get the transform matrix
prim &	scale (float scale)
	set the scale
prim &	scale (const vec3 &v)
	set the scale
vec3	scale () const
	get the scale
prim &	translate (const vec3 &_pos)
	Set the primitive translation.
vec3	translate () const
	get the primitive translation
prim &	translate (float x, float y, float z)
	Set the primitive translation.
prim &	x (float x)
	shift the primitive along the x - axis
prim &	y (float y)
	shift the primitive along the y - axis
prim &	z (float z)
	shift the primitive along the z - axis
prim &	auto_divide (float average_div)
	set the auto devide
prim &	step_divide (float step)
	set the step devide
prim &	fillet (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.
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

Friends
class	threadStud

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 primitive

Examples

thread.cpp.

Member Function Documentation

clockwise() [1/2]

bool coat::thread::clockwise

(

)

const

get the clockwise of the thread.

Returns

clockwise flag

clockwise() [2/2]

thread & coat::thread::clockwise

(

const bool &

cw

)

set the clockwise flag of the thread.

Parameters

cw	if value is true then thread direction is clockwise

Returns

thread reference

Examples

thread.cpp, and threadStud.cpp.

close() [1/2]

bool coat::thread::close

(

)

const

set the closed thread.

Returns

closed flag

close() [2/2]

thread & coat::thread::close

(

const bool &

b

)

set the closed thread.

Parameters

b	closed value

Returns

thread reference

create_mesh()

virtual cMeshContainer * coat::thread::create_mesh ( )

protectedvirtual

creates a mesh container for the thread.

Returns

mesh pointer

Reimplemented from coat::prim.

Reimplemented in coat::threadStud.

diameter() [1/2]

float coat::thread::diameter

(

)

const

get the diameter of the thread.

Returns

thread diameter

diameter() [2/2]

thread & coat::thread::diameter

(

const float

d

)

set the diameter of the thread.

Parameters

d	diameter value

Returns

thread reference

Examples

thread.cpp.

height() [1/2]

float coat::thread::height

(

)

const

get the height of the thread.

Returns

height value

height() [2/2]

thread & coat::thread::height

(

const float &

h

)

set the height of the thread.

Parameters

h	height value

Returns

thread reference

pitch() [1/2]

float coat::thread::pitch

(

)

const

set the pitch of the thread.

Returns

pitch value

pitch() [2/2]

thread & coat::thread::pitch

(

const float

p

)

set the pitch of the thread.

Parameters

p	pitch value

Returns

thread reference

Examples

bolt_binary.cpp, thread.cpp, and threadStud.cpp.

profile() [1/2]

ThreadProfile coat::thread::profile

(

)

const

get the thread profile type.

Returns

profile type

profile() [2/2]

thread & coat::thread::profile

(

const ThreadProfile &

prf

)

set the thread profile type.

Parameters

prf	profile type

Returns

thread reference

Examples

bolt_binary.cpp, thread.cpp, and threadStud.cpp.

stub() [1/2]

float coat::thread::stub

(

)

const

get the stub length of the thread.

Returns

stub length value

stub() [2/2]

thread & coat::thread::stub

(

const float &

l

)

set the stub length of the thread.

Parameters

l	stub length value

Returns

thread reference

turns() [1/2]

int coat::thread::turns

(

)

const

get the number of the thread turns.

Returns

turns count

turns() [2/2]

thread & coat::thread::turns

(

const int &

n

)

set the number of the thread turns.

Parameters

n	turns count

Returns

thread reference

Examples

bolt_binary.cpp, thread.cpp, and threadStud.cpp.

---

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

• include/CorePrimAPI.h