Claw  1.7.3
Public Types | Public Member Functions
claw::tween::single_tweener Class Reference

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

#include <single_tweener.hpp>

Inheritance diagram for claw::tween::single_tweener:
claw::tween::base_tweener

List of all members.

Public Types

typedef boost::function< void(double)> update_function
 The type of the function called when the single_tweener is updated.
typedef boost::function
< double(double)> 
easing_function
 The type of the function used to compute the new value.

Public Member Functions

 single_tweener ()
 Default constructor.
 single_tweener (double init, double end, double duration, update_function callback, easing_function e)
 Constructor.
 single_tweener (double &val, double end, double duration, easing_function e)
 Constructor.
double get_init () const
 Gets the initial value.
void set_init (double v)
 Sets the initial value.
double get_end () const
 Gets the final value.
void set_end (double v)
 Sets the final value.
double get_duration () const
 Gets the total duration.
void set_duration (double v)
 Sets the total duration.
void set_callback (update_function f)
 The function called when the single_tweener is updated.
void set_easing (easing_function f)
 The function used to compute the new value.
double get_value () const
 Gets the current value of the tweener.

Detailed Description

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

Author:
Julien Jorge
See also:
C++ Tweeners

Definition at line 48 of file single_tweener.hpp.


Constructor & Destructor Documentation

claw::tween::single_tweener::single_tweener ( double  init,
double  end,
double  duration,
update_function  callback,
easing_function  e 
)

Constructor.

Parameters:
initThe initial value.
endThe final value.
durationThe total duration.
callbackThe function called when the single_tweener is updated.
eThe function used to compute the new value.

Definition at line 105 of file single_tweener.cpp.

claw::tween::single_tweener::single_tweener ( double &  val,
double  end,
double  duration,
easing_function  e 
)

Constructor.

Parameters:
valThe value to tween (and to use as the The initial value).
endThe final value.
durationThe total duration.
eThe function used to compute the new value.

Definition at line 122 of file single_tweener.cpp.


Member Function Documentation

The function called when the single_tweener is updated.

Parameters:
fThe function.

Definition at line 190 of file single_tweener.cpp.

Sets the total duration.

Parameters:
vThe value.

Definition at line 180 of file single_tweener.cpp.

The function used to compute the new value.

Parameters:
fThe function.

Definition at line 200 of file single_tweener.cpp.

Sets the final value.

Parameters:
vThe value.

Definition at line 161 of file single_tweener.cpp.

Sets the initial value.

Parameters:
vThe value.

Definition at line 142 of file single_tweener.cpp.


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