Claw 1.7.3
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@gamned.org
23*/
30#ifndef __CLAW_TWEEN_TWEENER_HPP__
31#define __CLAW_TWEEN_TWEENER_HPP__
32
33#include <algorithm>
34#include <boost/function.hpp>
35
36namespace claw
37{
38 namespace tween
39 {
40 class base_tweener;
41
48 class tweener
49 {
50 public:
55 typedef boost::function<void ()> finish_callback;
56
57 public:
58 tweener();
59 tweener( const tweener& that );
60 tweener( const base_tweener& that );
61 ~tweener();
62
63 tweener& operator=( const tweener& that );
64
65 void swap( tweener& that ) throw();
66
67 bool is_finished() const;
68 double update( double dt );
69
71
72 private:
74 base_tweener* m_impl;
75
76 }; // class tweener
77
78 } // namespace tween
79} // namespace claw
80
81namespace std
82{
83 template<>
85} // namespace std
86
87#endif // __CLAW_TWEEN_TWEENER_HPP__
Common interface for all tweeners.
A tweener makes a value to evolve through time from a initial value to an end value according to a gi...
Definition tweener.hpp:49
tweener()
Default constructor.
Definition tweener.cpp:37
bool is_finished() const
Tell if the tweener has reached his total duration.
Definition tweener.cpp:100
void swap(tweener &that)
Swap this instance with a given instance.
Definition tweener.cpp:91
double update(double dt)
Update the tweener of a given amount of time.
Definition tweener.cpp:113
boost::function< void()> finish_callback
The type of the function called to notify the end of the tweener.
Definition tweener.hpp:55
~tweener()
Destructor.
Definition tweener.cpp:69
void on_finished(finish_callback f)
Execute the callbacks notifying about the finish of the tweener.
Definition tweener.cpp:125
tweener & operator=(const tweener &that)
Assignment operator.
Definition tweener.cpp:79
This is the main namespace.
Definition algorithm.hpp:34