AnimationTimer Class Reference

AnimationTimer class. This timer is for animating float value.
usage: More...

Inheritance diagram for AnimationTimer:

Collaboration diagram for AnimationTimer:

Protected Member Functions
void	AnimationTimer (int category=CALL_CATEGORY_SYSTEM)
void	~AnimationTimer ()
void	Run (float targetVal, Managed obj, string updateFunc, string finishedFunc, float startingVal=0, bool loop=false, float speed=1.0, Param params=null, int category=CALL_CATEGORY_SYSTEM)
float	GetValue ()
	Returns actual animated value.
override bool	IsRunning ()
override void	Tick (float timeslice)
	Ticks the timer, is called by timer subsystem.

Protected Attributes
Managed	m_TargetObject
string	m_UpdateFunction
string	m_FinishedFunction
ref Param	m_Params

Private Attributes
bool	m_Active
float	m_TargetValue
float	m_TargetValueOriginal
float	m_Value
Private Attributes inherited from TimerBase
Managed	m_target
string	m_function
ref Param	m_params

Additional Inherited Members
Private Member Functions inherited from TimerBase
void	Timer (int category=CALL_CATEGORY_SYSTEM)
void	Run (float duration, Managed obj, string fn_name, Param params=NULL, bool loop=false)
	Starts timer.
void	OnTimer ()
override void	Stop ()

Detailed Description

AnimationTimer class. This timer is for animating float value.
usage:

class MyObject
{
ref AnimationTimer myAnim;
 
void MyObject()
{
  myAnim = new AnimationTimer();
  myAnim.Run(60, this, "Refresh");
}
 
void Refresh()
{
  Print(myAnim.GetValue());
}
};

Definition at line 617 of file tools.c.

Constructor & Destructor Documentation

AnimationTimer()

void AnimationTimer::AnimationTimer ( int category = CALL_CATEGORY_SYSTEM )

inlineprotected

Definition at line 628 of file tools.c.

  {
    OnInit(category);
  }

References OnInit().

~AnimationTimer()

void AnimationTimer::~AnimationTimer ( )

inlineprotected

Definition at line 633 of file tools.c.

  {
    SetRunning(false);
  }

References SetRunning().

Member Function Documentation

GetValue()

float AnimationTimer::GetValue ( )

inlineprotected

Returns actual animated value.

Definition at line 656 of file tools.c.

  {
    return m_Value;
  }

References m_Value.

IsRunning()

override bool AnimationTimer::IsRunning ( )

inlineprotected

Definition at line 661 of file tools.c.

  {
    return m_Active;
  }

References m_Active.

Run()

void AnimationTimer::Run ( float targetVal, Managed obj, string updateFunc, string finishedFunc, float startingVal = 0, bool loop = false, float speed = 1.0, Param params = null, int category = CALL_CATEGORY_SYSTEM )

inlineprotected

Definition at line 638 of file tools.c.

  {
    SetRunning(true);
    m_TargetObject = obj;
    m_UpdateFunction = updateFunc;
    m_FinishedFunction = finishedFunc;
    m_TargetValueOriginal = targetVal;
    m_TargetValue = targetVal;
    m_time = speed;
    m_loop = loop;
    m_Active = true;
    m_Params = params;
    m_Value = startingVal;
  }

References m_Active, m_FinishedFunction, m_loop, m_Params, m_TargetObject, m_TargetValue, m_TargetValueOriginal, m_time, m_UpdateFunction, m_Value, and SetRunning().

Tick()

override void AnimationTimer::Tick ( float timeslice )

inlineprotected

Ticks the timer, is called by timer subsystem.

Definition at line 668 of file tools.c.

  {
    if (!m_Active)
      return;
 
 
    float diff = Math.AbsFloat(m_TargetValue - m_Value);
    float step = m_time * timeslice;
 
    if (diff < step)
    {
      m_Value = m_TargetValue;
      if (!m_loop)
        m_Active = false;
      else
      {
        if (m_TargetValue == m_TargetValueOriginal)
          m_TargetValue = 0;
        else
          m_TargetValue = m_TargetValueOriginal;
 
      }
      GetGame().GameScript.CallFunction(m_TargetObject, m_FinishedFunction, NULL, m_Params);
    }
    else
    {
      if (m_TargetValue > m_Value)
        m_Value += step;
      else
        m_Value -= step;
    }
 
    GetGame().GameScript.CallFunction(m_TargetObject, m_UpdateFunction, NULL, m_Params);
  }

References Math::AbsFloat(), GetGame(), m_Active, m_FinishedFunction, m_loop, m_Params, m_TargetObject, m_TargetValue, m_TargetValueOriginal, m_time, m_UpdateFunction, and m_Value.

Member Data Documentation

m_Active

bool AnimationTimer::m_Active

private

Definition at line 619 of file tools.c.

Referenced by IsRunning(), Run(), and Tick().

m_FinishedFunction

string AnimationTimer::m_FinishedFunction

protected

Definition at line 625 of file tools.c.

Referenced by Run(), and Tick().

m_Params

ref Param AnimationTimer::m_Params

protected

Definition at line 626 of file tools.c.

Referenced by Run(), and Tick().

m_TargetObject

Managed AnimationTimer::m_TargetObject

protected

Definition at line 623 of file tools.c.

Referenced by Run(), and Tick().

m_TargetValue

float AnimationTimer::m_TargetValue

private

Definition at line 620 of file tools.c.

Referenced by Run(), and Tick().

m_TargetValueOriginal

float AnimationTimer::m_TargetValueOriginal

private

Definition at line 621 of file tools.c.

Referenced by Run(), and Tick().

m_UpdateFunction

string AnimationTimer::m_UpdateFunction

protected

Definition at line 624 of file tools.c.

Referenced by Run(), and Tick().

m_Value

float AnimationTimer::m_Value

private

Definition at line 622 of file tools.c.

Referenced by GetValue(), Run(), and Tick().

---

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

• scripts/3_Game/tools/tools.c