Planeshift
Public Member Functions | Protected Member Functions | Protected Attributes

psEffectObjDecal Class Reference

#include <pseffectobjdecal.h>

List of all members.

Public Member Functions

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

Protected Member Functions

virtual bool PostSetup ()
 Performs the post setup (after the effect obj has been loaded).

Protected Attributes

iDecal * decal
csRef< iDecalManager > decalMgr
csRef< iDecalTemplate > decalTemplate
float height
csVector3 normal
csVector3 pos
csVector3 up
float width

Detailed Description

Definition at line 36 of file pseffectobjdecal.h.


Constructor & Destructor Documentation

psEffectObjDecal::psEffectObjDecal ( iView *  parentView,
psEffect2DRenderer renderer2d 
)
virtual psEffectObjDecal::~psEffectObjDecal ( ) [virtual]

Member Function Documentation

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

Clones the effect object.

This will almost always be overloaded.

Reimplemented from psEffectObj.

virtual bool psEffectObjDecal::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.

virtual bool psEffectObjDecal::PostSetup ( ) [protected, virtual]

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

Things like create mesh factory, etc are initialized here.

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

Renders the effect.

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

Reimplemented from psEffectObj.

virtual bool psEffectObjDecal::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.


Member Data Documentation

iDecal* psEffectObjDecal::decal [protected]

Definition at line 59 of file pseffectobjdecal.h.

csRef<iDecalManager> psEffectObjDecal::decalMgr [protected]

Definition at line 58 of file pseffectobjdecal.h.

csRef<iDecalTemplate> psEffectObjDecal::decalTemplate [protected]

Definition at line 60 of file pseffectobjdecal.h.

Definition at line 67 of file pseffectobjdecal.h.

csVector3 psEffectObjDecal::normal [protected]

Definition at line 65 of file pseffectobjdecal.h.

csVector3 psEffectObjDecal::pos [protected]

Definition at line 63 of file pseffectobjdecal.h.

csVector3 psEffectObjDecal::up [protected]

Definition at line 64 of file pseffectobjdecal.h.

Definition at line 66 of file pseffectobjdecal.h.


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