Class SimulationSettings

Settings for simulation of content

Inheritance

object

Object

ScriptableObject

ScriptableSettingsBase

ScriptableSettingsBase<SimulationSettings>

EditorScriptableSettings<SimulationSettings>

SimulationSettings

Implements

ISerializationCallbackReceiver

Inherited Members

EditorScriptableSettings<SimulationSettings>.instance

ScriptableSettingsBase<SimulationSettings>.k_HasCustomPath

ScriptableSettingsBase<SimulationSettings>.s_Instance

ScriptableSettingsBase<SimulationSettings>.Save(string)

ScriptableSettingsBase<SimulationSettings>.GetFilePath()

ScriptableSettingsBase.k_PathExceptionMessage

ScriptableSettingsBase.GetInstanceByType(Type)

ScriptableSettingsBase.OnLoaded()

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.MARS.Simulation

Assembly: Unity.MARS.Editor.dll

Syntax

[ScriptableSettingsPath("Assets/MARS/UserSettings")]
[MovedFrom("Unity.MARS.Simulation")]
public class SimulationSettings : EditorScriptableSettings<SimulationSettings>, ISerializationCallbackReceiver

Properties

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
bool

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
bool

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
bool

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
bool

IsUsingRecording

Returns true if simulation is currently using a recording

Declaration

public bool IsUsingRecording { get; }

Property Value

Type	Description
bool

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
bool

ShowSimulatedData

When enabled, AR data for the simulated environment will be visualized

Declaration

public bool ShowSimulatedData { get; set; }

Property Value

Type	Description
bool

ShowSimulatedEnvironment

When enabled, the simulated environment will be visualized

Declaration

public bool ShowSimulatedEnvironment { get; set; }

Property Value

Type	Description
bool

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
float

UseSyntheticRecording

If enabled, simulation will use the currently selected synthetic recording

Declaration

public bool UseSyntheticRecording { get; set; }

Property Value

Type	Description
bool

WebCamDeviceIndex

Index of the current web cam device being used for Live Environment Mode

Declaration

public int WebCamDeviceIndex { get; set; }

Property Value

Type	Description
int

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

Implements

ISerializationCallbackReceiver