Anim2DCollection Class Reference

#include <Anim2D.h>

Inherits SubsystemInterface.

Public Member Functions
	Anim2DCollection (void)
virtual	~Anim2DCollection (void)
virtual void	init (void)
	initialize system
virtual void	reset (void)
virtual void	update (void)
	reset system
Anim2DTemplate *	findTemplate (const AsciiString &name)
	find animation template
Anim2DTemplate *	newTemplate (const AsciiString &name)
	allocate a new template to be loaded
void	registerAnimation (Anim2D *anim)
	register animation with system
void	unRegisterAnimation (Anim2D *anim)
	un-register animation from system
Anim2DTemplate *	getTemplateHead () const
Anim2DTemplate *	getNextTemplate (Anim2DTemplate *animTemplate) const
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Protected Attributes
Anim2DTemplate *	m_templateList
	list of available animation templates
Anim2D *	m_instanceList
	list of all the anim 2D instance we're tracking
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 194 of file Anim2D.h.

Constructor & Destructor Documentation

Anim2DCollection()

Anim2DCollection::Anim2DCollection

(

void

)

Definition at line 723 of file Anim2D.cpp.

~Anim2DCollection()

Anim2DCollection::~Anim2DCollection ( void )

virtual

Definition at line 732 of file Anim2D.cpp.

Member Function Documentation

findTemplate()

Anim2DTemplate * Anim2DCollection::findTemplate

(

const AsciiString &

name

)

find animation template

Search the template list for a template with a matching name

Definition at line 789 of file Anim2D.cpp.

getNextTemplate()

Anim2DTemplate * Anim2DCollection::getNextTemplate

(

Anim2DTemplate *

animTemplate

)

const

Definition at line 808 of file Anim2D.cpp.

getTemplateHead()

Anim2DTemplate * Anim2DCollection::getTemplateHead ( ) const

inline

Definition at line 212 of file Anim2D.h.

init()

void Anim2DCollection::init ( void )

virtual

initialize system

Initialize 2D animation collection

Implements SubsystemInterface.

Definition at line 759 of file Anim2D.cpp.

newTemplate()

Anim2DTemplate * Anim2DCollection::newTemplate

(

const AsciiString &

name

)

allocate a new template to be loaded

Allocate a new template, assign name, and link to our internal list

Definition at line 820 of file Anim2D.cpp.

registerAnimation()

void Anim2DCollection::registerAnimation

(

Anim2D *

anim

)

register animation with system

Register animation instance with us. When an animation instance is registered it can be updated even when it's not drawn

Definition at line 839 of file Anim2D.cpp.

reset()

virtual void Anim2DCollection::reset ( void )

inlinevirtual

• Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
  • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
  • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements SubsystemInterface.

Definition at line 203 of file Anim2D.h.

unRegisterAnimation()

void Anim2DCollection::unRegisterAnimation

(

Anim2D *

anim

)

un-register animation from system

Definition at line 863 of file Anim2D.cpp.

update()

void Anim2DCollection::update ( void )

virtual

reset system

update system

System update phase

Implements SubsystemInterface.

Definition at line 770 of file Anim2D.cpp.

Member Data Documentation

m_instanceList

Anim2D* Anim2DCollection::m_instanceList

protected

list of all the anim 2D instance we're tracking

Definition at line 218 of file Anim2D.h.

m_templateList

Anim2DTemplate* Anim2DCollection::m_templateList

protected

list of available animation templates

Definition at line 217 of file Anim2D.h.

---

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

• Code/GameEngine/Include/GameClient/Anim2D.h
• Code/GameEngine/Source/GameClient/System/Anim2D.cpp