C# Class WaveEngine.Components.Animation.Animation3D

Inheritance: AnimationBase
Show file Open project: WaveEngine/Components Class Usage Examples

Private Properties

Property Type Description
RefreshAnimationAsset void
UpdateNumFrames void

Public Methods

Method Description
Animation3D ( ) : System

Initializes a new instance of the Animation3D class.

Animation3D ( string animationPath ) : System

Initializes a new instance of the Animation3D class.

Animation3D ( string name, string animationPath ) : System

Initializes a new instance of the Animation3D class.

GetDuration ( string animation ) : float

Gets the duration of an animation.

PlayAnimation ( string name, int startFrame, int endFrame, bool loop = true, bool backwards = false ) : void

Plays the animation.

Plays the animation between the specified frames.

ResumeAnimation ( ) : void

Plays the animation up to a given frame.

Resume the animation.

StopAnimation ( ) : void

Stops the animation.

Protected Methods

Method Description
DefaultValues ( ) : void

The default values

Initialize ( ) : void

Performs further custom initialization for this instance.

Update ( System.TimeSpan gameTime ) : void

Updates the animation.

Private Methods

Method Description
RefreshAnimationAsset ( ) : void

Refresh animation asset

UpdateNumFrames ( ) : void

The update num frames.

Method Details

Animation3D() public method

Initializes a new instance of the Animation3D class.
public Animation3D ( ) : System
return System

Animation3D() public method

Initializes a new instance of the Animation3D class.
public Animation3D ( string animationPath ) : System
animationPath string /// The path to the animation data. ///
return System

Animation3D() public method

Initializes a new instance of the Animation3D class.
public Animation3D ( string name, string animationPath ) : System
name string /// The name of this behavior. ///
animationPath string /// The path to the animation data. ///
return System

DefaultValues() protected method

The default values
protected DefaultValues ( ) : void
return void

GetDuration() public method

Gets the duration of an animation.
public GetDuration ( string animation ) : float
animation string /// The animation name. ///
return float

Initialize() protected method

Performs further custom initialization for this instance.
protected Initialize ( ) : void
return void

PlayAnimation() public method

Plays the animation. Plays the animation between the specified frames.
public PlayAnimation ( string name, int startFrame, int endFrame, bool loop = true, bool backwards = false ) : 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 method

Plays the animation up to a given frame. Resume the animation.
public ResumeAnimation ( ) : void
return void

StopAnimation() public method

Stops the animation.
public StopAnimation ( ) : void
return void

Update() protected method

Updates the animation.
protected Update ( System.TimeSpan gameTime ) : void
gameTime System.TimeSpan /// The game time. ///
return void