ui_timer.cpp File Reference

#include "../cl_shared.h"
#include "ui_nodes.h"
#include "ui_timer.h"

Include dependency graph for ui_timer.cpp:

Go to the source code of this file.

Macros
#define	UI_TIMER_SLOT_NUMBER   10
	Number max of timer slot.

Functions
static void	UI_RemoveTimerFromActiveList (uiTimer_t *timer)
	Remove a timer from the active linked list.
static void	UI_InsertTimerInActiveList (uiTimer_t *first, uiTimer_t *newTimer)
	Insert a timer in a sorted linked list of timers. List are ordered from smaller to bigger nextTime value.
void	UI_HandleTimers (void)
	Internal function to handle timers.
uiTimer_t *	UI_AllocTimer (uiNode_t *node, int firstDelay, timerCallback_t callback)
	Allocate a new time for a node.
void	UI_TimerStart (uiTimer_t *timer)
	Restart a timer.
void	UI_TimerStop (uiTimer_t *timer)
	Stop a timer.
void	UI_TimerRelease (uiTimer_t *timer)
	Release the timer. It no more exists.
void	UI_ResetTimers (void)

Variables
static uiTimer_t	ui_timerSlots [UI_TIMER_SLOT_NUMBER]
	Timer slot. Only one.
static uiTimer_t *	ui_firstTimer
	First timer from the timer list. This list is ordered from smaller to bigger nextTime value.

Macro Definition Documentation

UI_TIMER_SLOT_NUMBER

#define UI_TIMER_SLOT_NUMBER   10

Number max of timer slot.

Definition at line 32 of file ui_timer.cpp.

Referenced by UI_AllocTimer(), and UI_RemoveTimerFromActiveList().

Function Documentation

UI_AllocTimer()

uiTimer_t * UI_AllocTimer	(	uiNode_t *	node,
		int	firstDelay,
		timerCallback_t	callback )

Allocate a new time for a node.

Parameters

[in]	node	node parent of the timer
[in]	firstDelay	millisecond delay to wait the callback
[in]	callback	callback function to call every delay

Definition at line 123 of file ui_timer.cpp.

References Com_Error(), ERR_FATAL, i, UI_TIMER_SLOT_NUMBER, and ui_timerSlots.

Referenced by CL_BattlescapeRadarGenerateAll_f(), uiSpinnerNode::onMouseDown(), uiZoneNode::onMouseDown(), TEST_F(), UI_InitDraw(), UI_MouseDown(), and UI_VScrollbarNodeAction().

UI_HandleTimers()

void UI_HandleTimers

(

void

)

Internal function to handle timers.

Definition at line 98 of file ui_timer.cpp.

References CL_Milliseconds(), ui_firstTimer, UI_InsertTimerInActiveList(), and UI_RemoveTimerFromActiveList().

Referenced by UI_Draw().

UI_InsertTimerInActiveList()

void UI_InsertTimerInActiveList ( uiTimer_t * first, uiTimer_t * newTimer )

static

Insert a timer in a sorted linked list of timers. List are ordered from smaller to bigger nextTime value.

Definition at line 66 of file ui_timer.cpp.

References uiTimer_t::next, uiTimer_t::nextTime, uiTimer_t::prev, and ui_firstTimer.

Referenced by UI_HandleTimers(), and UI_TimerStart().

UI_RemoveTimerFromActiveList()

void UI_RemoveTimerFromActiveList ( uiTimer_t * timer )

inlinestatic

Remove a timer from the active linked list.

Note

The function doesn't set to null next and previous attributes of the timer

Definition at line 49 of file ui_timer.cpp.

References ui_firstTimer, UI_TIMER_SLOT_NUMBER, and ui_timerSlots.

Referenced by UI_HandleTimers(), UI_TimerRelease(), and UI_TimerStop().

UI_ResetTimers()

void UI_ResetTimers

(

void

)

Definition at line 185 of file ui_timer.cpp.

References OBJZERO, ui_firstTimer, and ui_timerSlots.

Referenced by UI_Shutdown().

UI_TimerRelease()

void UI_TimerRelease

(

uiTimer_t *

timer

)

Release the timer. It no more exists.

Definition at line 176 of file ui_timer.cpp.

References UI_RemoveTimerFromActiveList().

Referenced by CL_BattlescapeRadarGenerateAllRelease_f(), uiSpinnerNode::onCapturedMouseLost(), uiVScrollbarNode::onCapturedMouseLost(), uiZoneNode::onCapturedMouseLost(), and TEST_F().

UI_TimerStart()

void UI_TimerStart

(

uiTimer_t *

timer

)

Restart a timer.

Definition at line 150 of file ui_timer.cpp.

References CL_Milliseconds(), ui_firstTimer, and UI_InsertTimerInActiveList().

Referenced by CL_BattlescapeRadarGenerateAll_f(), uiSpinnerNode::onMouseDown(), uiZoneNode::onMouseDown(), TEST_F(), UI_Draw(), UI_MouseDown(), and UI_VScrollbarNodeAction().

UI_TimerStop()

void UI_TimerStop

(

uiTimer_t *

timer

)

Stop a timer.

Definition at line 163 of file ui_timer.cpp.

References UI_RemoveTimerFromActiveList().

Referenced by TEST_F(), UI_CheckTooltipDelay(), UI_Draw(), UI_LongPressCallback(), UI_MouseDown(), UI_MouseMove(), and UI_MouseUp().

Variable Documentation

ui_firstTimer

uiTimer_t* ui_firstTimer

static

First timer from the timer list. This list is ordered from smaller to bigger nextTime value.

Definition at line 43 of file ui_timer.cpp.

Referenced by UI_HandleTimers(), UI_InsertTimerInActiveList(), UI_RemoveTimerFromActiveList(), UI_ResetTimers(), and UI_TimerStart().

ui_timerSlots

uiTimer_t ui_timerSlots[UI_TIMER_SLOT_NUMBER]

static

Timer slot. Only one.

Definition at line 37 of file ui_timer.cpp.

Referenced by UI_AllocTimer(), UI_RemoveTimerFromActiveList(), and UI_ResetTimers().