psEffectObjText Class Reference

#include <pseffectobjtext.h>

List of all members.

Public Member Functions
psEffectObj *	Clone () const
	Clones the effect object.
bool	Load (iDocumentNode *node, iLoaderContext *ldr_context)
	Loads the effect object from an xml node.
	psEffectObjText (iView *parentView, psEffect2DRenderer *renderer2d)
virtual bool	SetText (int rows,...)
virtual bool	SetText (const csArray< psEffectTextRow > &rows)
virtual bool	SetText (const csArray< psEffectTextElement > &elements)
	Creates a material that will fit an array of text elements and draws those elements.
	~psEffectObjText ()
Protected Member Functions
void	DrawTextElement (const psEffectTextElement &element)
bool	PostSetup ()
	performs the post setup (after the effect obj has been loaded).
int	ToPowerOf2 (int n)

---

Detailed Description

Definition at line 41 of file pseffectobjtext.h.

---

Constructor & Destructor Documentation

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

psEffectObjText::~psEffectObjText

(

)

---

Member Function Documentation

psEffectObj* psEffectObjText::Clone

(

)

const [virtual]

Clones the effect object.

This will almost always be overloaded.

Reimplemented from psEffectObjQuad.

void psEffectObjText::DrawTextElement

(

const psEffectTextElement &

element

)

[protected]

bool psEffectObjText::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 psEffectObjQuad.

bool psEffectObjText::PostSetup

(

)

[protected, virtual]

performs the post setup (after the effect obj has been loaded).

Things like create mesh factory, etc are initialized here.

Reimplemented from psEffectObjQuad.

virtual bool psEffectObjText::SetText

(

const csArray< psEffectTextElement > &

elements

)

[virtual]

Creates a material that will fit an array of text elements and draws those elements.

Implements psEffectObjTextable.

virtual bool psEffectObjText::SetText

(

const csArray< psEffectTextRow > &

rows

)

[virtual]

Implements psEffectObjTextable.

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

Implements psEffectObjTextable.

int psEffectObjText::ToPowerOf2

(

int

n

)

[inline, protected]

Definition at line 86 of file pseffectobjtext.h.

---

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

• common/effects/pseffectobjtext.h