Gamedev Framework (gf)  0.7.0
A C++14 framework for 2D games
Animation.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2018 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_ANIMATION_H
22 #define GF_ANIMATION_H
23 
24 #include <cstddef>
25 #include <vector>
26 
27 #include "Portability.h"
28 #include "Rect.h"
29 #include "Time.h"
30 
31 namespace gf {
32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
33 inline namespace v1 {
34 #endif
35 
36  class Texture;
37 
49  class GF_API Animation {
50  public:
54  Animation();
55 
66  void addFrame(const Texture& texture, const RectF& bounds, Time duration);
67 
74  const Texture& getCurrentTexture() const;
75 
82  RectF getCurrentBounds() const;
83 
90  bool update(Time time);
91 
92  private:
93  struct Frame {
94  const Texture *texture;
95  RectF bounds;
96  Time duration;
97  };
98 
99  std::size_t m_currentFrame;
100  Time m_currentDurationInFrame;
101  std::vector<Frame> m_frames;
102  };
103 
104 #ifndef DOXYGEN_SHOULD_SKIP_THIS
105 }
106 #endif
107 }
108 
109 #endif // GF_ANIMATION_H
Represents a time value.
Definition: Time.h:73
A texture for colored images.
Definition: Texture.h:339
The namespace for gf classes.
Definition: Action.h:34
An animation.
Definition: Animation.h:49