Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
TimedInt Class Reference

Manages the evolution of an integer from its starting value to its target value using a timer. Once started, the user just has to requery the current value to get its current working value. More...

Inheritance diagram for TimedInt:
CoreBaseType

Public Member Functions

 TimedInt (GuiApp &app, const int &start_value, const int &target_value, const unsigned int &duration, const unsigned int &update_rate=10)
 Constructor.
 
const int & get_start_value () const
 
const int & get_target_value () const
 
const int & get_current_value () const
 
const unsigned int & get_duration_value () const
 
const unsigned int & get_refresh_rate () const
 
const unsigned long & get_start_runtime () const
 
const bool & get_is_started () const
 
void start (int target_value=-1, int duration=-1)
 
void stop ()
 
void set_current_value (const int &value)
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Static Public Member Functions

static void manage_timer (void *data)
 
- Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfoclass_info ()
 Get the type descriptor of this instance.
 

Protected Member Functions

GuiAppget_app () const
 

Detailed Description

Manages the evolution of an integer from its starting value to its target value using a timer. Once started, the user just has to requery the current value to get its current working value.

Constructor & Destructor Documentation

TimedInt::TimedInt ( GuiApp app,
const int &  start_value,
const int &  target_value,
const unsigned int &  duration,
const unsigned int &  update_rate = 10 
)
inline

Constructor.

Parameters
[in]appapplication to get timer
[in]start_valuestarting value of the integer
[in]target_valuetarget value to reach
[in]durationduration of the value evolution (ms)
[in]update_ratewanted update rate of the value (ms)