base_tweener.hpp
Go to the documentation of this file.
/*
CLAW - a C++ Library Absolutely Wonderful
CLAW is a free library without any particular aim but being useful to
anyone.
Copyright (C) 2005-2011 Julien Jorge
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
contact: julien.jorge@gamned.org
*/
#ifndef __CLAW_TWEEN_BASE_TWEENER_HPP__
#define __CLAW_TWEEN_BASE_TWEENER_HPP__
#include <list>
#include <boost/function.hpp>
namespace claw
{
namespace tween
{
class base_tweener
{
public:
typedef boost::function<void ()> finish_callback;
public:
virtual ~base_tweener();
base_tweener* clone() const;
bool is_finished() const;
double update( double dt );
void on_finished( finish_callback f );
private:
void notify_finished() const;
virtual base_tweener* do_clone() const = 0;
virtual bool do_is_finished() const = 0;
virtual double do_update( double dt ) = 0;
private:
std::list<finish_callback> m_on_finished;
}; // class base_tweener
} // namespace tween
} // namespace claw
#endif // __CLAW_TWEEN_BASE_TWEENER_HPP__
claw::tween::base_tweener::finish_callback
boost::function< void()> finish_callback
The type of the function called to notify the end of the tweener.
Definition: base_tweener.hpp:51
claw::tween::base_tweener::~base_tweener
virtual ~base_tweener()
Destructor.
Definition: base_tweener.cpp:37
claw::tween::base_tweener
Common interface for all tweeners.
Definition: base_tweener.hpp:44
claw::tween::base_tweener::on_finished
void on_finished(finish_callback f)
Execute the callbacks notifying about the finish of the tweener.
Definition: base_tweener.cpp:85
claw::tween::base_tweener::clone
base_tweener * clone() const
Create a copy of this allocated with new.
Definition: base_tweener.cpp:46
claw::tween::base_tweener::is_finished
bool is_finished() const
Tell if the tweener has reached his total duration.
Definition: base_tweener.cpp:55
claw
This is the main namespace.
Definition: algorithm.hpp:33
claw::tween::base_tweener::update
double update(double dt)
Update the base_tweener of a given amount of time.
Definition: base_tweener.cpp:66