Murl::Logic::IState Interface Referenceabstract

The IState interface. More...

#include "murl_logic_i_state.h"

Inherited by Murl::Logic::State.

Public Member Functions

virtual IFactoryGetFactory () const =0
 Get the logic object factory. More...
 
virtual Double GetCurrentTickTime () const =0
 Get the current tick time. More...
 
virtual Double GetCurrentTickDuration () const =0
 Get the current tick duration. More...
 
virtual const IPlatformConfigurationGetPlatformConfiguration () const =0
 Get the platform configuration object. More...
 
virtual const IEngineConfigurationGetEngineConfiguration () const =0
 Get the engine configuration object. More...
 
virtual IAppConfigurationGetAppConfiguration () const =0
 Get the app configuration object. More...
 
virtual Logic::IDeviceHandlerGetDeviceHandler () const =0
 Get the device handler object. More...
 
virtual IFileInterfaceGetFileInterface () const =0
 Get the file interface object. More...
 
virtual Graph::IRootGetGraphRoot () const =0
 Get the graph root object. More...
 
virtual ILoaderGetLoader () const =0
 Get the package loader object. More...
 
virtual const Resource::ICollectionGetResourceCollection () const =0
 Get the resource collection object. More...
 
virtual const Resource::IFactoryGetResourceFactory () const =0
 Get the resource factory. More...
 
virtual const StringGetResourceText (const String &resourceId) const =0
 Get the string value from a text resource. More...
 
virtual Net::IFactoryGetNetFactory () const =0
 Get the net object factory. More...
 
virtual const Core::IStatisticsGetStatistics () const =0
 Get the core statistics interface. More...
 
virtual void SetUserDebugMessage (const String &message) const =0
 Set the user debug message on render screen. More...
 
virtual void AddUserDebugMessage (const String &message) const =0
 Append a user debug message on render screen. More...
 
virtual String GetUserDebugMessage () const =0
 Get the user debug message string. More...
 
virtual IProcessorPtr GetCurrentProcessor () const =0
 Get the current logic processor. More...
 
virtual Graph::INodeGetCurrentGraphNode () const =0
 Get the current graph node object. More...
 
virtual void SetCurrentProcessor (IProcessorPtr processor)=0
 Set the current logic processor. More...
 

Detailed Description

The IState interface.

The IState object contains all necessary engine interfaces for logic processor programming.
Logic methods typically gets an instance of the IState object by parameter.

Member Function Documentation

◆ GetFactory()

virtual IFactory* Murl::Logic::IState::GetFactory ( ) const
pure virtual

Get the logic object factory.

Returns
The logic object factory.

◆ GetCurrentTickTime()

virtual Double Murl::Logic::IState::GetCurrentTickTime ( ) const
pure virtual

Get the current tick time.

The current tick time is the absolute time from starting the engine.

Returns
The current tick time in seconds.

◆ GetCurrentTickDuration()

virtual Double Murl::Logic::IState::GetCurrentTickDuration ( ) const
pure virtual

Get the current tick duration.

Returns
The current tick duration in seconds.

◆ GetPlatformConfiguration()

virtual const IPlatformConfiguration* Murl::Logic::IState::GetPlatformConfiguration ( ) const
pure virtual

Get the platform configuration object.

Returns
The configuration object.

◆ GetEngineConfiguration()

virtual const IEngineConfiguration* Murl::Logic::IState::GetEngineConfiguration ( ) const
pure virtual

Get the engine configuration object.

Returns
The configuration object.

◆ GetAppConfiguration()

virtual IAppConfiguration* Murl::Logic::IState::GetAppConfiguration ( ) const
pure virtual

Get the app configuration object.

Returns
The configuration object.

◆ GetDeviceHandler()

virtual Logic::IDeviceHandler* Murl::Logic::IState::GetDeviceHandler ( ) const
pure virtual

Get the device handler object.

Returns
The device handler object.

◆ GetFileInterface()

virtual IFileInterface* Murl::Logic::IState::GetFileInterface ( ) const
pure virtual

Get the file interface object.

Returns
The file interface object.

◆ GetGraphRoot()

virtual Graph::IRoot* Murl::Logic::IState::GetGraphRoot ( ) const
pure virtual

Get the graph root object.

Returns
The graph root object.

◆ GetLoader()

virtual ILoader* Murl::Logic::IState::GetLoader ( ) const
pure virtual

Get the package loader object.

Returns
The package loader object.

◆ GetResourceCollection()

virtual const Resource::ICollection* Murl::Logic::IState::GetResourceCollection ( ) const
pure virtual

Get the resource collection object.

Returns
The resource collection object.

◆ GetResourceFactory()

virtual const Resource::IFactory* Murl::Logic::IState::GetResourceFactory ( ) const
pure virtual

Get the resource factory.

Returns
The resource factory.

◆ GetResourceText()

virtual const String& Murl::Logic::IState::GetResourceText ( const String resourceId) const
pure virtual

Get the string value from a text resource.

Parameters
resourceIdThe text resource identifier.
Returns
The string value of the text resource or an empty string if the resource is not available.

◆ GetNetFactory()

virtual Net::IFactory* Murl::Logic::IState::GetNetFactory ( ) const
pure virtual

Get the net object factory.

Returns
The net object factory.

◆ GetStatistics()

virtual const Core::IStatistics* Murl::Logic::IState::GetStatistics ( ) const
pure virtual

Get the core statistics interface.

Returns
The core statistics interface.

◆ SetUserDebugMessage()

virtual void Murl::Logic::IState::SetUserDebugMessage ( const String message) const
pure virtual

Set the user debug message on render screen.

The debug message is displayed if the built-in "debug" resource package is loaded. See also IAppConfiguration::SetUserDebugInfoEnabled() and IAppConfiguration::SetUserDebugInfoScaleFactor().

Parameters
messageThe message string.

◆ AddUserDebugMessage()

virtual void Murl::Logic::IState::AddUserDebugMessage ( const String message) const
pure virtual

Append a user debug message on render screen.

The debug message is displayed if the built-in "debug" resource package is loaded.

Parameters
messageThe message string to append.

◆ GetUserDebugMessage()

virtual String Murl::Logic::IState::GetUserDebugMessage ( ) const
pure virtual

Get the user debug message string.

Returns
The user debug message string.

◆ GetCurrentProcessor()

virtual IProcessorPtr Murl::Logic::IState::GetCurrentProcessor ( ) const
pure virtual

Get the current logic processor.

The current logic processor is not available on IAppGraph calls.

Returns
The current logic processor.

◆ GetCurrentGraphNode()

virtual Graph::INode* Murl::Logic::IState::GetCurrentGraphNode ( ) const
pure virtual

Get the current graph node object.

The current graph node is available on IAppGraph calls only.

Returns
The current graph node object or null.

◆ SetCurrentProcessor()

virtual void Murl::Logic::IState::SetCurrentProcessor ( IProcessorPtr  processor)
pure virtual

Set the current logic processor.

The current processor is typically set by the engine.

Parameters
processorThe current logic processor to set.

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


Copyright © 2011-2018 Spraylight GmbH.