class Effect

Defined in: C4Effects.h

The Effect class represents a special effect node in a scene graph.

Definition

class Effect : public Node, public Renderable, public ListElement<Effect>, public Registrable<Effect, EffectRegistration>

Member Functions

`Effect::GetEffectType`	Returns the effect type.
`Effect::GetEffectListIndex`	Returns the effect list index.
`Effect::SetEffectListIndex`	Sets the effect list index.
`Effect::SetDistortionState`	Sets the state necessary for rendering into the distortion buffer.
`Effect::Move`	Called once per frame to move an effect.
`Effect::Render`	Called when an effect should be rendered.

Constructor

Effect(EffectType type, RenderType renderType, unsigned long renderState = 0);

The constructor has protected access. The Effect class can only exist as the base class for a more specific type of effect.

Parameters

`type`	The effect type.
`renderType`	The render type passed to the `Renderable` base class.
`renderState`	The render state passed to the `Renderable` base class.

Description

Base Classes

`Node`	An `Effect` node is a scene graph node.
`Renderable`	An effect is a renderable object.
`ListElement<Effect>`	Used internally by the World Manager.
`Registrable<Effect, EffectRegistration>`	Custom effect types can be registered with the engine.