AnimatedSprite.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_ANIMATED_SPRITE_H
#define GF_ANIMATED_SPRITE_H

#include "Portability.h"
#include "Sprite.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class Animation;

  /**
   * @ingroup graphics
   * @brief An animated sprite
   *
   * An animated sprite is a sprite that can display an animation.
   *
   * @sa gf::Sprite, gf::Animation
   */
  class GF_API AnimatedSprite : public Sprite {
  public:
    /**
     * @brief Constructor
     */
    AnimatedSprite();

    /**
     * @brief Set the current animation of the sprite
     *
     * @param animation The animation
     */
    void setAnimation(Animation& animation);

    /**
     * @brief Update the state of the animation
     *
     * @param dt The time (in seconds) since the last update
     */
    void update(float dt);

  private:
    Animation *m_animation;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_ANIMATED_SPRITE_H