Class MarsRecordingPlaybackModule

Module that controls playback of a session recording Timeline in Simulation

Inheritance
Object
ScriptableSettingsBase
ScriptableSettingsBase<MarsRecordingPlaybackModule>
EditorScriptableSettings<MarsRecordingPlaybackModule>
MarsRecordingPlaybackModule
Inherited Members
Namespace: Unity.MARS.Recording
Syntax
[ScriptableSettingsPath("Assets/MARS/UserSettings")]
public class MarsRecordingPlaybackModule : EditorScriptableSettings<MarsRecordingPlaybackModule>, IModuleDependency<QuerySimulationModule>, IModuleDependency<MARSSceneModule>, IModuleDependency<SimulationRecordingManager>, IModuleMarsUpdate, IModuleBehaviorCallbacks, IModule

Fields

AutoSyncTooltip

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
Boolean

IsRecordingAvailable

Whether Simulation is currently using a session recording

Declaration
public bool IsRecordingAvailable { get; }
Property Value
Type Description
Boolean

IsRecordingPaused

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

Declaration
public bool IsRecordingPaused { get; }
Property Value
Type Description
Boolean

IsRecordingPlaying

Whether the session recording for Simulation is currently playing

Declaration
public bool IsRecordingPlaying { get; }
Property Value
Type Description
Boolean

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
Single

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

Methods

ConnectDependency(MARSSceneModule)

Declaration
public void ConnectDependency(MARSSceneModule dependency)
Parameters
Type Name Description
MARSSceneModule dependency
Implements

ConnectDependency(QuerySimulationModule)

Declaration
public void ConnectDependency(QuerySimulationModule dependency)
Parameters
Type Name Description
QuerySimulationModule dependency
Implements

ConnectDependency(SimulationRecordingManager)

Declaration
public void ConnectDependency(SimulationRecordingManager dependency)
Parameters
Type Name Description
SimulationRecordingManager dependency
Implements

LoadModule()

Declaration
public void LoadModule()
Implements

OnBehaviorAwake()

Declaration
public void OnBehaviorAwake()
Implements

OnBehaviorDestroy()

Declaration
public void OnBehaviorDestroy()
Implements

OnBehaviorDisable()

Declaration
public void OnBehaviorDisable()
Implements

OnBehaviorEnable()

Declaration
public void OnBehaviorEnable()
Implements

OnBehaviorStart()

Declaration
public void OnBehaviorStart()
Implements

OnBehaviorUpdate()

Declaration
public void OnBehaviorUpdate()
Implements

OnMarsUpdate()

Declaration
public void OnMarsUpdate()
Implements

UnloadModule()

Declaration
public void UnloadModule()
Implements

Events

RecordingEndReached

Called when recording playback has reached the end of the Timeline

Declaration
public event Action RecordingEndReached
Event Type
Type Description
Action