Public Member Functions

xl7::utilities::Smoothing Class Reference

#include <Smoothing.h>

List of all members.

Public Member Functions

 Smoothing (void)
virtual ~Smoothing (void)
 Smoothing (float *const value_ptr, const float target_value, const float target_time)
float * GetControlledFloat () const
float GetInitialValue () const
float GetTargetValue () const
float GetTargetTime () const
float GetElapsedTime () const
float GetAlterationRate () const
void SetTargetValue (const float target_value)
void SetTargetTime (const float target_time)
void Init (float *const value_ptr, const float target_value, const float target_time)
void EaseInEaseOut (const float delta_time)
void ResetElapsedTime ()
void ResetAlterationRate ()

Constructor & Destructor Documentation

xl7::utilities::Smoothing::Smoothing ( void   ) 

Default constructor.

xl7::utilities::Smoothing::~Smoothing ( void   )  [virtual]

Destructor.

xl7::utilities::Smoothing::Smoothing ( float *const   value_ptr,
const float  target_value,
const float  target_time 
)

Explicit constructor.


Member Function Documentation

void xl7::utilities::Smoothing::EaseInEaseOut ( const float  delta_time  ) 

Performs one smoothing step over the given (delta) time.

float xl7::utilities::Smoothing::GetAlterationRate (  )  const [inline]

Returns the current alteration rate.

float* xl7::utilities::Smoothing::GetControlledFloat (  )  const [inline]

Returns the pointer to the controlled float to smooth.

float xl7::utilities::Smoothing::GetElapsedTime (  )  const [inline]

Returns the elapsed time since initialization.

float xl7::utilities::Smoothing::GetInitialValue (  )  const [inline]

Returns the initial value (copied from the controlled float).

float xl7::utilities::Smoothing::GetTargetTime (  )  const [inline]

Returns the target time at which the controlled should have the target value.

float xl7::utilities::Smoothing::GetTargetValue (  )  const [inline]

Returns the target value the controlled float should have after the specified time.

void xl7::utilities::Smoothing::Init ( float *const   value_ptr,
const float  target_value,
const float  target_time 
)

Initializes the object and therefore sets the controlled float, the target value and the target time.

void xl7::utilities::Smoothing::ResetAlterationRate (  )  [inline]

Resets the current alteration rate.

void xl7::utilities::Smoothing::ResetElapsedTime (  )  [inline]

Resets the elapsed time (to zero).

void xl7::utilities::Smoothing::SetTargetTime ( const float  target_time  ) 

Sets the target time at which the controlled should have the target value. The current value will not be changed through this operation.

void xl7::utilities::Smoothing::SetTargetValue ( const float  target_value  ) 

Sets the target value the controlled float should have after the specified time. The current value will be the (new) initial value. The elapsed time will be reset to zero.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines