Planeshift
Public Member Functions

psEffectObjParticles Class Reference

#include <pseffectobjparticles.h>

List of all members.

Public Member Functions

psEffectObjClone () const
 Clones the effect object.
bool Load (iDocumentNode *node, iLoaderContext *ldr_context)
 Loads the effect object from an xml node.
 psEffectObjParticles (iView *parentView, psEffect2DRenderer *renderer2d)
bool Render (const csVector3 &up)
 Renders the effect.
bool Update (csTicks elapsed)
 Updates the spell effect -- called every frame.
 ~psEffectObjParticles ()

Detailed Description

Definition at line 34 of file pseffectobjparticles.h.


Constructor & Destructor Documentation

psEffectObjParticles::psEffectObjParticles ( iView *  parentView,
psEffect2DRenderer renderer2d 
)
psEffectObjParticles::~psEffectObjParticles ( )

Member Function Documentation

psEffectObj* psEffectObjParticles::Clone ( ) const [virtual]

Clones the effect object.

This will almost always be overloaded.

Reimplemented from psEffectObj.

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

Loads the effect object from an xml node.

Parameters:
nodethe xml node containing the effect object, must be valid
ldr_contextthe current loader context.
Returns:
true on success, false otherwise

Reimplemented from psEffectObj.

bool psEffectObjParticles::Render ( const csVector3 &  up) [virtual]

Renders the effect.

Parameters:
upthe base up vector of the effect obj
Returns:
true on success

Reimplemented from psEffectObj.

bool psEffectObjParticles::Update ( csTicks  elapsed) [virtual]

Updates the spell effect -- called every frame.

Parameters:
elapsedthe 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: