TransitionEffect Class Reference

Interface for transition effects. More...

#include <Game/TransitionEffect.h>

Public Member Functions
	TransitionEffect ()
	Constructor.
	~TransitionEffect ()
	Deconstructor.
void	SetListener (TransitionEffectListener *l)
	Sets the transition effect listener.
const Transition::TransitionType	GetCurrentTransitionType () const
	Returns the type of the current transition or TRANSITION_UNKNOWN if there is no transition.
Transition *	GetCurrentTransition () const
	Returns the current transition or NULL if there is no transition.
void	SetArea (const Rectf &rec)
	Sets the area that the transition effect must cover.
bool	IsComplete () const
	Returns true if the transition is complete.
void	Reset ()
	Resets the transition effect.
void	ForceCompletion ()
	Forces the transition effec to be completed.
void	PushTransition (Transition *trans)
	Pushes a transition onto the active stack.
void	ResetOrder (const Transition::TransitionType typeOrder[], uint n)
	Sets the order of transitions and resets the transition.
void	Update (float dt)
	Updates the transition.
void	Draw ()
	Draws the transition.

Detailed Description

Interface for transition effects.

Holds a stack of transitions to be executed.

void TransitionEffect::PushTransition ( Transition * trans )

Pushes a transition onto the active stack.

Parameters:

[in] trans the transition to add. NOTE: Ownership of the transititon is taken by the effect.

void TransitionEffect::ResetOrder	(	const Transition::TransitionType	typeOrder[],
		uint	n
	)

Sets the order of transitions and resets the transition.

Parameters:

`[in]`	typeOrder	the order that differant transition types will apear in the transition.
`[in]`	n	the size of the typeOrder array. NOTE: only the first TRANSITION_COUNT items will be looked at.

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