AnimationTimer class. This timer is for animating float value.
usage: Подробнее...

Граф наследования:AnimationTimer:

Защищенные члены
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.

Защищенные данные
Managed	m_TargetObject

string	m_UpdateFunction

string	m_FinishedFunction

ref Param	m_Params

Закрытые данные
bool	m_Active

float	m_TargetValue

float	m_TargetValueOriginal

float	m_Value

Закрытые данные унаследованные от TimerBase
Managed	m_target

string	m_function

ref Param	m_params

Дополнительные унаследованные члены
Закрытые члены унаследованные от 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 ()

Подробное описание

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());
   }
}; 

Конструктор(ы)

◆ AnimationTimer()

void AnimationTimer ( int category = CALL_CATEGORY_SYSTEM )

inlineprotected

    {
        OnInit(category);
    }

Перекрестные ссылки OnInit().

◆ ~AnimationTimer()

void ~AnimationTimer ( )

inlineprotected

    {
        SetRunning(false);
    }

Перекрестные ссылки SetRunning().

Методы

◆ GetValue()

float GetValue ( )

inlineprotected

Returns actual animated value.

                     {
        return m_Value;
    }   

Перекрестные ссылки m_Value.

◆ IsRunning()

override bool IsRunning ( )

inlineprotected

    {
        return m_Active;
    }

Перекрестные ссылки m_Active.

◆ Run()

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 )

inlineprotected

    {
        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;
    }

Перекрестные ссылки m_Active, m_FinishedFunction, m_loop, m_Params, m_TargetObject, m_TargetValue, m_TargetValueOriginal, m_time, m_UpdateFunction, m_Value и SetRunning().

◆ Tick()

override void Tick ( float timeslice )

inlineprotected

Ticks the timer, is called by timer subsystem.

    {
        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);
    }

Перекрестные ссылки Math::AbsFloat(), GetGame(), m_Active, m_FinishedFunction, m_loop, m_Params, m_TargetObject, m_TargetValue, m_TargetValueOriginal, m_time, m_UpdateFunction и m_Value.

Поля

◆ m_Active

bool m_Active

private

Используется в IsRunning(), Run() и Tick().