amn::IEngine Class Reference

The engine class. More...

#include <IEngine.h>

Inheritance diagram for amn::IEngine:

List of all members.

Public Member Functions
	IEngine (const char *configurationFileName)
virtual	~IEngine ()
virtual ISceneGraph *	getSceneGraph ()=0
	Returns the current scene graph.
virtual IVideoDevice *	getVideoDevice ()=0
	Returns the video device.
virtual ISoundDevice *	getSoundDevice ()=0
	Returns the sound device.
virtual IFileManager *	getFileManager ()=0
	Returns the file manager.
virtual bool	update ()=0
	Updates the engine. Returns true if it is safe to continue execution.
virtual void	close ()=0
	Kills the window, update() will nolonger return true.
virtual int	addSceneGraph (ISceneGraph *graph)=0
	Adds a user created scene graph to the engine's management. Returns an integer index to the scene.
virtual void	removeSceneGraph (int sceneGraphID)=0
	Removes a user created scene graph from the engine's management.
virtual void	setCurrentSceneGraph (int sceneGraphID)=0
	Sets the current scene graph.
virtual long	getTime ()=0
	Retrieves the system time in milliseconds.
Protected Attributes
ISceneGraph *	sceneGraph
IVideoDevice *	videoDevice
ISoundDevice *	soundDevice
IFileManager *	fileManager
IArray< ISceneGraph * >	sceneGraphArray

---

Detailed Description

The engine class.

---

Constructor & Destructor Documentation

amn::IEngine::IEngine (  const char *  configurationFileName  )  [inline]

virtual amn::IEngine::~IEngine (   )  [inline, virtual]

---

Member Function Documentation

virtual int amn::IEngine::addSceneGraph (  ISceneGraph *  graph  )  [pure virtual]

Adds a user created scene graph to the engine's management. Returns an integer index to the scene.

virtual void amn::IEngine::close (   )  [pure virtual]

Kills the window, update() will nolonger return true.

virtual IFileManager* amn::IEngine::getFileManager (   )  [pure virtual]

Returns the file manager.

virtual ISceneGraph* amn::IEngine::getSceneGraph (   )  [pure virtual]

Returns the current scene graph.

virtual ISoundDevice* amn::IEngine::getSoundDevice (   )  [pure virtual]

Returns the sound device.

virtual long amn::IEngine::getTime (   )  [pure virtual]

Retrieves the system time in milliseconds.

virtual IVideoDevice* amn::IEngine::getVideoDevice (   )  [pure virtual]

Returns the video device.

virtual void amn::IEngine::removeSceneGraph (  int  sceneGraphID  )  [pure virtual]

Removes a user created scene graph from the engine's management.

virtual void amn::IEngine::setCurrentSceneGraph (  int  sceneGraphID  )  [pure virtual]

Sets the current scene graph.

virtual bool amn::IEngine::update (   )  [pure virtual]

Updates the engine. Returns true if it is safe to continue execution.

---

Member Data Documentation

IFileManager* amn::IEngine::fileManager [protected]

ISceneGraph* amn::IEngine::sceneGraph [protected]

IArray<ISceneGraph*> amn::IEngine::sceneGraphArray [protected]

ISoundDevice* amn::IEngine::soundDevice [protected]

IVideoDevice* amn::IEngine::videoDevice [protected]

---

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

• includes/IEngine.h

---