Class SimulationSettings
Settings for simulation of content
Inheritance
Inherited Members
Namespace: Unity.MARS.Simulation
Syntax
[ScriptableSettingsPath("Assets/MARS/UserSettings")]
public class SimulationSettings : EditorScriptableSettings<SimulationSettings>, ISerializationCallbackReceiverProperties
AutoResetDevicePose
When enabled, the simulated device will reset back to its default starting pose after each simulation
Declaration
public bool AutoResetDevicePose { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
AutoSyncWithSceneChanges
When enabled, Simulation will automatically restart when changes are made to the active scene
Declaration
public bool AutoSyncWithSceneChanges { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
EnvironmentMode
The current simulated environment mode
Declaration
public EnvironmentMode EnvironmentMode { get; }Property Value
| Type | Description |
|---|---|
| EnvironmentMode |
EnvironmentPrefab
The prefab for the current synthetic environment
Declaration
public GameObject EnvironmentPrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject |
FindAllMatchingDataPerQuery
When enabled, simulation will check for all data that would match a query, even if that data doesn't get used
Declaration
public bool FindAllMatchingDataPerQuery { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
IndependentRecording
The current recording being used for Recorded Environment Mode
Declaration
public SessionRecordingInfo IndependentRecording { get; set; }Property Value
| Type | Description |
|---|---|
| SessionRecordingInfo |
IsSpatialContextAvailable
Whether there is any spatial context set up from which the simulation can receive data
Declaration
public bool IsSpatialContextAvailable { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
IsUsingRecording
Returns true if simulation is currently using a recording
Declaration
public bool IsUsingRecording { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
IsVideoEnvironment
Checks whether the current environment is video-based. Future environment modes that support video controls (play/pause, etc) should be added here.
Declaration
public bool IsVideoEnvironment { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
ShowSimulatedData
When enabled, AR data for the simulated environment will be visualized
Declaration
public bool ShowSimulatedData { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
ShowSimulatedEnvironment
When enabled, the simulated environment will be visualized
Declaration
public bool ShowSimulatedEnvironment { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
TimeToFinalizeSceneModification
The amount of time to wait after modifying the active scene before the simulation is marked as Out of Sync. If another change happens during this time then the timer is reset.
Declaration
public float TimeToFinalizeSceneModification { get; }Property Value
| Type | Description |
|---|---|
| Single |
UseSyntheticRecording
If enabled, simulation will use the currently selected synthetic recording
Declaration
public bool UseSyntheticRecording { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
WebCamDeviceIndex
Index of the current web cam device being used for Live Environment Mode
Declaration
public int WebCamDeviceIndex { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
GetCurrentRecording()
Get the current recording being used for simulation
Declaration
public SessionRecordingInfo GetCurrentRecording()Returns
| Type | Description |
|---|---|
| SessionRecordingInfo | The current recording |
GetRecordingForCurrentSyntheticEnvironment()
Get the current recording for a given synthetic environment
Declaration
public SessionRecordingInfo GetRecordingForCurrentSyntheticEnvironment()Returns
| Type | Description |
|---|---|
| SessionRecordingInfo | The current synthetic environment recording |
SetRecordingForCurrentSyntheticEnvironment(SessionRecordingInfo)
Set the recording for the current synthetic environment
Declaration
public void SetRecordingForCurrentSyntheticEnvironment(SessionRecordingInfo recording)Parameters
| Type | Name | Description |
|---|---|---|
| SessionRecordingInfo | recording | The recording to set for the current synthetic environment |
Explicit Interface Implementations
ISerializationCallbackReceiver.OnAfterDeserialize()
Declaration
void ISerializationCallbackReceiver.OnAfterDeserialize()Implements
ISerializationCallbackReceiver.OnBeforeSerialize()
Declaration
void ISerializationCallbackReceiver.OnBeforeSerialize()