C# Class WaveEngine.Components.Animation.AnimationBase

Inheritance: Behavior
Afficher le fichier Open project: WaveEngine/Components

Protected Properties

Свойство Type Description
keyFrameEvents Dictionary>

Private Properties

Свойство Type Description

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode Description
DefaultValues ( ) : void

The default values

Method Details

AddKeyFrameEvent() public méthode

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. ///
Résultat AnimationBase

AddKeyFrameEvent() public méthode

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. ///
Résultat AnimationBase

AnimationBase() public méthode

Initializes a new instance of the AnimationBase class.
public AnimationBase ( string name ) : System
name string Name of this instance.
Résultat System

ClearKeyFrameEvents() public méthode

Clears all the key frame events of a given animation.
public ClearKeyFrameEvents ( string animation ) : AnimationBase
animation string /// The animation name. ///
Résultat AnimationBase

DefaultValues() protected méthode

The default values
protected DefaultValues ( ) : void
Résultat void

PlayAnimation() public méthode

Plays the animation.
public PlayAnimation ( string name ) : void
name string /// The name of the animation. ///
Résultat void

PlayAnimation() public méthode

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. ///
Résultat void

PlayAnimation() public méthode

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. ///
Résultat void

PlayAnimation() public méthode

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. ///
Résultat void

PlayAnimation() public abstract méthode

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. ///
Résultat void

ResumeAnimation() public abstract méthode

Resume the animation.
public abstract ResumeAnimation ( ) : void
Résultat void

StopAnimation() public abstract méthode

Stops the animation.
public abstract StopAnimation ( ) : void
Résultat void

Property Details

keyFrameEvents protected_oe property

The key frame events.
protected Dictionary> keyFrameEvents
Résultat Dictionary>