The tracker used for initialization traversals. More...

#include "murl_graph_i_init_tracker.h"

Inherited by Murl::Core::GraphInitTracker.

Public Member Functions

virtual Bool Init ()=0
 Initialize the tracker. More...
 
virtual Bool DeInit ()=0
 DeInitialize the tracker. More...
 
virtual ITrackerGetTrackerInterface ()=0
 Get the tracker base class interface. More...
 
virtual const IRootGetRoot () const =0
 Get the constant graph root object the tracker refers to. More...
 
virtual IRootGetRoot ()=0
 Get the mutable graph root object the tracker refers to. More...
 
virtual Bool SetCancelled (Bool cancelled)=0
 Signal the tracker that initialization should be aborted. More...
 
virtual Bool IsCancelled () const =0
 Check if initialization should be aborted. More...
 
virtual IFactoryGetGraphFactory () const =0
 Get the engine's graph factory. More...
 
virtual Input::ITouchableHandlerGetTouchableHandler () const =0
 Get the input touchable handler used to submit input objects. More...
 
virtual Output::IDeviceHandlerGetOutputDeviceHandler () const =0
 Get the engine's output device handler. More...
 
virtual Video::IRendererGetVideoRenderer () const =0
 Get the engine's chosen video renderer. More...
 
virtual Audio::IRendererGetAudioRenderer () const =0
 Get the engine's chosen audio renderer. More...
 
virtual Physics::ISimulatorGetPhysicsSimulator () const =0
 Get the engine's chosen physics simulator. More...
 
virtual Resource::ICollectionGetResourceCollection () const =0
 Get the engine's main resource collection. More...
 
virtual INamespaceBeginCurrentNamespace (INamespace *currentNamespace)=0
 Begin processing of a namespace node during traversal. More...
 
virtual INamespaceEndCurrentNamespace (INamespace *previousNamespace)=0
 End processing of a namespace node during traversal. More...
 
virtual INamespaceGetCurrentNamespace () const =0
 Get the current namespace node. More...
 
virtual Core::ITasksGetTasks ()=0
 Get the engines tasks system. More...
 

Detailed Description

The tracker used for initialization traversals.

This interface represents a graph state tracker used during Graph::INode::Init and Graph::INode::Resume traversals, as well as the respective methods in Graph::IController, Graph::IGenericNodeTarget and Graph::IGenericResourceTarget.

Member Function Documentation

◆ Init()

virtual Bool Murl::Graph::IInitTracker::Init ( )
pure virtual

Initialize the tracker.

Called by the engine.

Returns
true if successful.

◆ DeInit()

virtual Bool Murl::Graph::IInitTracker::DeInit ( )
pure virtual

DeInitialize the tracker.

Called by the engine.

Returns
true if successful.

◆ GetTrackerInterface()

virtual ITracker* Murl::Graph::IInitTracker::GetTrackerInterface ( )
pure virtual

Get the tracker base class interface.

Returns
The tracker base class interface.

◆ GetRoot() [1/2]

virtual const IRoot* Murl::Graph::IInitTracker::GetRoot ( ) const
pure virtual

Get the constant graph root object the tracker refers to.

Returns
The constant graph root object.

◆ GetRoot() [2/2]

virtual IRoot* Murl::Graph::IInitTracker::GetRoot ( )
pure virtual

Get the mutable graph root object the tracker refers to.

Returns
The mutable graph root object.

◆ SetCancelled()

virtual Bool Murl::Graph::IInitTracker::SetCancelled ( Bool  cancelled)
pure virtual

Signal the tracker that initialization should be aborted.

Called by the package loading mechanism, when loading is cancelled.

Parameters
cancelledIf true, initialization should be aborted.
Returns
true if successful.

◆ IsCancelled()

virtual Bool Murl::Graph::IInitTracker::IsCancelled ( ) const
pure virtual

Check if initialization should be aborted.

Returns
true if initialization should be aborted.

◆ GetGraphFactory()

virtual IFactory* Murl::Graph::IInitTracker::GetGraphFactory ( ) const
pure virtual

Get the engine's graph factory.

Returns
The graph factory.

◆ GetTouchableHandler()

virtual Input::ITouchableHandler* Murl::Graph::IInitTracker::GetTouchableHandler ( ) const
pure virtual

Get the input touchable handler used to submit input objects.

Returns
The input touchable handler.

◆ GetOutputDeviceHandler()

virtual Output::IDeviceHandler* Murl::Graph::IInitTracker::GetOutputDeviceHandler ( ) const
pure virtual

Get the engine's output device handler.

Returns
The output device handler.

◆ GetVideoRenderer()

virtual Video::IRenderer* Murl::Graph::IInitTracker::GetVideoRenderer ( ) const
pure virtual

Get the engine's chosen video renderer.

Returns
The video renderer.

◆ GetAudioRenderer()

virtual Audio::IRenderer* Murl::Graph::IInitTracker::GetAudioRenderer ( ) const
pure virtual

Get the engine's chosen audio renderer.

Returns
The audio renderer.

◆ GetPhysicsSimulator()

virtual Physics::ISimulator* Murl::Graph::IInitTracker::GetPhysicsSimulator ( ) const
pure virtual

Get the engine's chosen physics simulator.

Returns
The physics simulator.

◆ GetResourceCollection()

virtual Resource::ICollection* Murl::Graph::IInitTracker::GetResourceCollection ( ) const
pure virtual

Get the engine's main resource collection.

Returns
The resource collection.

◆ BeginCurrentNamespace()

virtual INamespace* Murl::Graph::IInitTracker::BeginCurrentNamespace ( INamespace currentNamespace)
pure virtual

Begin processing of a namespace node during traversal.

Parameters
currentNamespaceThe current namespace node.
Returns
The previous namespace node.

◆ EndCurrentNamespace()

virtual INamespace* Murl::Graph::IInitTracker::EndCurrentNamespace ( INamespace previousNamespace)
pure virtual

End processing of a namespace node during traversal.

Parameters
previousNamespaceThe namespace node returned from BeginCurrentNamespace().
Returns
The current namespace node.

◆ GetCurrentNamespace()

virtual INamespace* Murl::Graph::IInitTracker::GetCurrentNamespace ( ) const
pure virtual

Get the current namespace node.

Returns
The current namespace node.

◆ GetTasks()

virtual Core::ITasks* Murl::Graph::IInitTracker::GetTasks ( )
pure virtual

Get the engines tasks system.

Returns
The tasks system.

The documentation for this interface was generated from the following file:
  • murl_graph_i_init_tracker.h


Copyright © 2011-2024 Spraylight GmbH.