Common_effects

Classes
class	psEffect
	The effect class. More...
class	psEffect2DElement
	Base class for all possible 2D Effect Elements. More...
class	psEffect2DImgElement
	A 2D Image Effect Element. More...
class	psEffect2DRenderer
	The manager of all 2D effect elements. More...
class	psEffect2DTextElement
	A 2D Text Effect Element. More...
class	psEffectAnchor
	Effect anchors provide a base location / anchor point for all effect objs. More...
class	psEffectAnchorBasic
class	psEffectAnchorKeyFrame
	Stores data for a specific effect anchor keyframe. More...
class	psEffectAnchorKeyFrameGroup
	Effect anchor KeyFrame group. More...
class	psEffectAnchorSocket
class	psEffectAnchorSpline
struct	psEffectBackgroundElem
class	psEffectGroup
class	psEffectLoader
	Loader plugin for loading PS effects. More...
class	psEffectManager
class	psEffectObj
	An effect is not much more than a collection of effect objects. More...
class	psEffectObjDecal
class	psEffectObjKeyFrame
	Stores data for a specific effect object keyframe. More...
class	psEffectObjKeyFrameGroup
	Effect objects KeyFrame group. More...
class	psEffectObjLabel
class	psEffectObjLight
class	psEffectObjMesh
class	psEffectObjParticles
class	psEffectObjSimpMesh
class	psEffectObjSound
class	psEffectObjSpire
class	psEffectObjStar
class	psEffectObjText
class	psEffectObjText2D
class	psEffectObjTextable
class	psEffectObjTrail
struct	psEffectTextElement
struct	psEffectTextRow
class	psLight
Defines
#define	LERP_FACTOR
#define	LERP_KEY(action, factor)
#define	LERP_VEC_KEY(action, factor)
#define	PS_EFFECT_2D_TEXT_MAX_CHARS   512
Enumerations
enum	psEffectBackgroundAlign {   EA_NONE = 0, EA_TOP_LEFT, EA_TOP, EA_TOP_RIGHT,   EA_LEFT, EA_CENTER, EA_RIGHT, EA_BOTTOM_LEFT,   EA_BOTTOM, EA_BOTTOM_RIGHT }
enum	psEffectTextAlignment { ETA_LEFT, ETA_CENTER, ETA_RIGHT }

---

Define Documentation

#define LERP_FACTOR

Value:

lerpFactor(keyFrames->Get(currKeyFrame)->time, \
               keyFrames->Get(nextKeyFrame)->time, \
               life)

Definition at line 612 of file pseffectobj.h.

#define LERP_KEY	(		action,
			factor
	)

Value:

lerp(keyFrames->Get(currKeyFrame)->actions[psEffectObjKeyFrame::action], \
         keyFrames->Get(nextKeyFrame)->actions[psEffectObjKeyFrame::action], \
         factor)

Definition at line 602 of file pseffectobj.h.

#define LERP_VEC_KEY	(		action,
			factor
	)

Value:

lerpVec(keyFrames->Get(currKeyFrame)->vecActions[psEffectObjKeyFrame::action - psEffectObjKeyFrame::KA_COUNT], \
            keyFrames->Get(nextKeyFrame)->vecActions[psEffectObjKeyFrame::action - psEffectObjKeyFrame::KA_COUNT], \
            factor)

Definition at line 607 of file pseffectobj.h.

#define PS_EFFECT_2D_TEXT_MAX_CHARS   512

Definition at line 35 of file pseffect2drenderer.h.

---

Enumeration Type Documentation

enum psEffectBackgroundAlign

Enumerator:

EA_NONE
EA_TOP_LEFT
EA_TOP
EA_TOP_RIGHT
EA_LEFT
EA_CENTER
EA_RIGHT
EA_BOTTOM_LEFT
EA_BOTTOM
EA_BOTTOM_RIGHT

Definition at line 38 of file pseffectobjtext2d.h.

enum psEffectTextAlignment

Enumerator:

ETA_LEFT
ETA_CENTER
ETA_RIGHT

Definition at line 29 of file pseffectobjtextable.h.