![]() |
Murl Engine API
Version 2018.3
|
The tracker base class. More...
#include <murl_graph_i_tracker.h>
The tracker base class.
This interface represents a graph state tracker base class.
Inherited by Murl::Core::GraphTracker.
Public Member Functions | |
virtual Bool | Init ()=0 |
Initialize the tracker. More... | |
virtual Bool | DeInit ()=0 |
Deinitialize the tracker. More... | |
virtual ITracker * | GetTrackerInterface ()=0 |
Get the tracker base class interface. More... | |
virtual void | SetLogicEngineState (Logic::IEngineState *logicState)=0 |
Set the logic engine state object. More... | |
virtual Logic::IEngineState * | GetLogicEngineState () const =0 |
Get the logic engine state object to perform Logic::IAppGraph calls. More... | |
virtual Bool | SetRoot (IRoot *root)=0 |
Set the graph root object the tracker refers to. More... | |
virtual const IRoot * | GetRoot () const =0 |
Get the const graph root object the tracker refers to. More... | |
virtual Bool | SetChildrenProcessingEnabled (Bool enabled)=0 |
Enable/disable children processing. More... | |
virtual Bool | IsChildrenProcessingEnabled () const =0 |
Check if children processing is enabled. More... | |
virtual Bool | BeginFrame ()=0 |
Begin a traversal frame. More... | |
virtual Bool | EndFrame ()=0 |
End a traversal frame. More... | |
virtual UInt32 | GetCurrentFrameNumber () const =0 |
Get the current frame number. More... | |
virtual Double | GetCurrentFrameTime () const =0 |
Get the current absolute frame time. More... | |
virtual Double | GetRecentFrameDuration () const =0 |
Get the most recent frame duration. More... | |
virtual UInt32 | GetNumberOfTicksForCurrentFrame () const =0 |
Get the number of ticks processed for the current frame. More... | |
virtual INode * | BeginCurrentNode (INode *currentNode)=0 |
Begin processing of a node during traversal. More... | |
virtual INode * | EndCurrentNode (INode *previousNode)=0 |
End processing of a node during traversal. More... | |
virtual INode * | GetCurrentNode () const =0 |
Get the current node during traversal. More... | |
virtual Bool | RecordNodeState (IEnums::TraversalPhase phase)=0 |
Record the current node's state during traversal for a given phase. More... | |
virtual const IAppConfiguration * | GetAppConfiguration () const =0 |
Get the constant application configuration. More... | |
virtual const IEngineConfiguration * | GetEngineConfiguration () const =0 |
Get the constant engine configuration. More... | |
virtual const IPlatformConfiguration * | GetPlatformConfiguration () const =0 |
Get the constant platform configuration. More... | |
virtual Bool | IsSuspendableResource (IEnums::SuspendableResource suspendableResource) const =0 |
Check if a given flag is set in IEngineConfiguration::GetSuspendableResources(). More... | |
virtual void | ResetNumberOfTraversedNodes ()=0 |
Reset the number of traversed nodes to zero. More... | |
virtual void | IncrementNumberOfTraversedNodes ()=0 |
Increment the number of traversed nodes by one. More... | |
virtual UInt32 | GetNumberOfTraversedNodes () const =0 |
Get the most recent total number of traversed nodes. More... | |
virtual void | PushUserData (SInt32 id, void *userData)=0 |
Push a user data object with given ID to the stack. More... | |
virtual void | PopUserData (SInt32 id)=0 |
Pop a user data object off the stack with a given ID. More... | |
virtual void * | GetRecentUserData (SInt32 id) const =0 |
Get the most recent user data object from the stack with a given ID. More... | |
virtual void | ClearResults ()=0 |
Clear the list of result messages. | |
virtual void | AddResult (const ITrackerResult &result)=0 |
Add a result message during traversal. More... | |
virtual const Array< const ITrackerResult * > & | GetResults () const =0 |
Get the array of result messages added during traversal. More... | |
|
pure virtual |
Initialize the tracker.
Called by the engine.
|
pure virtual |
Deinitialize the tracker.
Called by the engine.
|
pure virtual |
Get the tracker base class interface.
|
pure virtual |
Set the logic engine state object.
logicState | The logic engine state object. |
|
pure virtual |
Get the logic engine state object to perform Logic::IAppGraph calls.
Set the graph root object the tracker refers to.
Called by the engine.
root | The root object. |
|
pure virtual |
Get the const graph root object the tracker refers to.
Enable/disable children processing.
Called by the engine.
enabled | If true, children processing is enabled. |
|
pure virtual |
Check if children processing is enabled.
|
pure virtual |
Begin a traversal frame.
Called by the engine.
|
pure virtual |
End a traversal frame.
Called by the engine.
|
pure virtual |
Get the current frame number.
|
pure virtual |
Get the current absolute frame time.
|
pure virtual |
Get the most recent frame duration.
|
pure virtual |
Get the number of ticks processed for the current frame.
Begin processing of a node during traversal.
currentNode | The current node. |
End processing of a node during traversal.
previousNode | The node returned from BeginCurrentNode(). |
|
pure virtual |
Get the current node during traversal.
|
pure virtual |
Record the current node's state during traversal for a given phase.
This only gets called during traversal when state recording is enabled for a node via INode::SetStateRecordingEnabled(true).
phase | The traversal phase |
|
pure virtual |
Get the constant application configuration.
|
pure virtual |
Get the constant engine configuration.
|
pure virtual |
Get the constant platform configuration.
|
pure virtual |
Check if a given flag is set in IEngineConfiguration::GetSuspendableResources().
suspendableResource | The suspendable resource flag to check. |
|
pure virtual |
Reset the number of traversed nodes to zero.
For statistic purposes.
|
pure virtual |
Increment the number of traversed nodes by one.
For statistic purposes.
|
pure virtual |
Get the most recent total number of traversed nodes.
For statistic purposes.
|
pure virtual |
Push a user data object with given ID to the stack.
id | The unique user data ID previously acquired via IRoot::AcquireUserDataId(). |
userData | The user data object. |
|
pure virtual |
Pop a user data object off the stack with a given ID.
id | The unique user data ID previously acquired via IRoot::AcquireUserDataId(). |
|
pure virtual |
Get the most recent user data object from the stack with a given ID.
id | The unique user data ID previously acquired via IRoot::AcquireUserDataId(). |
|
pure virtual |
Add a result message during traversal.
result | The result message to add. |
|
pure virtual |
Get the array of result messages added during traversal.