Tes::Handlers::Shape2D::Text2DHandler Class Reference

Handles 2D text. More...

Inheritance diagram for Tes::Handlers::Shape2D::Text2DHandler:

List of all members.

Classes
class	Text2DManager
	Manages text rendering. More...
class	TextEntry
	Tracks a text object. More...
Public Member Functions
	Text2DHandler (CategoryCheckDelegate categoryCheck)
	Create a new handler.
override void	BeginFrame (uint frameNumber, bool maintainTransient)
	Start the frame by flushing transient objects.
override void	Initialise (GameObject root, GameObject serverRoot, MaterialLibrary materials)
	Initialise.
override Error	ReadMessage (PacketBuffer packet, BinaryReader reader)
	Message handler.
override void	Reset ()
	Reset, clearing all text objects.
override Error	Serialise (BinaryWriter writer, ref SerialiseInfo info)
	Serialisation.
override void	OnCategoryChange (ushort categoryId, bool active)
	Handle category activation changes.
Protected Member Functions
virtual Error	HandleMessage (CreateMessage msg, PacketBuffer packet, BinaryReader reader)
	Handle create messages.
virtual Error	HandleMessage (UpdateMessage msg, PacketBuffer packet, BinaryReader reader)
	Handle update messages.
virtual Error	HandleMessage (DestroyMessage msg, PacketBuffer packet, BinaryReader reader)
	Handle destroy messages.
Properties
GameObject	Root [get, set]
	Root object implementation (irrelevant).
GameObject	Persistent [get, set]
	Persistent object root (irrelevant).
GameObject	Transient [get, set]
	Transient object root (irrelevant).
Text2DManager	PersistentText [get]
	Persistent text manager object.
Text2DManager	TransientText [get]
	Transient text manager object.
override string	Name [get]
	Handler name.
override ushort	RoutingID [get]
	ShapeID.Text2D

---

Detailed Description

Handles 2D text.

May be located in screen space, or 3D and projected into screen space.

---

Constructor & Destructor Documentation

Tes::Handlers::Shape2D::Text2DHandler::Text2DHandler

(

CategoryCheckDelegate

categoryCheck

)

[inline]

Create a new handler.

Parameters:

categoryCheck

---

Member Function Documentation

override void Tes::Handlers::Shape2D::Text2DHandler::BeginFrame	(	uint	frameNumber,
		bool	maintainTransient
	)		[inline, virtual]

Start the frame by flushing transient objects.

Parameters:

frameNumber	A monotonic frame number.
maintainTransient	True to disable transient flush.

Reimplemented from Tes::Runtime::MessageHandler.

virtual Error Tes::Handlers::Shape2D::Text2DHandler::HandleMessage	(	UpdateMessage	msg,
		PacketBuffer	packet,
		BinaryReader	reader
	)		[inline, protected, virtual]

Handle update messages.

Parameters:

msg
packet
reader

Returns:

virtual Error Tes::Handlers::Shape2D::Text2DHandler::HandleMessage	(	DestroyMessage	msg,
		PacketBuffer	packet,
		BinaryReader	reader
	)		[inline, protected, virtual]

Handle destroy messages.

Parameters:

msg
packet
reader

Returns:

virtual Error Tes::Handlers::Shape2D::Text2DHandler::HandleMessage	(	CreateMessage	msg,
		PacketBuffer	packet,
		BinaryReader	reader
	)		[inline, protected, virtual]

Handle create messages.

Parameters:

msg
packet
reader

Returns:

override void Tes::Handlers::Shape2D::Text2DHandler::Initialise	(	GameObject	root,
		GameObject	serverRoot,
		MaterialLibrary	materials
	)		[inline, virtual]

Initialise.

Parameters:

root
serverRoot
materials

Reimplemented from Tes::Runtime::MessageHandler.

override void Tes::Handlers::Shape2D::Text2DHandler::OnCategoryChange	(	ushort	categoryId,
		bool	active
	)		[inline, virtual]

Handle category activation changes.

Parameters:

categoryId
active

Implements Tes::Runtime::MessageHandler.

override Error Tes::Handlers::Shape2D::Text2DHandler::ReadMessage	(	PacketBuffer	packet,
		BinaryReader	reader
	)		[inline, virtual]

Message handler.

Parameters:

packet
reader

Returns:

Implements Tes::Runtime::MessageHandler.

override Error Tes::Handlers::Shape2D::Text2DHandler::Serialise	(	BinaryWriter	writer,
		ref SerialiseInfo	info
	)		[inline, virtual]

Serialisation.

Parameters:

writer
info	Statistics

Returns:

Implements Tes::Runtime::MessageHandler.

---

Property Documentation

override ushort Tes::Handlers::Shape2D::Text2DHandler::RoutingID [get]

ShapeID.Text2D

Reimplemented from Tes::Runtime::MessageHandler.

---

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

• Text2DHandler.cs