coat::freeform Class Reference

freeform primitive More...

#include <CorePrimAPI.h>

Inheritance diagram for coat::freeform:

Classes
struct	ffElement
struct	ffInfo

Public Types
typedef list< vec3 >	Points3D
typedef list< ffElement >	ffObjsList

Public Member Functions
	freeform ()
	constructor
	freeform (const char *_ffname, const char *_ffsubname)
	constructor
	~freeform ()
	destructor
freeform &	symx (const bool &x)
	Enable the XYZ-mirror symmetry.
freeform &	symy (const bool &y)
	Enable the XYZ-mirror symmetry.
freeform &	symz (const bool &z)
	Enable the XYZ-mirror symmetry.
freeform &	size (float x, float y, float z)
	set the free form size
freeform &	size (const vec3 &v)
	set the free form size
freeform &	ffname (const char *name)
	set the free form name.
const char *	ffname () const
	get the free form name.
freeform &	ffsubname (const char *name)
	set the free form sub name.
const char *	ffsubname () const
	get the free form sub name.
freeform &	SetPoint (int i, const vec3 &point)
	set the knot point of the primitive.
int	CountPoints () const
	get the account of the knot points
void	ResetPoints ()
	reset the knot points
list< str > *	ffSubNamesList ()
	get the sub names for current free form name.
list< str > *	ffSubNamesList (const str &ffName)
	get the sub names for specified free form name.
ffObjsList &	objsList ()
	gets the object's list.
Points3D &	ffControlPoints ()
	get the knot(control) points of the primitive.
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

freeform primitive

Examples

ffBlob.cpp, ffCube.cpp, and ffCylinder.cpp.

Constructor & Destructor Documentation

freeform()

coat::freeform::freeform	(	const char *	_ffname,
		const char *	_ffsubname )

constructor

Parameters

_ffname	free form name
_ffsubname	free form subname

Member Function Documentation

CountPoints()

int coat::freeform::CountPoints

(

)

const

get the account of the knot points

Returns

count of points

Examples

ffCube.cpp, and ffCylinder.cpp.

create_mesh()

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

protectedvirtual

creates a mesh container for the screw.

Returns

mesh pointer

Reimplemented from coat::prim.

ffControlPoints()

Points3D & coat::freeform::ffControlPoints

(

)

get the knot(control) points of the primitive.

Returns

the points reference

Examples

ffCube.cpp, and ffCylinder.cpp.

ffname() [1/2]

const char * coat::freeform::ffname

(

)

const

get the free form name.

Returns

the name

ffname() [2/2]

freeform & coat::freeform::ffname

(

const char *

name

)

set the free form name.

set of names {"Cube","Patch,"Blob","Round","Ring",Torus","Tube2","Tube3","Disc","Cylinder"}

Parameters

name	the name string

Returns

the freeform reference

ffsubname() [1/2]

const char * coat::freeform::ffsubname

(

)

const

get the free form sub name.

Returns

the name

ffsubname() [2/2]

freeform & coat::freeform::ffsubname

(

const char *

name

)

set the free form sub name.

Parameters

name	the name string

Returns

the freeform reference

Examples

ffCylinder.cpp.

ffSubNamesList() [1/2]

list< str > * coat::freeform::ffSubNamesList

(

)

get the sub names for current free form name.

Parameters

ffName

free form name

Returns

the pointer to list string of sub names

Examples

ffBlob.cpp.

ffSubNamesList() [2/2]

list< str > * coat::freeform::ffSubNamesList

(

const str &

ffName

)

get the sub names for specified free form name.

Parameters

ffName

free form name

Returns

the pointer to list string of sub names

objsList()

ffObjsList & coat::freeform::objsList

(

)

gets the object's list.

Returns

objs list reference

SetPoint()

freeform & coat::freeform::SetPoint	(	int	i,
		const vec3 &	point )

set the knot point of the primitive.

Parameters

i	point index
point	the coordinates of the point

Returns

the freeform reference

Examples

ffCube.cpp, and ffCylinder.cpp.

size() [1/2]

freeform & coat::freeform::size

(

const vec3 &

v

)

set the free form size

Parameters

v	vector size

Returns

freeform reference

size() [2/2]

freeform & coat::freeform::size	(	float	x,
		float	y,
		float	z )

set the free form size

Parameters

x	size in the x - axis
y	size in the y - axis
z	size in the z - axis

Returns

freeform reference

Examples

ffBlob.cpp.

symx()

freeform & coat::freeform::symx

(

const bool &

x

)

Enable the XYZ-mirror symmetry.

Parameters

x	true to enable x-symmetry, false to disable

Returns

freeform reference

symy()

freeform & coat::freeform::symy

(

const bool &

y

)

Enable the XYZ-mirror symmetry.

Parameters

y	true to enable y-symmetry, false to disable

Returns

freeform reference

symz()

freeform & coat::freeform::symz

(

const bool &

z

)

Enable the XYZ-mirror symmetry.

Parameters

z	true to enable z-symmetry, false to disable

Returns

freeform reference

---

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

• include/CorePrimAPI.h