Create3DText Class Reference

a 3D text object. More...

Inheritance diagram for Create3DText:

Public Member Functions
	Create3DText (string text, float x=0, float y=0, float z=0, float width=-1, float height=-1)
	create a 3D text object. More...
mesh	setText (string text)
	sets the 3D text. More...
string	getText ()
	gets the 3D text. More...
mesh	setFont (string fontPath)
	sets the font. More...
string	getFont ()
	gets the font. More...
Public Member Functions inherited from mesh
mesh	addMesh (mesh *m)
	add a child mesh. More...
mesh	getParent ()
	get the parent mesh. More...
string	getType ()
	get the type of this mesh. More...
mesh	setPosition (float X, float Y, float Z)
	sets the position of the mesh. More...
multiReturn< float, float, float >	getPosition ()
	gets the position of the mesh. More...
mesh	moveForward (float speed=1, float xRotation=0, float yRotation=0, float zRotation=0)
	moves the mesh forward or toward a direction. More...
mesh	setX (float X)
	sets the X axis of the mesh. More...
mesh	setY (float Y)
	sets the Y axis of the mesh. More...
mesh	setZ (float Z)
	sets the Z axis of the mesh. More...
float	getX ()
	gets the X axis of the mesh. More...
float	getY ()
	gets the Y axis of the mesh. More...
float	getZ ()
	gets the Z axis of the mesh. More...
mesh	setRotation (float Rx, float Ry, float Rz)
	sets the X, Y, and Z rotation of the mesh. More...
multiReturn< float, float, float >	getRotation ()
	gets the rotation of the mesh. More...
mesh	setRx (float Rx)
	sets the X rotation of the mesh. More...
mesh	setRy (float Ry)
	sets the Y rotation of the mesh. More...
mesh	setRz (float Rz)
	sets the Z rotation of the mesh. More...
float	getRx ()
	gets the X rotational axis of the mesh. More...
float	getRy ()
	gets the Y rotational axis of the mesh. More...
float	getRy ()
	gets the Y rotational axis of the mesh. More...
mesh	hide ()
	hide the mesh. More...
mesh	show ()
	shows the mesh. More...
mesh	setVisible (bool visible=true)
	sets the visibility of the mesh. More...
bool	isVisible ()
	gets the visibility of the mesh. More...
mesh	setLighting (bool lit=true)
	sets whether the mesh is fully lit or needs a light source. More...
mesh	setZBuffer (bool ZBuffer=true)
	sets whether the mesh has a ZBuffer or not. More...
mesh	setScale (float X=-1, float Y=-1, float Z=-1)
	sets the X, Y, and Z scale. More...
multiReturn< float, float, float >	getScale ()
	gets the X, Y and Z scale. More...
mesh	setColor (int r, int g, int b, int a=255)
	sets the color of the mesh. More...
mesh	remove ()
	removes the mesh. More...
mesh	setProperty (string property, string value)
	sets a property of the mesh. More...
string	getProperty (string property)
	gets the value of a set property. More...
string[]	getProperties ()
	gets all properties from the object. More...
mesh	removeProperty (string property)
	removes a property from the object. More...
mesh	clearProperties ()
	removes all properties from the object. See removeProperty() More...
mesh	doCommands (string cmd)
	creates the mesh from an object like a server command. More...
mesh[]	getChildren ()
	gets a list of added children. More...
string	getObject (bool includeChildren=true)
	get the mesh as a total object. More...
mesh	sendToClients (bool removeOthers=false, string key="", string keyAns="")
	sends the mesh to all connected clients who meet the criteria. More...
mesh	removeFromClients ()
	removes the mesh from all online clients. More...
bool	setID (string ID)
	set the ID of the mesh. More...
string	getID ()
	get the ID of the mesh. More...

Detailed Description

a 3D text object.

Constructor & Destructor Documentation

Create3DText()

Create3DText::Create3DText	(	string	text,
		float	x = 0,
		float	y = 0,
		float	z = 0,
		float	width = -1,
		float	height = -1
	)

create a 3D text object.

   Create a 3D text object using the default font.\n
   Derives all mesh functions.

Parameters

The	text to be displayed.
(optional)	The X axis of the text.
(optional)	The Y (up/down) axis of the text.
(optional)	The Z axis of the text.
(optional)	The width of the text. By default, the width of the text by font.
(optional)	The height of the text. By default, the height of the text by font.

Member Function Documentation

getFont()

string Create3DText::getFont

(

)

gets the font.

Returns

The file path of the font.

getText()

string Create3DText::getText

(

)

gets the 3D text.

Returns

The displayed 3D text.

setFont()

mesh Create3DText::setFont

(

string

fontPath

)

sets the font.

Parameters

The	file path of the font.

Returns

Returns itself.

setText()

mesh Create3DText::setText

(

string

text

)

sets the 3D text.

Parameters

The	3D text to be displayed.

Returns

Returns itself.