coat::text Class Reference

text primitive More...

#include <CorePrimAPI.h>

Inheritance diagram for coat::text:

Public Member Functions
	text ()
	constructs a new text object.
	text (const char *s)
	constructs a new text object.
text &	string (const char *s)
	set the text's string.
str	string () const
	get the text's string.
text &	font (const Font &f)
	set the text font
Font	font () const
	get the font object
text &	width (const float &w)
	set the text width in the pixels
float	width () const
	get the text width
text &	depth (const float &d)
	set the text depth in the pixels
float	depth () const
	get the text depth
text &	bendRadius (const float &radius)
	set the bend radius.
float	bendRadius () const
	get the bend radius.
text &	extraRotation (const float &rotation)
	set the rotate angle around the x-axis.
float	extraRotation () const
	get the rotate angle around the x-axis.
text &	invertBending (const bool &_binvert)
	set the invert of the text bending.
float	invertBending () const
	get the invert of the text bending.
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 text.
void	update_mesh (cMeshContainer *mc)
	update the mesh container for the text.
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

text primitive

Examples

Dumbbell.cpp, HelloWorld3D.cpp, and TreesGenerator.cpp.

Constructor & Destructor Documentation

text()

coat::text::text

(

const char *

s

)

constructs a new text object.

Parameters

s	the input text's string

Member Function Documentation

bendRadius() [1/2]

float coat::text::bendRadius

(

)

const

get the bend radius.

Returns

the bend radius of the text

bendRadius() [2/2]

text & coat::text::bendRadius

(

const float &

radius

)

set the bend radius.

Parameters

radius

bend radius of the text

Returns

the text reference

create_mesh()

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

protectedvirtual

creates a mesh container for the text.

Returns

mesh pointer

Reimplemented from coat::prim.

Reimplemented in coat::image.

depth() [1/2]

float coat::text::depth

(

)

const

get the text depth

Returns

the depth value

depth() [2/2]

text & coat::text::depth

(

const float &

d

)

set the text depth in the pixels

Parameters

d

depth

Returns

the text reference

Examples

Dumbbell.cpp, HelloWorld3D.cpp, and Logo3D.cpp.

extraRotation() [1/2]

float coat::text::extraRotation

(

)

const

get the rotate angle around the x-axis.

Returns

the rotate angle

extraRotation() [2/2]

text & coat::text::extraRotation

(

const float &

rotation

)

set the rotate angle around the x-axis.

Parameters

radius

bend radius of the text

Returns

the text reference

font() [1/2]

Font coat::text::font

(

)

const

get the font object

Returns

font object

font() [2/2]

text & coat::text::font

(

const Font &

f

)

set the text font

Parameters

f	font object

Returns

the text reference

Examples

Dumbbell.cpp, and HelloWorld3D.cpp.

invertBending() [1/2]

float coat::text::invertBending

(

)

const

get the invert of the text bending.

Returns

the invert bending

invertBending() [2/2]

text & coat::text::invertBending

(

const bool &

_binvert

)

set the invert of the text bending.

Parameters

binvert

boolean value true/false

Returns

the text reference

string() [1/2]

str coat::text::string

(

)

const

get the text's string.

Returns

the string

string() [2/2]

text & coat::text::string

(

const char *

s

)

set the text's string.

Parameters

s	the string

Examples

Dumbbell.cpp, and HelloWorld3D.cpp.

update_mesh()

void coat::text::update_mesh ( cMeshContainer * mc )

protected

update the mesh container for the text.

Parameters

mc	mesh pointer

width() [1/2]

float coat::text::width

(

)

const

get the text width

Returns

the width value

width() [2/2]

text & coat::text::width

(

const float &

w

)

set the text width in the pixels

Parameters

w

width

Returns

the text reference

Examples

Dumbbell.cpp, HelloWorld3D.cpp, and Logo3D.cpp.

---

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

• include/CorePrimAPI.h