NE::NEngine Class Reference

NEngine interface. More...

#include <NEngine/Engine.h>

Inheritance diagram for NE::NEngine:
NE::SDL_Engine

List of all members.

Public Member Functions

bool init (void)
 Start the engine (and all sub API used).
bool stop (void)
 Stop the engine (and all sub API used).
WindowgetWindow (void)
 Get the Window used by the Engine.
SpriteLoadergetSpriteLoader (void)
 Get the SpriteLoader.
SpriteFactorygetSpriteFactory (void)
 Get the SpriteFactory.
RenderergetRenderer (void)
 Get the Renderer used by the Engine.
InputManagergetInputManager (void)
 Get the InputManager used by the Engine.
TimegetTime (void)
 Get the Time used by the Engine.

Protected Member Functions

virtual bool initAPI (void)=0
virtual bool stopAPI (void)=0

Protected Attributes

WindowpWin
RendererpRenderer
InputManagerpInputManager
TimepTime
SpriteLoaderpSpriteLoader
SpriteFactorypSpriteFactory

Detailed Description

NEngine interface.

The Engine class gives an interface to implement new platform specific engine used by the game. The Engine generally contains a Window, a Renderer, a SpriteLoader but also Input and Time.


Member Function Documentation

Input * NE::NEngine::getInputManager ( void   )  [inline]

Get the InputManager used by the Engine.

Returns:
a pointer to the InputManager
Renderer * NE::NEngine::getRenderer ( void   )  [inline]

Get the Renderer used by the Engine.

Returns:
a pointer to the Renderer
NE::SpriteFactory * NE::NEngine::getSpriteFactory ( void   )  [inline]

Get the SpriteFactory.

Returns:
a pointer to the SpriteFactory
NE::SpriteLoader * NE::NEngine::getSpriteLoader ( void   )  [inline]

Get the SpriteLoader.

Returns:
a pointer to the SpriteLoader
Time * NE::NEngine::getTime ( void   )  [inline]

Get the Time used by the Engine.

Returns:
a pointer to the Time
Window * NE::NEngine::getWindow ( void   )  [inline]

Get the Window used by the Engine.

Returns:
a pointer to the Window
bool NE::NEngine::init ( void   ) 

Start the engine (and all sub API used).

Returns:
true if all goes right
bool NE::NEngine::initAPI ( void   )  [protected, pure virtual]

Init the API (internal)

Returns:
true if all goes right

Implemented in NE::SDL_Engine.

bool NE::NEngine::stop ( void   ) 

Stop the engine (and all sub API used).

Returns:
true if all goes right
bool NE::NEngine::stopAPI ( void   )  [protected, pure virtual]

Stop the API (internal)

Returns:
true if all goes right

Implemented in NE::SDL_Engine.


Member Data Documentation

InputManager used by the Engine

Renderer used by the Engine

SpriteFactory used by the Engine

SpriteLoader used by the Engine

Time* NE::NEngine::pTime [protected]

Time used by the Engine

Window* NE::NEngine::pWin [protected]

Window used by the Engine


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs
Generated on Thu Oct 6 22:11:38 2011 for WE_Kit by  doxygen 1.6.3