Planeshift
psEffectAnchorKeyFrame Class Reference

Stores data for a specific effect anchor keyframe. More...

#include <pseffectanchor.h>

Public Types

enum  INTERP_TYPE {
  IT_NONE = 0, IT_FLOOR, IT_CEILING, IT_LERP,
  IT_COUNT
}
 
enum  KEY_ACTION {
  KA_POS_X = 1, KA_POS_Y, KA_POS_Z, KA_TOTARGET_X,
  KA_TOTARGET_Y, KA_TOTARGET_Z, KA_COUNT
}
 

Public Member Functions

const char * GetActionName (size_t idx)
 
bool IsActionSet (size_t idx)
 
 psEffectAnchorKeyFrame ()
 
 psEffectAnchorKeyFrame (iDocumentNode *node, const psEffectAnchorKeyFrame *prevKeyFrame)
 
void SetDefaults ()
 Applies default values to this anchor keyframe. More...
 
void SetupFirstFrame ()
 Sets up this keyframe for the special case of being the first key frame in the group. More...
 
 ~psEffectAnchorKeyFrame ()
 

Public Attributes

float actions [KA_COUNT]
 
csBitArray specAction
 keep track of which actions were specified for which More...
 
float time
 this is the time of the keyframe animation (in seconds) More...
 

Detailed Description

Stores data for a specific effect anchor keyframe.

Definition at line 46 of file pseffectanchor.h.

Member Enumeration Documentation

Enumerator
IT_NONE 
IT_FLOOR 
IT_CEILING 
IT_LERP 
IT_COUNT 

Definition at line 66 of file pseffectanchor.h.

Enumerator
KA_POS_X 
KA_POS_Y 
KA_POS_Z 
KA_TOTARGET_X 
KA_TOTARGET_Y 
KA_TOTARGET_Z 
KA_COUNT 

Definition at line 76 of file pseffectanchor.h.

Constructor & Destructor Documentation

psEffectAnchorKeyFrame::psEffectAnchorKeyFrame ( )
psEffectAnchorKeyFrame::psEffectAnchorKeyFrame ( iDocumentNode *  node,
const psEffectAnchorKeyFrame prevKeyFrame 
)
psEffectAnchorKeyFrame::~psEffectAnchorKeyFrame ( )

Member Function Documentation

const char* psEffectAnchorKeyFrame::GetActionName ( size_t  idx)
inline

Definition at line 85 of file pseffectanchor.h.

bool psEffectAnchorKeyFrame::IsActionSet ( size_t  idx)
inline

Definition at line 105 of file pseffectanchor.h.

void psEffectAnchorKeyFrame::SetDefaults ( )

Applies default values to this anchor keyframe.

void psEffectAnchorKeyFrame::SetupFirstFrame ( )

Sets up this keyframe for the special case of being the first key frame in the group.

Member Data Documentation

float psEffectAnchorKeyFrame::actions[KA_COUNT]

Definition at line 83 of file pseffectanchor.h.

csBitArray psEffectAnchorKeyFrame::specAction

keep track of which actions were specified for which

Definition at line 111 of file pseffectanchor.h.

float psEffectAnchorKeyFrame::time

this is the time of the keyframe animation (in seconds)

Definition at line 64 of file pseffectanchor.h.


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