CzAnimTimelinesManager Class Reference

Manages a collection of timelines. More...

#include <CzAnim.h>

List of all members.

Public Types
typedef CzList< CzAnimTimeline * > ::iterator	_Iterator
Public Member Functions
_Iterator	begin ()
_Iterator	end ()
void	addTimeline (CzAnimTimeline *timeline)
	Adds a timeline to the timelines manager.
void	removeTimeline (CzAnimTimeline *timeline)
	Removes the timeline from the timelines manager.
void	removeTimeline (unsigned int name_hash)
	Removes the named timeline from the timelines manager.
CzAnimTimeline *	findTimeline (unsigned int name_hash)
	Searches for the manager for the named timeline.
CzAnimTimeline *	findTimeline (const char *name)
	Searches for the manager for the named timeline.
void	clearTimelines ()
	Clears and destroys all the timelines in the manager.
void	setParent (IzXomlResource *scene)
IzXomlResource *	getParent ()
	CzAnimTimelinesManager ()
virtual	~CzAnimTimelinesManager ()
Static Public Member Functions
static CzAnimTimeline *	FindTimeline (const char *name, IzXomlResource *container)
	Static method that searches for the named timeline.
static CzAnimTimeline *	FindTimeline (unsigned int name_hash, IzXomlResource *container)
	Static method that searches for the named timeline.
static CzAnimTimeline *	FindTimeline (unsigned int name_hash, CzScene *container, unsigned int actor_hash)
	Static method that searches for the named timeline.
static CzAnimTimeline *	FindTimeline (const char *name, CzScene *container, const char *actor_name)
	Static method that searches for the named timeline.
Protected Attributes
CzList< CzAnimTimeline * >	Timelines
IzXomlResource *	Parent

---

Detailed Description

Manages a collection of timelines.

The timelines manager manages a group of of timelines. Actors and Scenes each have their own timelines manager as well as a global timelines manager that is used for global timelines.

To retrieve an actors timelines manager you call CzActor::getTimelinesManager() and for a scene you would call CzScene::getTimelinesManager(). To retrieve the global timelines manager you would use the CZ_GLOBAL_TIMELINE_MANAGER macro.

---

Member Typedef Documentation

typedef CzList<CzAnimTimeline*>::iterator CzAnimTimelinesManager::_Iterator

---

Constructor & Destructor Documentation

CzAnimTimelinesManager::CzAnimTimelinesManager

(

)

[inline]

virtual CzAnimTimelinesManager::~CzAnimTimelinesManager

(

)

[inline, virtual]

---

Member Function Documentation

void CzAnimTimelinesManager::addTimeline

(

CzAnimTimeline *

timeline

)

Adds a timeline to the timelines manager.

Parameters:

[in,out]

timelines

If non-null, the timeline.

_Iterator CzAnimTimelinesManager::begin

(

)

[inline]

void CzAnimTimelinesManager::clearTimelines

(

)

Clears and destroys all the timelines in the manager.

_Iterator CzAnimTimelinesManager::end

(

)

[inline]

CzAnimTimeline * CzAnimTimelinesManager::findTimeline

(

unsigned int

name_hash

)

Searches for the manager for the named timeline.

Parameters:

name_hash

The timeline name as a string hash.

Returns:

null if it not found, else the found timeline.

CzAnimTimeline * CzAnimTimelinesManager::findTimeline

(

const char *

name

)

Searches for the manager for the named timeline.

Parameters:

name	The timeline name.

Returns:

null if it not found, else the found timeline.

CzAnimTimeline * CzAnimTimelinesManager::FindTimeline	(	const char *	name,
		IzXomlResource *	container
	)		[static]

Static method that searches for the named timeline.

If the timeline is not found in the supplied conntainer then the global timelines manager will be searched.

Parameters:

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

Returns:

null if not found, else the found timeline.

CzAnimTimeline * CzAnimTimelinesManager::FindTimeline	(	unsigned int	name_hash,
		IzXomlResource *	container
	)		[static]

Static method that searches for the named timeline.

If the timeline is not found in the supplied conntainer then the global timelines manager will be searched.

Parameters:

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

Returns:

null if not found, else the found timeline.

CzAnimTimeline * CzAnimTimelinesManager::FindTimeline	(	unsigned int	name_hash,
		CzScene *	scene,
		unsigned int	actor_hash
	)		[static]

Static method that searches for the named timeline.

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

Parameters:

	name_hash	The timeline 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 timeline.

CzAnimTimeline * CzAnimTimelinesManager::FindTimeline	(	const char *	name,
		CzScene *	container,
		const char *	actor_name
	)		[static]

Static method that searches for the named timeline.

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

Parameters:

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

Returns:

null if not found, else the found timeline.

IzXomlResource* CzAnimTimelinesManager::getParent

(

)

[inline]

void CzAnimTimelinesManager::removeTimeline

(

CzAnimTimeline *

timeline

)

Removes the timeline from the timelines manager.

Parameters:

[in,out]

timeline

If non-null, the timeline.

void CzAnimTimelinesManager::removeTimeline

(

unsigned int

name_hash

)

Removes the named timeline from the timelines manager.

Parameters:

name_hash

The timeline name as a string hash.

void CzAnimTimelinesManager::setParent

(

IzXomlResource *

scene

)

[inline]

---

Member Data Documentation

IzXomlResource* CzAnimTimelinesManager::Parent [protected]

CzList<CzAnimTimeline*> CzAnimTimelinesManager::Timelines [protected]

---

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

• CzAnim.h
• CzAnim.cpp