Class MarsRecordingPlaybackModule

Module that controls playback of a session recording Timeline in Simulation

Inheritance

object

Object

ScriptableObject

ScriptableSettingsBase

ScriptableSettingsBase<MarsRecordingPlaybackModule>

EditorScriptableSettings<MarsRecordingPlaybackModule>

MarsRecordingPlaybackModule

Implements

IModuleDependency<QuerySimulationModule>

IModuleDependency<MARSSceneModule>

IModuleDependency<SimulationRecordingManager>

IModuleMarsUpdate

IModuleBehaviorCallbacks

IModule

Inherited Members

EditorScriptableSettings<MarsRecordingPlaybackModule>.instance

ScriptableSettingsBase<MarsRecordingPlaybackModule>.k_HasCustomPath

ScriptableSettingsBase<MarsRecordingPlaybackModule>.s_Instance

ScriptableSettingsBase<MarsRecordingPlaybackModule>.Save(string)

ScriptableSettingsBase<MarsRecordingPlaybackModule>.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.Recording")]
public class MarsRecordingPlaybackModule : EditorScriptableSettings<MarsRecordingPlaybackModule>, IModuleDependency<QuerySimulationModule>, IModuleDependency<MARSSceneModule>, IModuleDependency<SimulationRecordingManager>, IModuleMarsUpdate, IModuleBehaviorCallbacks, IModule

Fields

AutoSyncTooltip

Tooltip for when auto sync is enabled

Declaration

public const string AutoSyncTooltip = "When enabled, Simulation will automatically restart when the time in the session recording Timeline is changed"

Field Value

Type	Description
string

Properties

AutoSyncWithTimeChanges

Whether Simulation should automatically restart when the time in the session recording Timeline is changed

Declaration

public bool AutoSyncWithTimeChanges { get; set; }

Property Value

Type	Description
bool

IsRecordingAvailable

Whether Simulation is currently using a session recording

Declaration

public bool IsRecordingAvailable { get; }

Property Value

Type	Description
bool

IsRecordingPaused

Whether there is an active session recording for Simulation and it is currently paused

Declaration

public bool IsRecordingPaused { get; }

Property Value

Type	Description
bool

IsRecordingPlaying

Whether the session recording for Simulation is currently playing

Declaration

public bool IsRecordingPlaying { get; }

Property Value

Type	Description
bool

SyncEndTime

The time at which Simulation finishes syncing with the Timeline. This is the time in the Timeline at the moment before Simulation automatically restarted.

Declaration

public double SyncEndTime { get; }

Property Value

Type	Description
double

TimelineSyncProgress

Progress of time while Simulation is syncing with the Timeline. This is a value between 0 and 1 where 0 means Simulation has just started syncing and time is 0, and 1 means Simulation is done syncing and time is SyncEndTime.

Declaration

public float TimelineSyncProgress { get; }

Property Value

Type	Description
float

TimelineSyncState

The state of Simulation in relation to the current time in the session recording Timeline

Declaration

public SimulationTimeSyncState TimelineSyncState { get; }

Property Value

Type	Description
SimulationTimeSyncState

Events

RecordingEndReached

Called when recording playback has reached the end of the Timeline

Declaration

public event Action RecordingEndReached

Event Type

Type	Description
Action

Implements

Unity.XRTools.ModuleLoader.IModuleDependency<T>

Unity.XRTools.ModuleLoader.IModuleDependency<T>

Unity.XRTools.ModuleLoader.IModuleDependency<T>

IModuleMarsUpdate

Unity.XRTools.ModuleLoader.IModuleBehaviorCallbacks

Unity.XRTools.ModuleLoader.IModule