IAnimationChainAnimatable

Introduction

The IAnimationChainAnimatable interface defines methods and properties for objects which can be animated by AnimationChains (which are stored in a AnimationChainList). Examples of classes which implement the IAnimationChainAnimatable interface include the Sprite and SpriteFrame.

Setting AnimationChains

The following shows various ways to set a Sprite's current AnimationChain. The reason there are so many examples is because Sprites and AnimationChains can be created many different ways. What follows are examples which cover the most common scenarios. For information on how to create AnimationChains, see the Creating AnimationChains wiki Entry.

If the Sprite and .achx are created in Glue

Normally the Sprite's AnimationChains can be set in Glue; however, to set them manually in code:

SpriteInstance.AnimationChains = AnimationChainFile;
SpriteInstance.Animate = true;
SpriteInstance.CurrentChainName = "WalkUp";

If the Sprite is already created (usually the case when using Glue), and you have an AnimationChain variable

IAnimationChainAnimatables like Sprites can also have their AnimationChains set after they are created:

// This code assumes that animationChain is a valid AnimationChain and
// sprite is a valid Sprite.
sprite.SetAnimationChain(chainToSet);
sprite.Animate = true; // still have to set animate to true

If creating the Sprite in Code

// This code assumes animationChain is a valid AnimationChain.
Sprite sprite = SpriteManager.AddSprite(animationChain);
sprite.Animate = true;
// So details can be seen
sprite.ScaleX = sprite.ScaleY = 10;

If the Sprite has already had its AnimationChains property set (usually done through Glue)

If the Sprite has had its AnimationChains value set, either in code or in Glue, then you can simply select which animation to play:

sprite.CurrentChainName = "WalkNorth";

Calling SetAnimationChain or setting the CurrentChainName needs to only be called when the AnimationChain is changing or being set. It does not need to be called every frame to keep the animation going.

Manually Setting Frames

See FlatRedBall.Graphics.Animation.IAnimationChainAnimatable.CurrentFrameIndex.

Detecting When an AnimationFrame Changes

When an IAnimationChainAnimatable changes the AnimationFrame that it is displaying, its JustChangedFrame property is true for that frame.

// assume mySprite is a valid Sprite that is animating
if(mySprite.JustChangedFrame)
{
   switch(mySprite.CurrentFrameIndex)
   {
       case 0:
           // do something
           break;
       case 1:
           // do something else
           break;
   }
}

Internal AnimationChainList and Common Usage

  • Walk North

  • Walk South

  • Walk West

  • Walk East

  • Attack (likely also has directions, but not included to save space)

  • Die

Since these behaviors share many similarities they should be put in a base class. However, setting AnimationChains becomes a problem. If each type of object (human peasant, orc peasant, ogre) references different AnimationChains the the code cannot fully be standardized if references are used to set the current animation. That is, if methods are called when a state change occurs, there will need to be virtual methods that can be called by the base class to set the current AnimationChain to the appropriate reference. While this will work, it is not very convenient or readable - for a new user to understand the behavior he will have to traverse multiple files and follow the execution path up and down the inheritance tree. The alternative is to recognize early on that this similarity between objects exists and design for this standard behavior both in content and in code. In other words, if the behaviors previously listed in bullet points are recognized early on before content creation begins, then this pattern can be used when all AnimationChainLists are created. Once the textures for all animations are created, the .achx file created in the AnimationEditor can use the same names for their AnimationChains. Therefore, the humanPeasant.achx file and the orc.achx file will both reference different textures, and can even have a different number of textures or frame times, but they should include a set of same-named AnimationChains. What the AnimationChain holds internally is insignificant from the programmer's point of view, just the name. Once these AnimationChains are created, the code simply loads the appropriate .achx file in the derived class' constructor. The base class can set the current AnimationChains using the Name property. As an example, the following code would work for all objects which have walking and dying animations:

// Assumes all types like BaseEntityState have been defined
void SetState(BaseEntityState state)
{
    // Assumes that the object has a reference to a Sprite called mSprite
    switch(state)
    {
        case BaseEntityState.WalkNorth:
            mSprite.CurrentChainName = "WalkNorth";
            break;

        case BaseEntityState.WalkSouth:
            mSprite.CurrentChainName = "WalkSouth";
            break;

        case BaseEntityState.WalkWest:
            mSprite.CurrentChainName = "WalkWest";
            break;

        case BaseEntityState.WalkEast:
            mSprite.CurrentChainName = "WalkEast";
            break;

        case BaseEntityState.Attack:
            mSprite.CurrentChainName = "Attack";
            break;

        case BaseEntityState.Die:
            mSprite.CurrentChainName = "Die";
            break;
    }
}

So long as all objects which inherit from the class containing this code have AnimationChains named WalkNorth, WalkSouth, WalkWest, WalkEast, Attack, and Die, this code will handle all AnimationChain setting with no regard to the actual contents of the AnimationChain being set.

Adding AnimationChains to an IAnimationChainAnimatable

The previous section discusses how to set AnimationChains on an IAnimationChainAnimatable. Of course, for the CurrentChainName property to work, the IAnimationChainAnimatable must have a reference to an AnimationChain with a matching name. Another way of looking at it is that if you are going to toggle between AnimationChains, then the object that is going to have its AnimationChain set must have references to multiple AnimationChains. How can this be done? The most common and data-driven approach is to load a .achx file created in the AnimationEditor or some other tool. The .achx file can contain multiple AnimationChains so this greatly simplifies the process. However, it's also possible to set up your IAnimationChainAnimatable to use multiple AnimationChains if you are creating the AnimationChains by hand. To do this, you can simply add each AnimationChain to the AnimationChains property. For example, assuming that animationChain1, animationChain2, and animationChain3 are valid AnimationChains:

// Also assuming that mySprite is a valid Sprite (which implements IAnimationChainAnimatable)
mySprite.AnimationChains.Add(animationChain1);
mySprite.AnimationChains.Add(animationChain2);
mySprite.AnimationChains.Add(animationChain3);

Additional Information

IAnimationChainAnimatable Members

Did this article leave any questions unanswered? Post any question in our forums for a rapid response.

PreviousTextureNextAnimate

Last updated