Gamedev Framework (gf)  0.2.0
A C++11 framework for 2D games
AnimatedSprite.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_ANIMATED_SPRITE_H
22 #define GF_ANIMATED_SPRITE_H
23 
24 #include "Portability.h"
25 #include "Sprite.h"
26 
27 namespace gf {
28 #ifndef DOXYGEN_SHOULD_SKIP_THIS
29 inline namespace v1 {
30 #endif
31 
32  class Animation;
33 
34  /**
35  * @ingroup graphics
36  * @brief An animated sprite
37  *
38  * An animated sprite is a sprite that can display an animation.
39  *
40  * @sa gf::Sprite, gf::Animation
41  */
42  class GF_API AnimatedSprite : public Sprite {
43  public:
44  /**
45  * @brief Constructor
46  */
48 
49  /**
50  * @brief Set the current animation of the sprite
51  *
52  * @param animation The animation
53  */
54  void setAnimation(Animation& animation);
55 
56  /**
57  * @brief Update the state of the animation
58  *
59  * @param dt The time (in seconds) since the last update
60  */
61  void update(float dt);
62 
63  private:
64  Animation *m_animation;
65  };
66 
67 #ifndef DOXYGEN_SHOULD_SKIP_THIS
68 }
69 #endif
70 }
71 
72 #endif // GF_ANIMATED_SPRITE_H
An animated sprite.
Definition: AnimatedSprite.h:42
A drawable representation of a texture, with its own transformations, color, etc. ...
Definition: Sprite.h:87
void update(float dt)
Update the state of the animation.
void setAnimation(Animation &animation)
Set the current animation of the sprite.
Definition: Action.h:34
AnimatedSprite()
Constructor.
#define GF_API
Definition: Portability.h:35
An animation.
Definition: Animation.h:48