single_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_SINGLE_TWEENER_HPP__
#define __CLAW_TWEEN_SINGLE_TWEENER_HPP__
#include <claw/tween/base_tweener.hpp>
#include <claw/tween/easing/easing_none.hpp>
#include <boost/function.hpp>
namespace claw
{
namespace tween
{
class single_tweener:
public base_tweener
{
public:
typedef boost::function<void (double)> update_function;
typedef boost::function<double (double)> easing_function;
public:
single_tweener();
single_tweener
( double init, double end, double duration, update_function callback,
easing_function e );
single_tweener
( double& val, double end, double duration, easing_function e );
double get_init() const;
void set_init( double v );
double get_end() const;
void set_end( double v );
double get_duration() const;
void set_duration( double v );
void set_callback( update_function f );
void set_easing( easing_function f );
double get_value() const;
private:
single_tweener* do_clone() const;
bool do_is_finished() const;
double do_update( double dt );
private:
double m_init;
double m_end;
double m_date;
double m_duration;
update_function m_callback;
easing_function m_easing;
}; // class single_tweener
} // namespace tween
} // namespace claw
#endif // __CLAW_TWEEN_SINGLE_TWEENER_HPP__
claw::tween::single_tweener::set_init
void set_init(double v)
Sets the initial value.
Definition: single_tweener.cpp:142
claw::tween::single_tweener::update_function
boost::function< void(double)> update_function
The type of the function called when the single_tweener is updated.
Definition: single_tweener.hpp:54
claw::tween::base_tweener
Common interface for all tweeners.
Definition: base_tweener.hpp:44
claw::tween::single_tweener::easing_function
boost::function< double(double)> easing_function
The type of the function used to compute the new value.
Definition: single_tweener.hpp:57
claw::tween::single_tweener::get_end
double get_end() const
Gets the final value.
Definition: single_tweener.cpp:151
claw::tween::single_tweener
A single_tweener makes a value to evolve through time from a initial value to an end value according ...
Definition: single_tweener.hpp:48
claw::tween::single_tweener::set_duration
void set_duration(double v)
Sets the total duration.
Definition: single_tweener.cpp:180
base_tweener.hpp
Common interface for all tweeners.
claw::tween::single_tweener::get_value
double get_value() const
Gets the current value of the tweener.
Definition: single_tweener.cpp:209
claw::tween::single_tweener::set_callback
void set_callback(update_function f)
The function called when the single_tweener is updated.
Definition: single_tweener.cpp:190
claw::tween::single_tweener::set_end
void set_end(double v)
Sets the final value.
Definition: single_tweener.cpp:161
claw::tween::single_tweener::get_duration
double get_duration() const
Gets the total duration.
Definition: single_tweener.cpp:170
claw::tween::single_tweener::single_tweener
single_tweener()
Default constructor.
Definition: single_tweener.cpp:89
claw::tween::single_tweener::get_init
double get_init() const
Gets the initial value.
Definition: single_tweener.cpp:132
claw
This is the main namespace.
Definition: algorithm.hpp:33
claw::tween::single_tweener::set_easing
void set_easing(easing_function f)
The function used to compute the new value.
Definition: single_tweener.cpp:200
easing_none.hpp
Easing functions for the tweener. Those functions do nothing.