EPOC::BaseObject Class Reference

#include <BaseObject.h>

Inheritance diagram for EPOC::BaseObject:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 BaseObject ()
virtual ~BaseObject ()
virtual bool Update (float fTimeDelta)
virtual void HandleEvent (SDL_Event *pEvent)
void SetClassID (int nID)
void SetClassSubID (int nSubID)
int GetClassID ()
int GetClassSubID ()
int GetRefCount ()
void AddRef ()
void Release ()
bool IsClass (int nID)
bool IsSubClass (int nSubID)

Protected Attributes

int m_nID
int m_nSubID
int m_nRefCounter


Detailed Description

Base class This class the base class of all EPOC classes

Constructor & Destructor Documentation

BaseObject::BaseObject (  ) 

Contructor Resets all members to the default values

BaseObject::~BaseObject (  )  [virtual]

Destructor Calls the cleanup method.

See also:
Cleanup()


Member Function Documentation

virtual bool EPOC::BaseObject::Update ( float  fTimeDelta  )  [inline, virtual]

Updates class data

Remarks:
This function is called once per frame.
Parameters:
fTimeDelta the time that has passed since last update, measured in milliseconds
Returns:
true if the update succeeded and false if it didn't

Reimplemented in EPOC::Animation, EPOC::Application, EPOC::AudioManager, EPOC::ContentManager, EPOC::Engine, EPOC::GraphicsManager, EPOC::InputManager, EPOC::Music, and EPOC::Sound.

virtual void EPOC::BaseObject::HandleEvent ( SDL_Event *  pEvent  )  [inline, virtual]

Callback for handling SDL event

Remarks:
This method is called when SDL events occurs if the class is registered to recieve events
Parameters:
pEvent the SDL event that occured

Reimplemented in EPOC::Application, and EPOC::InputManager.

void EPOC::BaseObject::SetClassID ( int  nID  )  [inline]

Helper method for setting class ID to identify the class

Parameters:
nID the class ID to set.
See also:
EP_CLASSID

void EPOC::BaseObject::SetClassSubID ( int  nSubID  )  [inline]

Helper method for setting class sub ID to identify the class. Sub ID's are not enumerated in EPOC. You should define your own.

Parameters:
nSubID the class ID to set.
See also:
EP_CLASSID

int EPOC::BaseObject::GetClassID (  )  [inline]

Helper method for getting the class ID of the class

Returns:
the class ID of the class

int EPOC::BaseObject::GetClassSubID (  )  [inline]

Helper method for getting the class sub ID of the class

Returns:
the class ID of the class

int EPOC::BaseObject::GetRefCount (  )  [inline]

Helper method for getting the reference count of the class

Returns:
the reference count of the class

void EPOC::BaseObject::AddRef (  )  [inline]

Method for adding a reference to the class

See also:
GetRefCount

Release

void EPOC::BaseObject::Release (  )  [inline]

Method for releasing a reference to the class. Once the reference count gets below one this method deletes the this object

See also:
GetRefCount

AddRef

bool EPOC::BaseObject::IsClass ( int  nID  )  [inline]

Helper method checking the class ID.

Returns:
true if the class is of the same ID as the parameter

bool EPOC::BaseObject::IsSubClass ( int  nSubID  )  [inline]

Helper method for getting the reference count of the class

Returns:
the reference count of the class


Member Data Documentation

int EPOC::BaseObject::m_nID [protected]

int EPOC::BaseObject::m_nSubID [protected]

int EPOC::BaseObject::m_nRefCounter [protected]


The documentation for this class was generated from the following files:
Generated on Tue Feb 12 08:26:02 2008 for EPOC by  doxygen 1.5.4