C# Class WaveEngine.Components.Animation.AnimationBase

Inheritance: Behavior

Mostra file Open project: WaveEngine/Components

Protected Properties

Property	Type	Description
keyFrameEvents	Dictionary>

Private Properties

Property	Type	Description

Public Methods

Method	Description
AddKeyFrameEvent ( string animation, int keyFrame ) : AnimationBase	Adds a key frame event to a given animation.
AddKeyFrameEvent ( string animation, int keyFrame, string tag ) : AnimationBase	Adds a key frame event to a given animation.
AnimationBase ( string name ) : System	Initializes a new instance of the AnimationBase class.
ClearKeyFrameEvents ( string animation ) : AnimationBase	Clears all the key frame events of a given animation.
PlayAnimation ( string name ) : void	Plays the animation.
PlayAnimation ( string name, bool loop ) : void	Plays the animation.
PlayAnimation ( string name, bool loop, bool backwards ) : void	Plays the animation.
PlayAnimation ( string name, int startFrame, int endFrame ) : void	Plays the animation between the specified frames.
PlayAnimation ( string name, int startFrame, int endFrame, bool loop, bool backwards ) : void	Plays the animation between the specified frames.
ResumeAnimation ( ) : void	Resume the animation.
StopAnimation ( ) : void	Stops the animation.

Protected Methods

Method	Description
DefaultValues ( ) : void	The default values

Method Details

AddKeyFrameEvent() public method

Adds a key frame event to a given animation.

public AddKeyFrameEvent ( string animation, int keyFrame ) : AnimationBase
animation	string	/// The animation name. ///
keyFrame	int	/// The key frame when the event will be raised. ///
return	AnimationBase

AddKeyFrameEvent() public method

Adds a key frame event to a given animation.

public AddKeyFrameEvent ( string animation, int keyFrame, string tag ) : AnimationBase
animation	string	/// The animation name. ///
keyFrame	int	/// The key frame when the event will be raised. ///
tag	string	/// The tag associated with the event. ///
return	AnimationBase

AnimationBase() public method

Initializes a new instance of the AnimationBase class.

public AnimationBase ( string name ) : System
name	string	Name of this instance.
return	System

ClearKeyFrameEvents() public method

Clears all the key frame events of a given animation.

public ClearKeyFrameEvents ( string animation ) : AnimationBase
animation	string	/// The animation name. ///
return	AnimationBase

DefaultValues() protected method

The default values

protected DefaultValues ( ) : void
return	void

PlayAnimation() public method

Plays the animation.

public PlayAnimation ( string name ) : void
name	string	/// The name of the animation. ///
return	void

PlayAnimation() public method

Plays the animation.

public PlayAnimation ( string name, bool loop ) : void
name	string	/// The name of the animation. ///
loop	bool	/// if set to true loop the animation. ///
return	void

PlayAnimation() public method

Plays the animation.

public PlayAnimation ( string name, bool loop, bool backwards ) : void
name	string	/// The name of the animation. ///
loop	bool	/// if set to true loop the animation. ///
backwards	bool	/// if set to true play the animation backwards. ///
return	void

PlayAnimation() public method

Plays the animation between the specified frames.

public PlayAnimation ( string name, int startFrame, int endFrame ) : void
name	string	/// The name of the animation. ///
startFrame	int	/// The frame where the animation starts playing. ///
endFrame	int	/// The last frame of the animation to play. ///
return	void

PlayAnimation() public abstract method

Plays the animation between the specified frames.

public abstract PlayAnimation ( string name, int startFrame, int endFrame, bool loop, bool backwards ) : void
name	string	/// The name of the animation. ///
startFrame	int	/// The frame where the animation starts playing. ///
endFrame	int	/// The last frame of the animation to play. ///
loop	bool	/// if set to true loop the animation. ///
backwards	bool	/// if set to true play the animation backwards. ///
return	void

ResumeAnimation() public abstract method

Resume the animation.

public abstract ResumeAnimation ( ) : void
return	void

StopAnimation() public abstract method

Stops the animation.

public abstract StopAnimation ( ) : void
return	void

Property Details

keyFrameEvents protected_oe property

The key frame events.

protected Dictionary> keyFrameEvents
return	Dictionary>