psEffectObjKeyFrame Class Reference

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

#include <pseffectobj.h>

List of all members.

Public Types
enum	INTERP_TYPE {   IT_NONE = 0, IT_FLOOR, IT_CEILING, IT_LERP,   IT_COUNT }
enum	KEY_ACTION {   KA_SCALE = 1, KA_TOPSCALE, KA_CELL, KA_ALPHA,   KA_HEIGHT, KA_PADDING, KA_ANIMATE, KA_COUNT }
enum	KEY_VEC_ACTION {   KA_POS = KA_COUNT, KA_ROT, KA_SPIN, KA_COLOUR,   KA_VEC_COUNT }
Public Member Functions
	psEffectObjKeyFrame ()
	psEffectObjKeyFrame (const psEffectObjKeyFrame *other)
	psEffectObjKeyFrame (iDocumentNode *node, const psEffectObjKeyFrame *prevKeyFrame)
bool	SetParamScalings (const float *scale)
	Adjust each parameter that have the use_scale property set with this scale.
	~psEffectObjKeyFrame ()
Public Attributes
float	actions [KA_COUNT]
csBitArray	specAction
	keep track of which actions were specified for which
csTicks	time
	this is the time of the keyframe animation (in milliseconds)
int	useScale [KA_VEC_COUNT]
	If set upon load the actions are scaled after cloning. 0 no scaling, 1=scale1, 2=scale2, 3=scale3.
csVector3	vecActions [KA_VEC_COUNT-KA_COUNT]

---

Detailed Description

Stores data for a specific effect object keyframe.

Definition at line 55 of file pseffectobj.h.

---

Member Enumeration Documentation

enum psEffectObjKeyFrame::INTERP_TYPE

Enumerator:

IT_NONE
IT_FLOOR
IT_CEILING
IT_LERP
IT_COUNT

Definition at line 74 of file pseffectobj.h.

enum psEffectObjKeyFrame::KEY_ACTION

Enumerator:

KA_SCALE
KA_TOPSCALE
KA_CELL
KA_ALPHA
KA_HEIGHT
KA_PADDING
KA_ANIMATE
KA_COUNT

Definition at line 84 of file pseffectobj.h.

enum psEffectObjKeyFrame::KEY_VEC_ACTION

Enumerator:

KA_POS
KA_ROT
KA_SPIN
KA_COLOUR
KA_VEC_COUNT

Definition at line 97 of file pseffectobj.h.

---

Constructor & Destructor Documentation

psEffectObjKeyFrame::psEffectObjKeyFrame

(

)

psEffectObjKeyFrame::psEffectObjKeyFrame

(

const psEffectObjKeyFrame *

other

)

psEffectObjKeyFrame::psEffectObjKeyFrame	(	iDocumentNode *	node,
		const psEffectObjKeyFrame *	prevKeyFrame
	)

psEffectObjKeyFrame::~psEffectObjKeyFrame

(

)

---

Member Function Documentation

bool psEffectObjKeyFrame::SetParamScalings

(

const float *

scale

)

Adjust each parameter that have the use_scale property set with this scale.

Returns:

True if if any params where scaled

---

Member Data Documentation

float psEffectObjKeyFrame::actions[KA_COUNT]

Definition at line 107 of file pseffectobj.h.

csBitArray psEffectObjKeyFrame::specAction

keep track of which actions were specified for which

Definition at line 112 of file pseffectobj.h.

csTicks psEffectObjKeyFrame::time

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

Definition at line 72 of file pseffectobj.h.

int psEffectObjKeyFrame::useScale[KA_VEC_COUNT]

If set upon load the actions are scaled after cloning. 0 no scaling, 1=scale1, 2=scale2, 3=scale3.

Definition at line 109 of file pseffectobj.h.

csVector3 psEffectObjKeyFrame::vecActions[KA_VEC_COUNT-KA_COUNT]

Definition at line 108 of file pseffectobj.h.

---

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

• common/effects/pseffectobj.h