Torque Game Engine Documentation
TGE Version 1.5.2

GuiMessageVectorCtrl Class Reference

#include <guiMessageVectorCtrl.h>

Inheritance diagram for GuiMessageVectorCtrl:

Detailed Description

Render a MessageVector (chat HUD).

This renders messages from a MessageVector; the important thing here is that the MessageVector holds all the messages we care about, while we can destroy and create these GUI controls as needed. (For instance, Tribes 2 used seperate GuiMessageVectorCtrl controls in the different HUD modes.)

Public Member Functions

GuiMessageVectorCtrl ()

~GuiMessageVectorCtrl ()

bool isAttached () const

bool attach (MessageVector *)

void detach ()

void callbackRouter (const MessageVector::MessageCode, const U32)

DECLARE_CONOBJECT (GuiMessageVectorCtrl)

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Protected Member Functions

bool onAdd ()

Called when this object is added to the scene.

void onRemove ()

Called when this object is removed.

bool onWake ()

Called when this object is asked to wake up returns true if it's actually awake at the end.

void onSleep ()

Called when this object is asked to sleep.

void onRender (Point2I offset, const RectI &updateRect)

Called when this control is to render itself.

void inspectPostApply ()

Called after any property of the object is changed in the world editor.

void parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)

Called when this objects parent is resized.

void onMouseUp (const GuiEvent &event)

void onMouseDown (const GuiEvent &event)

virtual void lineInserted (const U32)

virtual void lineDeleted (const U32)

virtual void vectorDeleted ()

void createLineWrapping (LineWrapping &, const char *)

void createSpecialMarkers (SpecialMarkers &, const char *)

void createLineElement (LineElement &, LineWrapping &, SpecialMarkers &)

void findSpecialFromCoord (const Point2I &, S32 *, S32 *)

Protected Attributes

MessageVector * mMessageVector

U32 mMinSensibleWidth

U32 mLineSpacingPixels

U32 mLineContinuationIndent

StringTableEntry mAllowedMatches [16]

ColorI mSpecialColor

U32 mMaxColorIndex

bool mMouseDown

S32 mMouseSpecialLine

S32 mMouseSpecialRef

Vector< LineWrapping > mLineWrappings

Vector< SpecialMarkers > mSpecialMarkers

Vector< LineElement > mLineElements

Private Types

typedef GuiControl Parent

Data Structures

struct LineElement

struct LineWrapping

Derived classes must keep this set of variables consistent if they use this classes onRender. More...

struct SpecialMarkers

struct TextElement

Member Typedef Documentation

typedef GuiControl GuiMessageVectorCtrl::Parent [private]

Reimplemented from GuiControl.

Constructor & Destructor Documentation

GuiMessageVectorCtrl::GuiMessageVectorCtrl ( )

GuiMessageVectorCtrl::~GuiMessageVectorCtrl ( )

Member Function Documentation

bool GuiMessageVectorCtrl::isAttached ( ) const

bool GuiMessageVectorCtrl::attach ( MessageVector * )

void GuiMessageVectorCtrl::detach ( )

bool GuiMessageVectorCtrl::onAdd ( ) [protected, virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::onRemove ( ) [protected, virtual]

Called when this object is removed.

Reimplemented from GuiControl.

bool GuiMessageVectorCtrl::onWake ( ) [protected, virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::onSleep ( ) [protected, virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[protected, virtual]`

Called when this control is to render itself.

Parameters:

	offset	The location this control is to begin rendering
	updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::inspectPostApply ( ) [protected, virtual]

Called after any property of the object is changed in the world editor.

See also:: inspectPreApply

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::parentResized	(	const Point2I &	oldParentExtent,
		const Point2I &	newParentExtent
	)			`[protected, virtual]`

Called when this objects parent is resized.

Parameters:

	oldParentExtent	The old size of the parent object
	newParentExtent	The new size of the parent object

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::onMouseUp ( const GuiEvent & event ) [protected, virtual]

Reimplemented from GuiControl.

void GuiMessageVectorCtrl::onMouseDown ( const GuiEvent & event ) [protected, virtual]

Reimplemented from GuiControl.

virtual void GuiMessageVectorCtrl::lineInserted ( const U32 ) [protected, virtual]

virtual void GuiMessageVectorCtrl::lineDeleted ( const U32 ) [protected, virtual]

virtual void GuiMessageVectorCtrl::vectorDeleted ( ) [protected, virtual]

void GuiMessageVectorCtrl::createLineWrapping	(	LineWrapping &	,
		const char *
	)			`[protected]`

void GuiMessageVectorCtrl::createSpecialMarkers	(	SpecialMarkers &	,
		const char *
	)			`[protected]`

void GuiMessageVectorCtrl::createLineElement	(	LineElement &	,
		LineWrapping &	,
		SpecialMarkers &
	)			`[protected]`

void GuiMessageVectorCtrl::findSpecialFromCoord	(	const Point2I &	,
		S32 *	,
		S32 *
	)			`[protected]`

void GuiMessageVectorCtrl::callbackRouter	(	const MessageVector::MessageCode	,
		const	U32
	)

GuiMessageVectorCtrl::DECLARE_CONOBJECT ( GuiMessageVectorCtrl )

static void GuiMessageVectorCtrl::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GuiControl.

Field Documentation

MessageVector* GuiMessageVectorCtrl::mMessageVector [protected]

U32 GuiMessageVectorCtrl::mMinSensibleWidth [protected]

U32 GuiMessageVectorCtrl::mLineSpacingPixels [protected]

U32 GuiMessageVectorCtrl::mLineContinuationIndent [protected]

StringTableEntry GuiMessageVectorCtrl::mAllowedMatches[16] [protected]

ColorI GuiMessageVectorCtrl::mSpecialColor [protected]

U32 GuiMessageVectorCtrl::mMaxColorIndex [protected]

bool GuiMessageVectorCtrl::mMouseDown [protected]

S32 GuiMessageVectorCtrl::mMouseSpecialLine [protected]

S32 GuiMessageVectorCtrl::mMouseSpecialRef [protected]

Vector<LineWrapping> GuiMessageVectorCtrl::mLineWrappings [protected]

Vector<SpecialMarkers> GuiMessageVectorCtrl::mSpecialMarkers [protected]

Vector<LineElement> GuiMessageVectorCtrl::mLineElements [protected]