Класс TimerBase

Simple class for fading Widgets. Подробнее...

Граф наследования: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 ()

Защищенные данные
Managed	m_target
string	m_function
ref Param	m_params

Закрытые члены
void	WidgetFadeTimer ()
void	FadeIn (Widget w, float time, bool continue_=false)
	Make "fade in" effect on Widget (transparency goes from 0.0 to 1.0)
void	FadeOut (Widget w, float time, bool continue_=false)
	Make "fade out" effect on Widget (transparency goes from 1.0 to 0.0)
void	OnTimer ()
void	OnUpdate ()

Закрытые данные
Widget	m_widget
bool	m_fadeIn
float	m_alpha

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

Simple class for fading Widgets.

Timer class. Use when you want call function after some time, or repeatedly in time intervals. Call is not executed after the Timer object is deleted.
usage:

class MyObject
{
   ref Timer myTimer1;
   ref Timer myTimer2;
   ref Timer myTimer3;
 
   void MyObject()
   {
    myTimer1 = new Timer();
    myTimer1.Run(10, this, "Refresh"); // calls "Refresh" on "this" after 10 seconds
 
    myTimer2 = new Timer();
    myTimer2.Run(10, this, "Refresh", NULL, true); // calls "Refresh" on "this" every 10 seconds, until Pause or Stop is called
 
    myTimer3 = new Timer();
    myTimer3.Run(15, this, "Show", new Param1<bool>(false)); // calls "Show" on "this" with one bool argument after 15 seconds
   }
 
   void Refresh();
   void Show(bool visible);
}

Методы

FadeIn()

void FadeIn ( Widget w, float time, bool continue_ = false )

inlineprivate

Make "fade in" effect on Widget (transparency goes from 0.0 to 1.0)

Аргументы

w	widget which will be faded
time	duration of effect
continue	- if True continue from current alpha value, otherwise always begin from 0.0 alpha

    {
        m_alpha = w.GetAlpha();
        
        if (continue_ && m_alpha > 0.95)
        {
            w.SetAlpha(1.0);
            w.Show(true);
            return;
        }   
        
        m_widget = w;
        m_fadeIn = true;
    
        OnStart(time, false);
    
        if (m_widget)
        {
            m_alpha = m_widget.GetAlpha();
            m_widget.SetAlpha(0);
            m_widget.Show(true);
        }
    
        if (continue_)
        {
            m_time = m_alpha * time;
        }
    }

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

FadeOut()

void FadeOut ( Widget w, float time, bool continue_ = false )

inlineprivate

Make "fade out" effect on Widget (transparency goes from 1.0 to 0.0)

Аргументы

w	widget which will be faded
time	duration of effect
continue	- if True continue from current alpha value, otherwise always begin from 1.0 alpha

    {
        m_alpha = w.GetAlpha();
        
        if (continue_ && m_alpha < 0.05)
        {
            w.SetAlpha(0);
            w.Show(false);
            return;
        }   
        
        m_widget = w;
        m_fadeIn = false;
    
        OnStart(time, false);
        
        if (m_widget && !continue_)
        {
            m_alpha = 1.0;
            m_widget.SetAlpha(m_alpha);
            m_widget.Show(true);
        }   
    
        if (continue_)
        {
            m_time = (1.0 - m_alpha) * time;
        }
    }

Перекрестные ссылки m_alpha, m_time и OnStart().

OnTimer() [1/2]

void OnTimer ( )

inlineprivate

    {
        if (m_widget)
        {
            if (m_fadeIn)
            {
                m_widget.SetAlpha(1);
            }
            else
            {
                m_widget.SetAlpha(0);
                m_widget.Show(false);
            }
        }
    }

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

OnTimer() [2/2]

void OnTimer ( )

inlineprotected

    {
        if (m_params)
        {
            GetGame().GameScript.CallFunctionParams(m_target, m_function, NULL, m_params);
            m_params = NULL;
        }
        else
        {
            GetGame().GameScript.CallFunction(m_target, m_function, NULL, 0);
        }
    }

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

OnUpdate()

void OnUpdate ( )

inlineprivate

    {
        float timeDiff = m_time / m_duration;
        float progress;
        if (m_widget)
        {
            if (m_fadeIn)
            {
                progress = timeDiff;
            }
            else
            {
                progress = Math.Lerp(m_alpha,0,timeDiff);
                progress = Math.Clamp(progress,0,1);
            }
            
            m_widget.SetAlpha(progress);
        }
    }

Перекрестные ссылки Math::Clamp(), Math::Lerp(), m_duration и m_time.

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

Run()

void Run ( float duration, Managed obj, string fn_name, Param params = NULL, bool loop = false )

inlineprotected

Starts timer.

Аргументы

duration	function is executed after this time (in seconds).
obj	target object on which function will be executed
fn_name	name of function (on object "obj") which will be executed
params	function arguments see Param for usage, default NULL (no arguments)
loop	when true, timer is looped endlessly and function is executed after every loop.

    {
        m_target = obj;
        m_function = fn_name;
            
        m_params = params;
        OnStart(duration, loop);
    }

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

Stop()

override void Stop ( )

inlineprotected

    {
        super.Stop();
        m_params = NULL;
    }

Timer()

void Timer ( int category = CALL_CATEGORY_SYSTEM )

inlineprotected

    {
        OnInit(category);
    }

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

WidgetFadeTimer()

void WidgetFadeTimer ( )

inlineprivate

    {
        OnInit(CALL_CATEGORY_GUI);
        m_fadeIn = true;
    }

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

Поля

m_alpha

float m_alpha

private

Используется в FadeOut().

m_fadeIn

bool m_fadeIn

private

m_function

string m_function

protected

m_params

ref Param m_params

protected

m_target

Managed m_target

protected

m_widget

Widget m_widget

private

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/tools/tools.c