CzTimersManager Class Reference

Manager a collection of XOML timers. More...

#include <CzTimer.h>

List of all members.

Public Types
typedef CzList< CzXomlTimer * > ::iterator	_Iterator
Public Member Functions
_Iterator	begin ()
_Iterator	end ()
void	addTimer (CzXomlTimer *Timer)
	Adds a Timer to the Timers manager.
void	removeTimer (CzXomlTimer *Timer)
	Removes the Timer from the Timers manager.
void	removeTimer (unsigned int name_hash)
	Removes the named Timer from the Timers manager.
CzXomlTimer *	findTimer (unsigned int name_hash)
	Searches for the manager for the named Timer.
CzXomlTimer *	findTimer (const char *name)
	Searches for the manager for the named Timer.
void	clearTimers ()
	Clears and destroys all the Timers in the manager.
void	setParent (IzXomlResource *scene)
IzXomlResource *	getParent ()
	CzTimersManager ()
virtual	~CzTimersManager ()
void	Update (float dt)
Static Public Member Functions
static CzXomlTimer *	FindTimer (const char *name, IzXomlResource *container)
	Static method that searches for the named Timer.
static CzXomlTimer *	FindTimer (unsigned int name_hash, IzXomlResource *container)
	Static method that searches for the named Timer.
static CzXomlTimer *	FindTimer (unsigned int name_hash, CzScene *container, unsigned int actor_hash)
	Static method that searches for the named Timer.
static CzXomlTimer *	FindTimer (const char *name, CzScene *container, const char *actor_name)
	Static method that searches for the named Timer.
Protected Attributes
CzList< CzXomlTimer * >	Timers
IzXomlResource *	Parent
CzList< CzXomlTimer * >	Removals

---

Detailed Description

Manager a collection of XOML timers.

---

Member Typedef Documentation

typedef CzList<CzXomlTimer*>::iterator CzTimersManager::_Iterator

---

Constructor & Destructor Documentation

CzTimersManager::CzTimersManager

(

)

[inline]

virtual CzTimersManager::~CzTimersManager

(

)

[inline, virtual]

---

Member Function Documentation

void CzTimersManager::addTimer

(

CzXomlTimer *

Timer

)

Adds a Timer to the Timers manager.

Parameters:

[in,out]

Timers

If non-null, the Timer.

_Iterator CzTimersManager::begin

(

)

[inline]

void CzTimersManager::clearTimers

(

)

Clears and destroys all the Timers in the manager.

_Iterator CzTimersManager::end

(

)

[inline]

CzXomlTimer * CzTimersManager::findTimer

(

unsigned int

name_hash

)

Searches for the manager for the named Timer.

Parameters:

name_hash

The Timer name as a string hash.

Returns:

null if it not found, else the found Timer.

CzXomlTimer * CzTimersManager::findTimer

(

const char *

name

)

Searches for the manager for the named Timer.

Parameters:

name	The Timer name.

Returns:

null if it not found, else the found Timer.

CzXomlTimer * CzTimersManager::FindTimer	(	const char *	name,
		IzXomlResource *	container
	)		[static]

Static method that searches for the named Timer.

If the Timer is not found in the supplied conntainer then the global Timers manager will be searched.

Parameters:

	name	The Timer name.
[in]	container	If non-null, the container.

Returns:

null if not found, else the found Timer.

CzXomlTimer * CzTimersManager::FindTimer	(	unsigned int	name_hash,
		IzXomlResource *	container
	)		[static]

Static method that searches for the named Timer.

If the Timer is not found in the supplied conntainer then the global Timers manager will be searched.

Parameters:

	name	The Timer name as a string hash.
[in]	container	If non-null, the container.

Returns:

null if not found, else the found Timer.

CzXomlTimer * CzTimersManager::FindTimer	(	unsigned int	name_hash,
		CzScene *	scene,
		unsigned int	actor_hash
	)		[static]

Static method that searches for the named Timer.

Searches the supplied actors Timers manager for the named Timer, if supplied actor not valid then the supplied scene will be searched instead. If the Timer is not found in the scenes Timers manager then the global Timers manager will be searched.

Parameters:

	name_hash	The Timer name as a string hash.
[in]	container	If non-null, the container.
	actor_name	Name of the actor.

Returns:

null if not found, else the found Timer.

CzXomlTimer * CzTimersManager::FindTimer	(	const char *	name,
		CzScene *	container,
		const char *	actor_name
	)		[static]

Static method that searches for the named Timer.

Searches the supplied actors Timers manager for the named Timer, if supplied actor not valid then the supplied scene will be searched instead. If the Timer is not found in the scenes Timers manager then the global Timers manager will be searched.

Parameters:

	name	The Timer name.
[in]	container	If non-null, the container.
	actor_name	Name of the actor.

Returns:

null if not found, else the found Timer.

IzXomlResource* CzTimersManager::getParent

(

)

[inline]

void CzTimersManager::removeTimer

(

CzXomlTimer *

Timer

)

Removes the Timer from the Timers manager.

Parameters:

[in,out]

Timer

If non-null, the Timer.

void CzTimersManager::removeTimer

(

unsigned int

name_hash

)

Removes the named Timer from the Timers manager.

Parameters:

name_hash

The Timer name as a string hash.

void CzTimersManager::setParent

(

IzXomlResource *

scene

)

[inline]

void CzTimersManager::Update

(

float

dt

)

---

Member Data Documentation

IzXomlResource* CzTimersManager::Parent [protected]

CzList<CzXomlTimer*> CzTimersManager::Removals [protected]

CzList<CzXomlTimer*> CzTimersManager::Timers [protected]

---

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

• CzTimer.h
• CzTimer.cpp