claw  1.9.0
tweener.hpp
Go to the documentation of this file.
1 /*
2  CLAW - a C++ Library Absolutely Wonderful
3 
4  CLAW is a free library without any particular aim but being useful to
5  anyone.
6 
7  Copyright (C) 2005-2011 Julien Jorge
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22  contact: julien.jorge@stuff-o-matic.com
23 */
29 #ifndef __CLAW_TWEEN_TWEENER_HPP__
30 #define __CLAW_TWEEN_TWEENER_HPP__
31 
32 #include <algorithm>
33 #include <functional>
34 
35 namespace claw
36 {
37  namespace tween
38  {
39  class base_tweener;
40 
47  class tweener
48  {
49  public:
54  typedef std::function<void()> finish_callback;
55 
56  public:
57  tweener();
58  tweener(const tweener& that);
59  tweener(const base_tweener& that);
60  ~tweener();
61 
62  tweener& operator=(const tweener& that);
63 
64  void swap(tweener& that) throw();
65 
66  bool is_finished() const;
67  double update(double dt);
68 
70 
71  private:
73  base_tweener* m_impl;
74 
75  }; // class tweener
76 
77  }
78 }
79 
80 namespace std
81 {
82  template <>
84 }
85 
86 #endif // __CLAW_TWEEN_TWEENER_HPP__
double update(double dt)
Update the tweener of a given amount of time.
Definition: tweener.cpp:99
std::function< void()> finish_callback
The type of the function called to notify the end of the tweener.
Definition: tweener.hpp:54
void swap(tweener &that)
Swap this instance with a given instance.
Definition: tweener.cpp:79
Common interface for all tweeners.
~tweener()
Destructor.
Definition: tweener.cpp:59
A tweener makes a value to evolve through time from a initial value to an end value according to a gi...
Definition: tweener.hpp:47
tweener & operator=(const tweener &that)
Assignment operator.
Definition: tweener.cpp:68
tweener()
Default constructor.
Definition: tweener.cpp:36
bool is_finished() const
Tell if the tweener has reached his total duration.
Definition: tweener.cpp:87
void on_finished(finish_callback f)
Execute the callbacks notifying about the finish of the tweener.
Definition: tweener.cpp:110
This is the main namespace.
Definition: application.hpp:49