psEffectObjText2D Class Reference

#include <pseffectobjtext2d.h>

List of all members.

Public Member Functions
bool	AttachToAnchor (psEffectAnchor *newAnchor)
	Attaches this mesh to the given effect anchor.
psEffectObj *	Clone () const
	Clones the effect object.
bool	Load (iDocumentNode *node, iLoaderContext *ldr_context)
	Loads the effect object from an xml node.
	psEffectObjText2D (iView *parentView, psEffect2DRenderer *renderer2d)
bool	Render (const csVector3 &up)
	Renders the effect.
bool	SetText (const csArray< psEffectTextRow > &rows)
bool	SetText (int rows,...)
bool	SetText (const csArray< psEffectTextElement > &elements)
bool	Update (csTicks elapsed)
	Updates the spell effect -- called every frame.
	~psEffectObjText2D ()
Protected Member Functions
void	DrawTextElement (const psEffectTextElement &element)
bool	PostSetup ()

---

Detailed Description

Definition at line 69 of file pseffectobjtext2d.h.

---

Constructor & Destructor Documentation

psEffectObjText2D::psEffectObjText2D	(	iView *	parentView,
		psEffect2DRenderer *	renderer2d
	)

psEffectObjText2D::~psEffectObjText2D

(

)

---

Member Function Documentation

bool psEffectObjText2D::AttachToAnchor

(

psEffectAnchor *

newAnchor

)

[virtual]

Attaches this mesh to the given effect anchor.

Parameters:

newAnchor

The effect anchor to attach this mesh to.

Returns:

true If it attached properly, false otherwise.

Reimplemented from psEffectObj.

psEffectObj* psEffectObjText2D::Clone

(

)

const [virtual]

Clones the effect object.

This will almost always be overloaded.

Reimplemented from psEffectObj.

void psEffectObjText2D::DrawTextElement

(

const psEffectTextElement &

element

)

[protected]

bool psEffectObjText2D::Load	(	iDocumentNode *	node,
		iLoaderContext *	ldr_context
	)		[virtual]

Loads the effect object from an xml node.

Parameters:

node	the xml node containing the effect object, must be valid
ldr_context	the current loader context.

Returns:

true on success, false otherwise

Reimplemented from psEffectObj.

bool psEffectObjText2D::PostSetup

(

)

[protected]

bool psEffectObjText2D::Render

(

const csVector3 &

up

)

[virtual]

Renders the effect.

Parameters:

up	the base up vector of the effect obj

Returns:

true on success

Reimplemented from psEffectObj.

bool psEffectObjText2D::SetText

(

const csArray< psEffectTextElement > &

elements

)

[virtual]

Implements psEffectObjTextable.

bool psEffectObjText2D::SetText	(	int	rows,
			...
	)		[virtual]

Implements psEffectObjTextable.

bool psEffectObjText2D::SetText

(

const csArray< psEffectTextRow > &

rows

)

[virtual]

Implements psEffectObjTextable.

bool psEffectObjText2D::Update

(

csTicks

elapsed

)

[virtual]

Updates the spell effect -- called every frame.

Parameters:

elapsed

the ticks elapsed since last update

Returns:

false if the obj is useless and can be removed

Reimplemented from psEffectObj.

---

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

• common/effects/pseffectobjtext2d.h