WWCOMMON::ITask Interface Reference

Task Interface Class. More...

#include <interfaces/ITask.h>

Inherited by WWCLIENT::C3DSwapTask, WWCLIENT::C3DTask, WWCLIENT::CAnimateTask, WWCLIENT::CBackgroundTask, WWCLIENT::CCameraTask, WWCLIENT::CConfigTask, WWCLIENT::CGameTask, WWCLIENT::CGuiTask, WWCLIENT::CInputTask, WWCLIENT::CIntroTask, WWCLIENT::CLandscapeTask, WWCLIENT::CNetworkTask, WWCLIENT::CPacsTask, WWCLIENT::CPreGameTask, WWCLIENT::CResourceTask, WWCLIENT::CSkyTask, WWCLIENT::CTimeTask, and WWCLIENT::CWWTask.

List of all members.

Public Member Functions
	ITask ()
	ITask Constructor.
virtual void	init ()=0
	Pure virtual init method.
virtual void	update ()=0
	Pure virtual update method.
virtual void	render ()=0
	Pure virtual render method.
virtual void	release ()=0
	Pure virtual release method.
virtual std::string	name ()=0
	Pure virtual name method.
virtual void	stop ()
	Stops the task.
virtual void	restart ()
	Restart the task.
virtual void	remove ()
	Remove the task.
Private Attributes
sint32	m_Order
	Task priority.
NLMISC::CHTimer	m_HTimerUpdate
	TODO Doc This.
NLMISC::CHTimer	m_HTimerRender
	TODO Doc This.
char	m_NameUpdate [256]
	TODO Doc This.
char	m_NameRender [256]
	TODO Doc This.
bool	m_Extract
	Set to true when CTaskManager is to extract it from service.
bool	m_Execute
	Set to true when running, false when stopping.
Friends
class	CTaskManager
struct	commands_displayTasksClass

Detailed Description

Task Interface Class.

This is the interface used when designing new tasks that are manageable by the CTaskManager class.

Definition at line 57 of file ITask.h.

Constructor & Destructor Documentation

WWCOMMON::ITask::ITask ( ) [inline]

ITask Constructor.

Sets m_Extract and m_Execute values and preps the task to be started.

See also:: m_Extract; m_Execute

Definition at line 66 of file ITask.h.

References m_Execute, and m_Extract.

Member Function Documentation

virtual void WWCOMMON::ITask::init ( ) [pure virtual]

Pure virtual init method.

This pure virtual method is to be implemented by the specific task.

Implemented in WWCLIENT::CWWTask, WWCLIENT::C3DSwapTask, WWCLIENT::C3DTask, WWCLIENT::CAnimateTask, WWCLIENT::CBackgroundTask, WWCLIENT::CCameraTask, WWCLIENT::CConfigTask, WWCLIENT::CGameTask, WWCLIENT::CGuiTask, WWCLIENT::CInputTask, WWCLIENT::CIntroTask, WWCLIENT::CLandscapeTask, WWCLIENT::CNetworkTask, WWCLIENT::CPacsTask, WWCLIENT::CPreGameTask, WWCLIENT::CResourceTask, WWCLIENT::CSkyTask, and WWCLIENT::CTimeTask.

Referenced by WWCOMMON::CTaskManager::add().

virtual std::string WWCOMMON::ITask::name ( ) [pure virtual]

Pure virtual name method.

This pure virtual method is to be implemented by the specific task.

Implemented in WWCLIENT::CWWTask, WWCLIENT::C3DSwapTask, WWCLIENT::C3DTask, WWCLIENT::CAnimateTask, WWCLIENT::CBackgroundTask, WWCLIENT::CCameraTask, WWCLIENT::CConfigTask, WWCLIENT::CGameTask, WWCLIENT::CGuiTask, WWCLIENT::CInputTask, WWCLIENT::CIntroTask, WWCLIENT::CLandscapeTask, WWCLIENT::CNetworkTask, WWCLIENT::CPacsTask, WWCLIENT::CPreGameTask, WWCLIENT::CResourceTask, WWCLIENT::CSkyTask, and WWCLIENT::CTimeTask.

Referenced by WWCOMMON::CTaskManager::add(), WWCOMMON::CTaskManager::remove(), remove(), restart(), and stop().

virtual void WWCOMMON::ITask::release ( ) [pure virtual]

Pure virtual release method.

This pure virtual method is to be implemented by the specific task.

Implemented in WWCLIENT::CWWTask, WWCLIENT::C3DSwapTask, WWCLIENT::C3DTask, WWCLIENT::CAnimateTask, WWCLIENT::CBackgroundTask, WWCLIENT::CCameraTask, WWCLIENT::CConfigTask, WWCLIENT::CGameTask, WWCLIENT::CGuiTask, WWCLIENT::CInputTask, WWCLIENT::CIntroTask, WWCLIENT::CLandscapeTask, WWCLIENT::CNetworkTask, WWCLIENT::CPacsTask, WWCLIENT::CPreGameTask, WWCLIENT::CResourceTask, WWCLIENT::CSkyTask, and WWCLIENT::CTimeTask.

Referenced by WWCOMMON::CTaskManager::remove().

virtual void WWCOMMON::ITask::remove ( ) [inline, virtual]

Remove the task.

This method is called when something needs the implementing task to to be removed from the task manager. By default it sets m_Extract to true and m_Execute to false.