coat::boltHead Class Reference

bolt head primitive More...

#include <CorePrimAPI.h>

Inheritance diagram for coat::boltHead:

Public Member Functions
	boltHead ()
	constructor.
boltHead &	head (const HeadParams &_h)
	set the head object.
HeadParams &	head ()
	get the HeadParams object.
const HeadParams &	head () const
	get the const HeadParams object.
boltHead &	head (const int &_type, void *data)
	set the head object with specified type and data.
boltHead &	slit (const Slit &_s)
	set the slit object.
Slit &	slit ()
	get the slit object.
const Slit &	slit () const
	get the const slit object.
boltHead &	operator= (const boltHead &h)
	assignment operator
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 bolt head.
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

bolt head primitive

Examples

bolt_binary.cpp, bolt_rim.cpp, boltheads.cpp, and screw.cpp.

Member Function Documentation

create_mesh()

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

protectedvirtual

creates a mesh container for the bolt head.

Returns

mesh pointer

Reimplemented from coat::prim.

head() [1/4]

HeadParams & coat::boltHead::head

(

)

get the HeadParams object.

Returns

HeadParams object reference

head() [2/4]

const HeadParams & coat::boltHead::head

(

)

const

get the const HeadParams object.

Returns

HeadParams object reference

head() [3/4]

boltHead & coat::boltHead::head

(

const HeadParams &

_h

)

set the head object.

Parameters

_h	head obj reference

Returns

bolt head reference

Examples

bolt_binary.cpp, bolt_rim.cpp, boltheads.cpp, and screw.cpp.

head() [4/4]

boltHead & coat::boltHead::head	(	const int &	_type,
		void *	data
	)

set the head object with specified type and data.

Parameters

_type	head type
_data	head data

Returns

bolt head reference

slit() [1/3]

Slit & coat::boltHead::slit

(

)

get the slit object.

Returns

slit object reference

slit() [2/3]

const Slit & coat::boltHead::slit

(

)

const

get the const slit object.

Returns

slit object reference

slit() [3/3]

boltHead & coat::boltHead::slit

(

const Slit &

_s

)

set the slit object.

Parameters

_s	slit reference.

Returns

bolt head reference

Examples

boltheads.cpp, and screw.cpp.

---

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

• include/CorePrimAPI.h