Murl::Factory Class Reference

The factory class used to create and initialize the engine, configuration and device handler instances. More...

#include "murl_factory.h"

Public Member Functions

 Factory ()
 The default constructor.
 
virtual ~Factory ()
 The destructor.
 
Bool Init (IPlatform *platform)
 Initialize the engine. More...
 
Bool DeInit ()
 Deinitialize the engine. More...
 
IEngineCreateEngine ()
 Create an engine object. More...
 
Bool DestroyEngine (IEngine *&engine)
 Destroy an engine object. More...
 
IPlatformConfigurationCreatePlatformConfiguration ()
 Create and initialize the platform configuration object. More...
 
Bool DestroyPlatformConfiguration (IPlatformConfiguration *&config)
 Destroy the platform configuration object. More...
 
IDeviceHandlerCreateDeviceHandler ()
 Create a device handler object. More...
 
Bool DestroyDeviceHandler (IDeviceHandler *&deviceHandler)
 Destroy device handler object. More...
 

Detailed Description

The factory class used to create and initialize the engine, configuration and device handler instances.

Member Function Documentation

◆ Init()

Bool Murl::Factory::Init ( IPlatform *  platform)

Initialize the engine.

Calls the Murl::Engine::Init() method.

Parameters
platformThe platform.
Returns
true if successful.

◆ DeInit()

Bool Murl::Factory::DeInit ( )

Deinitialize the engine.

Calls the Murl::Engine::DeInit() method.

Returns
true if successful.

◆ CreateEngine()

IEngine* Murl::Factory::CreateEngine ( )

Create an engine object.

Returns
The created engine object, or null if failed.

◆ DestroyEngine()

Bool Murl::Factory::DestroyEngine ( IEngine *&  engine)

Destroy an engine object.

Parameters
engineA reference to the engine pointer. After destruction the pointer is set to null.
Returns
true if successful.

◆ CreatePlatformConfiguration()

IPlatformConfiguration* Murl::Factory::CreatePlatformConfiguration ( )

Create and initialize the platform configuration object.

Create and initialize the internal IAppConfiguration object and the IEngineConfiguration object.

Returns
The created platform configuration object, or null if failed.

◆ DestroyPlatformConfiguration()

Bool Murl::Factory::DestroyPlatformConfiguration ( IPlatformConfiguration *&  config)

Destroy the platform configuration object.

Destroy the internal IAppConfiguration object and the IEngineConfiguration object.

Parameters
configA reference to the platform configuration pointer. After destruction the pointer is set to null.
Returns
true if successful.

◆ CreateDeviceHandler()

IDeviceHandler* Murl::Factory::CreateDeviceHandler ( )

Create a device handler object.

Returns
The created device handler object, or null if failed.

◆ DestroyDeviceHandler()

Bool Murl::Factory::DestroyDeviceHandler ( IDeviceHandler *&  deviceHandler)

Destroy device handler object.

Parameters
deviceHandlerA reference to the device handler pointer. After destruction the pointer is set to null.
Returns
true if successful.

The documentation for this class was generated from the following file:
  • murl_factory.h


Copyright © 2011-2018 Spraylight GmbH.