Class QuerySimulationModule
Module responsible for simulating queries in edit mode
Inheritance
QuerySimulationModule
Syntax
[ScriptableSettingsPath("Assets/MARS/Settings")]
public class QuerySimulationModule : EditorScriptableSettings<QuerySimulationModule>, IModuleDependency<MARSDatabase>, IModuleDependency<MARSQueryBackend>, IModuleDependency<ReasoningModule>, IModuleDependency<SlowTaskModule>, IModuleDependency<SimulatedObjectsManager>, IModuleDependency<MARSEnvironmentManager>, IModuleDependency<MARSEntityEditorModule>, IModuleDependency<FunctionalityInjectionModule>, IModuleDependency<SimulationSceneModule>, IModuleDependency<SceneWatchdogModule>, IModuleDependency<QueryPipelinesModule>, IModuleDependency<EvaluationSchedulerModule>, IModule, IUsesDatabaseQuerying, IUsesCameraOffset, IFunctionalitySubscriber<IProvidesCameraOffset>, IFunctionalitySubscriber
Properties
providersRoot
Declaration
public GameObject providersRoot { get; }
Property Value
sceneIsSimulatable
Declaration
public static bool sceneIsSimulatable { get; }
Property Value
simulatedDataAvailable
Declaration
public bool simulatedDataAvailable { get; }
Property Value
simulating
Declaration
public bool simulating { get; }
Property Value
simulatingTemporal
Declaration
public bool simulatingTemporal { get; }
Property Value
Methods
ConnectDependency(MARSDatabase)
Declaration
public void ConnectDependency(MARSDatabase dependency)
Parameters
Implements
ConnectDependency(EvaluationSchedulerModule)
Declaration
public void ConnectDependency(EvaluationSchedulerModule dependency)
Parameters
Implements
ConnectDependency(MARSEntityEditorModule)
Declaration
public void ConnectDependency(MARSEntityEditorModule dependency)
Parameters
Implements
ConnectDependency(MARSEnvironmentManager)
Declaration
public void ConnectDependency(MARSEnvironmentManager dependency)
Parameters
Implements
ConnectDependency(QueryPipelinesModule)
Declaration
public void ConnectDependency(QueryPipelinesModule dependency)
Parameters
Implements
ConnectDependency(ReasoningModule)
Declaration
public void ConnectDependency(ReasoningModule dependency)
Parameters
Implements
ConnectDependency(SceneWatchdogModule)
Declaration
public void ConnectDependency(SceneWatchdogModule dependency)
Parameters
Implements
ConnectDependency(SimulatedObjectsManager)
Declaration
public void ConnectDependency(SimulatedObjectsManager dependency)
Parameters
Implements
ConnectDependency(SimulationSceneModule)
Declaration
public void ConnectDependency(SimulationSceneModule dependency)
Parameters
Implements
ConnectDependency(SlowTaskModule)
Declaration
public void ConnectDependency(SlowTaskModule dependency)
Parameters
Implements
Declaration
public void ConnectDependency(FunctionalityInjectionModule dependency)
Parameters
Implements
LoadModule()
Declaration
Implements
RequestSimulationModeSelection(SimulationModeSelection)
Request that the next simulation should run in either single-frame mode or temporal mode
Declaration
public void RequestSimulationModeSelection(SimulationModeSelection simModeSelection)
Parameters
RestartSimulationIfNeeded(Boolean)
If any objects are using the simulation scene, this method sets a flag that a new simulation should happen as soon as possible
Declaration
public void RestartSimulationIfNeeded(bool stopSimulationImmediately = false)
Parameters
| Type |
Name |
Description |
| Boolean |
stopSimulationImmediately |
If true and if temporal simulation is running, this method will
immediately stop simulation. If TemporalMode has been requested for the
next simulation then this method will invoke BeforeTemporalSimulationRestart before stopping simulation.
|
SimulateOneShot()
Runs simulation over a single frame.
This method repeatedly checks for query matches until there are no more to be found.
Declaration
public void SimulateOneShot()
StartTemporalSimulation()
Starts query simulation that runs frame-to-frame
Declaration
public void StartTemporalSimulation()
StopTemporalSimulation()
Stops query simulation that runs frame-to-frame
Declaration
public void StopTemporalSimulation()
UnloadModule()
Declaration
public void UnloadModule()
Implements
Events
addCustomProviders
Called right before default providers are setup when starting simulation.
The list should be filled out with providers that you want this module to add before it sets up default providers.
Provider game objects created in this callback should be created using GameObjectUtils.Create so that they get
added to the simulation scene.
Declaration
public static event Action<List<IFunctionalityProvider>> addCustomProviders
Event Type
BeforeCleanupProviders
Declaration
public static event Action BeforeCleanupProviders
Event Type
BeforeSimulationSetup
Declaration
public static event Action BeforeSimulationSetup
Event Type
BeforeTemporalSimulationRestart
Declaration
public static event Action BeforeTemporalSimulationRestart
Event Type
OnOneShotSimulationStart
Declaration
public static event Action OnOneShotSimulationStart
Event Type
onTemporalSimulationStart
Declaration
public static event Action onTemporalSimulationStart
Event Type
onTemporalSimulationStop
Declaration
public static event Action onTemporalSimulationStop
Event Type
simulationDone
Declaration
public static event Action simulationDone
Event Type
Explicit Interface Implementations
Declaration
IProvidesCameraOffset IFunctionalitySubscriber<IProvidesCameraOffset>.provider { get; set; }
Returns
Implements
Declaration
void IModuleDependency<MARSQueryBackend>.ConnectDependency(MARSQueryBackend dependency)
Parameters
Implements