psEffectObjSpire Class Reference

#include <pseffectobjspire.h>

List of all members.

Classes
struct	MeshAnimControl
Public Types
enum	SPI_SHAPE {   SPI_CIRCLE = 0, SPI_CYLINDER, SPI_ASTERIX, SPI_STAR,   SPI_LAYERED, SPI_COUNT }
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.
	psEffectObjSpire (iView *parentView, psEffect2DRenderer *renderer2d)
bool	Render (const csVector3 &up)
	Renders the effect.
bool	Update (csTicks elapsed)
	Updates the spell effect -- called every frame.
virtual	~psEffectObjSpire ()
Public Attributes
csRef< MeshAnimControl >	meshControl

---

Detailed Description

Definition at line 32 of file pseffectobjspire.h.

---

Member Enumeration Documentation

enum psEffectObjSpire::SPI_SHAPE

Enumerator:

SPI_CIRCLE
SPI_CYLINDER
SPI_ASTERIX
SPI_STAR
SPI_LAYERED
SPI_COUNT

Definition at line 113 of file pseffectobjspire.h.

---

Constructor & Destructor Documentation

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

virtual psEffectObjSpire::~psEffectObjSpire

(

)

[virtual]

---

Member Function Documentation

psEffectObj* psEffectObjSpire::Clone

(

)

const [virtual]

Clones the effect object.

This will almost always be overloaded.

Reimplemented from psEffectObj.

bool psEffectObjSpire::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 psEffectObjSpire::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 psEffectObjSpire::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.

---

Member Data Documentation

csRef<MeshAnimControl> psEffectObjSpire::meshControl

Definition at line 98 of file pseffectobjspire.h.

---

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

• common/effects/pseffectobjspire.h