coat::screw Class Reference

screw primitive More...

#include <CorePrimAPI.h>

Inheritance diagram for coat::screw:

Classes
struct	Info
	Holds the general information about bolt parameters. More...

Public Member Functions
	screw ()
	constructor.
screw &	head (const boltHead &_h)
	set the bolt head object.
const boltHead &	head () const
	get the bolt head object.
screw &	diameter (const float &_d)
	set the screw diameter.
float	diameter ()
	get the screw diameter.
screw &	pitch (const float &_p)
	set the screw thread step(pitch).
float	pitch ()
	get the screw thread step(pitch).
screw &	threadDiameter (const float &_d)
	set the thread diameter.
float	threadDiameter ()
	get the thread diameter.
screw &	threadHeight (const float &_h)
	set the screw thread height.
float	threadHeight ()
	get the screw thread height.
screw &	threadLength (const float &_l)
	set the screw thread length.
float	threadLength ()
	get the screw thread length.
screw &	length (const float &_l)
	set the screw length.
float	length ()
	get the screw length.
screw &	underhead (const int &_uh)
	set the underhead type.
int	underhead ()
	get the underhead type.
screw &	uwidth (const int &_uw)
	set the underhead width.
float	uwidth ()
	get the underhead width.
screw &	uheight (const int &_uh)
	set the underhead height.
float	uheight ()
	get the underhead height.
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 screw.
Protected Member Functions inherited from coat::prim
template<class T >
T &	to_cast_this ()
	cast this prim to the obj type T
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

screw primitive

Examples

screw.cpp.

Member Function Documentation

create_mesh()

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

protectedvirtual

creates a mesh container for the screw.

Returns

mesh pointer

Reimplemented from coat::prim.

diameter() [1/2]

float coat::screw::diameter

(

)

get the screw diameter.

Returns

diameter

diameter() [2/2]

screw & coat::screw::diameter

(

const float &

_d

)

set the screw diameter.

Parameters

_d

diameter

Returns

screw reference

Examples

screw.cpp.

head() [1/2]

const boltHead & coat::screw::head

(

)

const

get the bolt head object.

Returns

bolt head obj reference

head() [2/2]

screw & coat::screw::head

(

const boltHead &

_h

)

set the bolt head object.

Parameters

_h	bolt head obj reference

Returns

screw reference

Examples

screw.cpp.

length() [1/2]

float coat::screw::length

(

)

get the screw length.

Returns

length

length() [2/2]

screw & coat::screw::length

(

const float &

_l

)

set the screw length.

Parameters

_l

length

Returns

screw reference

Examples

screw.cpp.

pitch() [1/2]

float coat::screw::pitch

(

)

get the screw thread step(pitch).

Returns

step value

pitch() [2/2]

screw & coat::screw::pitch

(

const float &

_p

)

set the screw thread step(pitch).

Parameters

_p

step

Returns

screw reference

Examples

screw.cpp.

threadDiameter() [1/2]

float coat::screw::threadDiameter

(

)

get the thread diameter.

Returns

diameter

threadDiameter() [2/2]

screw & coat::screw::threadDiameter

(

const float &

_d

)

set the thread diameter.

Parameters

_d

diameter

Returns

screw reference

Examples

screw.cpp.

threadHeight() [1/2]

float coat::screw::threadHeight

(

)

get the screw thread height.

Returns

thread height value

threadHeight() [2/2]

screw & coat::screw::threadHeight

(

const float &

_h

)

set the screw thread height.

Parameters

_h

height

Returns

screw reference

threadLength() [1/2]

float coat::screw::threadLength

(

)

get the screw thread length.

Returns

length value

threadLength() [2/2]

screw & coat::screw::threadLength

(

const float &

_l

)

set the screw thread length.

Parameters

_l

length

Returns

screw reference

Examples

screw.cpp.

uheight() [1/2]

float coat::screw::uheight

(

)

get the underhead height.

Returns

height value

uheight() [2/2]

screw & coat::screw::uheight

(

const int &

_uh

)

set the underhead height.

Parameters

_uh

height

Returns

screw reference

underhead() [1/2]

int coat::screw::underhead

(

)

get the underhead type.

Returns

type value

underhead() [2/2]

screw & coat::screw::underhead

(

const int &

_uh

)

set the underhead type.

Parameters

_uh	type (0-cylinder,1-rect)

Returns

screw reference

uwidth() [1/2]

float coat::screw::uwidth

(

)

get the underhead width.

Returns

width value

uwidth() [2/2]

screw & coat::screw::uwidth

(

const int &

_uw

)

set the underhead width.

Parameters

_uw

width

Returns

screw reference

---

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

• include/CorePrimAPI.h