venom::common::VenomEngine Class Reference

Main class of the engine This class will be the main entry point of the engine. It will contain all the main components of the engine, as singleton are harder to manage, especially for unit tests and memory management. More...

#include <VenomEngine.h>

Static Public Member Functions
static VenomEngine *	GetInstance ()
	Gets instance of VenomEngine.
static Error	RunEngine (int argc, char **argv)
	Runs the engine.
static Error	SetScene (const String &scenefileName)
	Loads a scene from a file.
static Error	SetScene (const SceneCallback &sceneCallback)
	Loads a scene from a callback.
static void	AddLoopCallback (const LoopCallback &loopCallback)
	Adds a loop callback.
static void	AddInputCallback (const InputCallback &inputCallback)
	Adds a loop callback.

Public Attributes
UPtr< PluginManager >	pluginManager

Detailed Description

Main class of the engine This class will be the main entry point of the engine. It will contain all the main components of the engine, as singleton are harder to manage, especially for unit tests and memory management.

Member Function Documentation

AddInputCallback()

void venom::common::VenomEngine::AddInputCallback ( const InputCallback & inputCallback )

static

Adds a loop callback.

Parameters

inputCallback

AddLoopCallback()

void venom::common::VenomEngine::AddLoopCallback ( const LoopCallback & loopCallback )

static

Adds a loop callback.

Parameters

loopCallback

GetInstance()

VenomEngine * venom::common::VenomEngine::GetInstance ( )

static

Gets instance of VenomEngine.

Returns

VenomEngine *

RunEngine()

Error venom::common::VenomEngine::RunEngine ( int argc, char ** argv )

static

Runs the engine.

Parameters

argc
argv

Returns

error if any, refer to Error enum for more information

SetScene() [1/2]

Error venom::common::VenomEngine::SetScene ( const SceneCallback & sceneCallback )

static

Loads a scene from a callback.

Parameters

sceneCallback

Returns

error

SetScene() [2/2]

Error venom::common::VenomEngine::SetScene ( const String & scenefileName )

static

Loads a scene from a file.

Parameters

scenefileName

Returns

error

---

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

• /Users/kevinpruvost/Bossing/Perso/VenomEngine/lib/common/include/venom/common/VenomEngine.h
• /Users/kevinpruvost/Bossing/Perso/VenomEngine/lib/common/src/VenomEngine.cc