Tes::Shapes::Text3D Class Reference

Defines 3D text to render in 3D coordinates. More...

Inheritance diagram for Tes::Shapes::Text3D:

List of all members.

Public Member Functions
	Text3D (string text, Vector3 pos, int fontSize=12)
	Create 3D text to render.
	Text3D (string text, uint id, Vector3 pos, int fontSize=12)
	Create 3D text to render.
	Text3D (string text, uint id, ushort category, Vector3 pos, int fontSize=12)
	Create 3D text to render.
	Text3D (string text)
	Create 3D text to render.
	Text3D (string text, uint id)
	Create 3D text to render.
	Text3D (string text, uint id, ushort category)
	Create 3D text to render.
override bool	WriteCreate (PacketBuffer packet)
	Overridden create message.
override object	Clone ()
	Clone this shape.
Static Public Attributes
static Vector3	DefaultFacing = new Vector3(0, -1, 0)
	The default text facing.
Protected Member Functions
void	OnClone (Text3D copy)
	Additional data copy on Clone().
Properties
int	FontSize [get, set]
	The size of the rendered text.
string	Text [get, set]
	The text to render.
bool	ScreenFacing [get, set]
	Does the text always face the camera? If so, the Facing is ignored.
Vector3	Facing [get, set]
	The facing for the text (can be considered a normal vector).

---

Detailed Description

Defines 3D text to render in 3D coordinates.

---

Constructor & Destructor Documentation

Tes::Shapes::Text3D::Text3D	(	string	text,
		Vector3	pos,
		int	fontSize = 12
	)		[inline]

Create 3D text to render.

Parameters:

text	The text string to display.
pos	The text 3D position.
fontSize	Text size.

Tes::Shapes::Text3D::Text3D	(	string	text,
		uint	id,
		Vector3	pos,
		int	fontSize = 12
	)		[inline]

Create 3D text to render.

Parameters:

text	The text string to display.
id	The shape ID. Zero for transient shapes.
pos	The text 3D position.
fontSize	Text size.

Tes::Shapes::Text3D::Text3D	(	string	text,
		uint	id,
		ushort	category,
		Vector3	pos,
		int	fontSize = 12
	)		[inline]

Create 3D text to render.

Parameters:

text	The text string to display.
id	The shape ID. Zero for transient shapes.
category	Category to which the shape belongs.
pos	The text 3D position.
fontSize	Text size.

Tes::Shapes::Text3D::Text3D

(

string

text

)

[inline]

Create 3D text to render.

Parameters:

text	The text string to display.

Tes::Shapes::Text3D::Text3D	(	string	text,
		uint	id
	)		[inline]

Create 3D text to render.

Parameters:

text	The text string to display.
id	The shape ID. Zero for transient shapes.

Tes::Shapes::Text3D::Text3D	(	string	text,
		uint	id,
		ushort	category
	)		[inline]

Create 3D text to render.

Parameters:

text	The text string to display.
id	The shape ID. Zero for transient shapes.
category	Category to which the shape belongs.

---

Member Function Documentation

override object Tes::Shapes::Text3D::Clone

(

)

[inline, virtual]

Clone this shape.

Returns:

A deep copy of this object.

Reimplemented from Tes::Shapes::Shape.

void Tes::Shapes::Text3D::OnClone

(

Text3D

copy

)

[inline, protected]

Additional data copy on Clone().

Parameters:

copy	The cloned object.

override bool Tes::Shapes::Text3D::WriteCreate

(

PacketBuffer

packet

)

[inline, virtual]

Overridden create message.

Includes the text written as a byte count, followed by a series of UTF-8 bytes. No null terminator is included.

Parameters:

packet

Packet to write to.

Returns:

True on success.

Reimplemented from Tes::Shapes::Shape.

---

Property Documentation

int Tes::Shapes::Text3D::FontSize [get, set]

The size of the rendered text.

The units need to be better defined.

---

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

• Text3D.cs