A tweener makes a value to evolve through time from a initial value to an end value according to a given function. More...

#include <tweener.hpp>

Public Types
typedef boost::function< void()>	finish_callback
	The type of the function called to notify the end of the tweener.

Public Member Functions
	tweener ()
	Default constructor.
	tweener (const tweener &that)
	Copy constructor.
	tweener (const base_tweener &that)
	Constructor from a base_tweener.
	~tweener ()
	Destructor.
tweener &	operator= (const tweener &that)
	Assignment operator.
void	swap (tweener &that) throw ()
	Swap this instance with a given instance.
bool	is_finished () const
	Tell if the tweener has reached his total duration.
double	update (double dt)
	Update the tweener of a given amount of time.
void	on_finished (finish_callback f)
	Execute the callbacks notifying about the finish of the tweener.

Detailed Description

A tweener makes a value to evolve through time from a initial value to an end value according to a given function.

Definition at line 48 of file tweener.hpp.

Constructor & Destructor Documentation

claw::tween::tweener::tweener ( const tweener & that )

Copy constructor.

Parameters

that	The instance to copy from.

Definition at line 48 of file tweener.cpp.

claw::tween::tweener::tweener ( const base_tweener & that )

Constructor from a base_tweener.

Parameters

that	The instance to use for the implementation.

Definition at line 59 of file tweener.cpp.

claw::tween::tweener & claw::tween::tweener::operator= ( const tweener & that )

Assignment operator.

Parameters

that	The instance to copy from.

Definition at line 79 of file tweener.cpp.

void claw::tween::tweener::swap ( tweener & that ) throw ()

Swap this instance with a given instance.

Parameters

that	The instance to swap with.

Definition at line 91 of file tweener.cpp.

double claw::tween::tweener::update ( double dt )

Update the tweener of a given amount of time.

Parameters

dt	The duration of the update in time units since the last call.

Definition at line 113 of file tweener.cpp.

The documentation for this class was generated from the following files: