AnimatorTimer Class Reference

Collaboration diagram for AnimatorTimer:

Private Member Functions
void	Animate (float val, float speed=1.0)
	Starts animate value until value reaches target value.
void	AnimateLoop (float speed=1.0)
	Starts infinite animation loop <-1,1>. Based on sinus transition.
float	GetValue ()
	Returns actual animated value.
float	GetTargetValue ()
	Returns target value. While AnimateLoop returns angle of cycle in radians.
void	SetValue (float val)
	Sets both value and target value.
bool	IsRunning ()
void	Tick (float timeslice)
	Ticks the timer, is called by timer subsystem.

Private Attributes
bool	m_active = false
bool	m_loop = false
float	m_target_value = 0
float	m_value = 0
float	m_time = 0

Detailed Description

Definition at line 704 of file tools.c.

Member Function Documentation

Animate()

void AnimatorTimer::Animate ( float val, float speed = 1.0 )

inlineprivate

Starts animate value until value reaches target value.

Parameters

val	float target value
speed	float speed of animating, units per second

Definition at line 717 of file tools.c.

  {
    m_target_value = val;
    m_loop = false;
    m_time = speed;
    m_active = true;
  }

References m_active, m_loop, m_target_value, and m_time.

AnimateLoop()

void AnimatorTimer::AnimateLoop ( float speed = 1.0 )

inlineprivate

Starts infinite animation loop <-1,1>. Based on sinus transition.

Parameters

speed

float speed of animating , cycles per second (1.0 means one 360 degree sinus cycle per second: 0..1..0..-1..0)

Definition at line 729 of file tools.c.

  {
    m_value = 0;
    m_target_value = 0;
    m_loop = true;
    m_time = speed;
    m_active = true;
  }

References m_active, m_loop, m_target_value, m_time, and m_value.

GetTargetValue()

float AnimatorTimer::GetTargetValue ( )

inlineprivate

Returns target value. While AnimateLoop returns angle of cycle in radians.

Definition at line 749 of file tools.c.

  {
    return m_target_value;
  }

References m_target_value.

GetValue()

float AnimatorTimer::GetValue ( )

inlineprivate

Returns actual animated value.

Definition at line 741 of file tools.c.

  {
    return m_value;
  }

References m_value.

IsRunning()

bool AnimatorTimer::IsRunning ( )

inlineprivate

Definition at line 763 of file tools.c.

  {
    return m_active;
  }

References m_active.

SetValue()

void AnimatorTimer::SetValue ( float val )

inlineprivate

Sets both value and target value.

Definition at line 757 of file tools.c.

  {
    m_value = val;
    m_target_value = val;
  }

References m_target_value, and m_value.

Tick()

void AnimatorTimer::Tick ( float timeslice )

inlineprivate

Ticks the timer, is called by timer subsystem.

Definition at line 770 of file tools.c.

  {
    if (!m_active) return;
 
    if (m_loop)
    {
      m_target_value += m_time * Math.PI2 * timeslice;
      while (m_target_value > Math.PI2) m_target_value -= Math.PI2;
 
      m_value = Math.Sin(m_target_value);
    }
    else
    {
      float diff = Math.AbsFloat(m_target_value - m_value);
      float step = m_time * timeslice;
 
      if (diff < step)
      {
        m_value = m_target_value;
        m_active = false;
      }
      else
      {
        if (m_target_value > m_value)
          m_value += step;
        else
          m_value -= step;
      }
    }
  }

References Math::AbsFloat(), m_active, m_loop, m_target_value, m_time, m_value, Math::PI2, and Math::Sin().

Member Data Documentation

m_active

bool AnimatorTimer::m_active = false

private

Definition at line 706 of file tools.c.

Referenced by Animate(), AnimateLoop(), IsRunning(), and Tick().

m_loop

bool AnimatorTimer::m_loop = false

private

Definition at line 707 of file tools.c.

Referenced by Animate(), AnimateLoop(), and Tick().

m_target_value

float AnimatorTimer::m_target_value = 0

private

Definition at line 708 of file tools.c.

Referenced by Animate(), AnimateLoop(), GetTargetValue(), SetValue(), and Tick().

m_time

float AnimatorTimer::m_time = 0

private

Definition at line 710 of file tools.c.

Referenced by Animate(), AnimateLoop(), and Tick().

m_value

float AnimatorTimer::m_value = 0

private

Definition at line 709 of file tools.c.

Referenced by AnimateLoop(), GetValue(), SetValue(), and Tick().

---

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

• scripts/3_Game/tools/tools.c