Planeshift
Public Member Functions

psEffectAnchorBasic Class Reference

#include <pseffectanchorbasic.h>

List of all members.

Public Member Functions

psEffectAnchorClone () const
 Clones the effect anchor.
bool Create (const csVector3 &offset, iMeshWrapper *posAttach, bool rotateWithMesh=false)
 Creates the effect anchor.
bool Load (iDocumentNode *node)
 Loads the effect anchors from an xml node.
 psEffectAnchorBasic ()
bool Update (csTicks elapsed)
 Updates the effect anchor -- called every frame.
 ~psEffectAnchorBasic ()

Detailed Description

Definition at line 29 of file pseffectanchorbasic.h.


Constructor & Destructor Documentation

psEffectAnchorBasic::psEffectAnchorBasic ( )
psEffectAnchorBasic::~psEffectAnchorBasic ( )

Member Function Documentation

psEffectAnchor* psEffectAnchorBasic::Clone ( ) const [virtual]

Clones the effect anchor.

This will almost always be overloaded.

Reimplemented from psEffectAnchor.

bool psEffectAnchorBasic::Create ( const csVector3 &  offset,
iMeshWrapper *  posAttach,
bool  rotateWithMesh = false 
) [virtual]

Creates the effect anchor.

Parameters:
offsetthe offset of the position of the obj.
posAttachthe mesh to attach this anchor to.
rotateWithMeshRotate the anchor with the mesh.
Returns:
true on success.

Reimplemented from psEffectAnchor.

bool psEffectAnchorBasic::Load ( iDocumentNode *  node) [virtual]

Loads the effect anchors from an xml node.

Parameters:
nodethe xml node containing the effect anchor, must be valid.
Returns:
true on success, false otherwise.

Reimplemented from psEffectAnchor.

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

Updates the effect anchor -- called every frame.

Parameters:
elapsedthe ticks elapsed since last update.
Returns:
false if the anchor is useless and can be removed by its parent effect.

Reimplemented from psEffectAnchor.


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