AnimationTimer Class Reference

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

Inheritance 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

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 650 of file tools.c.

Constructor & Destructor Documentation

AnimationTimer()

void AnimationTimer::AnimationTimer ( int category = CALL_CATEGORY_SYSTEM )

protected

Definition at line 661 of file tools.c.

~AnimationTimer()

void AnimationTimer::~AnimationTimer ( )

protected

Definition at line 666 of file tools.c.

Member Function Documentation

GetValue()

float AnimationTimer::GetValue ( )

protected

Returns actual animated value.

Definition at line 689 of file tools.c.

IsRunning()

override bool AnimationTimer::IsRunning ( )

protected

Definition at line 693 of file tools.c.

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 )

protected

Definition at line 671 of file tools.c.

Tick()

override void AnimationTimer::Tick ( float timeslice )

protected

Ticks the timer, is called by timer subsystem.

Definition at line 700 of file tools.c.

Member Data Documentation

m_FinishedFunction

string AnimationTimer::m_FinishedFunction

protected

Definition at line 658 of file tools.c.

m_Params

ref Param AnimationTimer::m_Params

protected

Definition at line 659 of file tools.c.

m_TargetObject

Managed AnimationTimer::m_TargetObject

protected

Definition at line 656 of file tools.c.

m_UpdateFunction

string AnimationTimer::m_UpdateFunction

protected

Definition at line 657 of file tools.c.

---

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

• Daten/3_game/tools/tools.c