![]() |
Murl Engine API
Version 2018.3
|
The IEngineState interface. More...
#include <murl_logic_i_engine_state.h>
The IEngineState interface.
The IEngineState object is created and used by the engine's core only. Application implementations are using the IState object which is passed via the IEngineProcessor methods.
Inherited by Murl::Logic::State.
Public Member Functions | |
virtual Bool | Init ()=0 |
Initialize the state object. More... | |
virtual Bool | DeInit ()=0 |
Deinitialize the state object. More... | |
virtual Bool | Lock ()=0 |
Lock the state object. More... | |
virtual Bool | Unlock ()=0 |
Unlock the state object. More... | |
virtual void | SetGraphRoot (Graph::IRoot *graphRoot)=0 |
Set the graph root object. More... | |
virtual void | SetResourceCollection (const Resource::ICollection *resourceCollection)=0 |
Set the resource collection object. More... | |
virtual void | SetCurrentTickTime (Double time)=0 |
Set the current tick time. More... | |
virtual void | SetCurrentTickDuration (Double time)=0 |
Set the current tick duration. More... | |
virtual void | SetCurrentGraphNode (Graph::INode *node)=0 |
Set the current graph node object. More... | |
virtual Bool | InitProcessor (IProcessorPtr processor)=0 |
Initialze a processor. More... | |
virtual Bool | DeInitProcessor (IProcessorPtr processor)=0 |
Deinitialze a processor. More... | |
virtual Bool | AddProcessor (IProcessorPtr processor)=0 |
Add a logic processor. More... | |
virtual Bool | RemoveProcessor (IProcessorPtr processor)=0 |
Remove a logic processor. More... | |
virtual UInt32 | GetNumberOfProcessors () const =0 |
Get the number of logic processors. More... | |
virtual IProcessorPtr | GetProcessor (UInt32 index) const =0 |
Get an logic processor by index. More... | |
virtual void | ProcessTick (UInt32 index)=0 |
Execute a logic tick. More... | |
virtual void | ProcessFrame (UInt32 index)=0 |
Execute a frame tick. More... | |
virtual void | FinishTick (UInt32 index)=0 |
Finish a logic tick. More... | |
virtual void | FinishFrame (UInt32 index)=0 |
Finish a frame tick. More... | |
virtual void | PackageWillBeLoaded (UInt32 index, IPackage *package)=0 |
Report the beginning of package loading. More... | |
virtual void | PackageWasLoaded (UInt32 index, IPackage *package)=0 |
Report the succesful loading of a package. More... | |
virtual void | PackageFailedLoading (UInt32 index, IPackage *package)=0 |
Report failed loading a package. More... | |
virtual void | PackageWillBeUnloaded (UInt32 index, IPackage *package)=0 |
Report the beginning of package unloading. More... | |
virtual void | PackageWasUnloaded (UInt32 index, IPackage *package)=0 |
Report the succesful unloading of a package. More... | |
virtual void | PackageFailedUnloading (UInt32 index, IPackage *package)=0 |
Report failed unloading a package. More... | |
virtual void | RunStateChanged (UInt32 index, IEnums::AppRunState currentState, IEnums::AppRunState previousState)=0 |
Report a change of the application run state. More... | |
virtual const IState * | GetIState () const =0 |
Get the constant IState object. More... | |
|
pure virtual |
Initialize the state object.
|
pure virtual |
Deinitialize the state object.
|
pure virtual |
Lock the state object.
|
pure virtual |
Unlock the state object.
|
pure virtual |
Set the graph root object.
graphRoot | The graph root object. |
|
pure virtual |
Set the resource collection object.
resourceCollection | The resource collection object. |
|
pure virtual |
Set the current tick time.
The current tick time is the absolute time from starting the engine.
time | The current tick time in seconds. |
|
pure virtual |
Set the current tick duration.
time | The current tick duration in seconds. |
|
pure virtual |
Set the current graph node object.
node | The graph node object. The current graph node is set for IAppGraph calls only. |
|
pure virtual |
Initialze a processor.
processor | The logic processor to initialize. |
|
pure virtual |
Deinitialze a processor.
processor | The logic processor to deinitialize. |
|
pure virtual |
Add a logic processor.
processor | The logic processor to add. |
|
pure virtual |
Remove a logic processor.
processor | The logic processor to remove. |
|
pure virtual |
Get the number of logic processors.
|
pure virtual |
Get an logic processor by index.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
|
pure virtual |
Execute a logic tick.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
|
pure virtual |
Execute a frame tick.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
|
pure virtual |
Finish a logic tick.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
|
pure virtual |
Finish a frame tick.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
|
pure virtual |
Report the beginning of package loading.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
package | The package to load. |
|
pure virtual |
Report the succesful loading of a package.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
package | The package loaded. |
|
pure virtual |
Report failed loading a package.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
package | The package which failed loading. |
|
pure virtual |
Report the beginning of package unloading.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
package | The package to unload. |
|
pure virtual |
Report the succesful unloading of a package.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
package | The package unloaded. |
|
pure virtual |
Report failed unloading a package.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
package | The package which failed unloading. |
|
pure virtual |
Report a change of the application run state.
A valid index is [0 .. GetNumberOfEngineProcessors() - 1].
index | The zero-based index of the logic processor. |
currentState | The current run state. |
previousState | The previous run state. |
|
pure virtual |