Class XRControllerRecorder

MonoBehaviour that controls interaction recording and playback (via XRControllerRecording assets).

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

XRControllerRecorder

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

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.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.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: UnityEngine.XR.Interaction.Toolkit

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/Debug/XR Controller Recorder", 11)]
[DisallowMultipleComponent]
[DefaultExecutionOrder(-30000)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.6/api/UnityEngine.XR.Interaction.Toolkit.XRControllerRecorder.html")]
public class XRControllerRecorder : MonoBehaviour

Properties

currentTime

(Read Only) The current recording/playback time.

Declaration

public double currentTime { get; }

Property Value

Type	Description
double

duration

(Read Only) The total playback time (or 0 if no recording).

Declaration

public double duration { get; }

Property Value

Type	Description
double

isPlaying

Whether the XRControllerRecorder is currently playing back interaction state.

Declaration

public bool isPlaying { get; set; }

Property Value

Type	Description
bool

isRecording

Whether the XRControllerRecorder is currently recording interaction state.

Declaration

public bool isRecording { get; set; }

Property Value

Type	Description
bool

playOnStart

Controls whether this recording will start playing when the component's Awake() method is called.

Declaration

public bool playOnStart { get; set; }

Property Value

Type	Description
bool

recording

Controller Recording asset for recording and playback of controller events.

Declaration

public XRControllerRecording recording { get; set; }

Property Value

Type	Description
XRControllerRecording

recordingStartTime

The time when recording was last started.

Declaration

protected float recordingStartTime { get; set; }

Property Value

Type	Description
float

visitEachFrame

If true, every frame of the recording must be visited even if a larger time period has passed.

Declaration

public bool visitEachFrame { get; set; }

Property Value

Type	Description
bool

xrController

The controller that this recording uses for recording and playback.

Declaration

public XRBaseController xrController { get; set; }

Property Value

Type	Description
XRBaseController

Methods

Awake()

See MonoBehaviour.

Declaration

protected void Awake()

GetControllerState(out XRControllerState)

Gets the state of the controller.

Declaration

public virtual bool GetControllerState(out XRControllerState controllerState)

Parameters

Type	Name	Description
XRControllerState	controllerState	When this method returns, contains the XRControllerState object representing the state of the controller.

Returns

Type	Description
bool	Returns true when playing or recording. Otherwise, returns false.

OnDestroy()

See MonoBehaviour.

Declaration

protected void OnDestroy()

ResetPlayback()

Resets the recorder to the start of the clip.

Declaration

public void ResetPlayback()

Update()

See MonoBehaviour.

Declaration

protected virtual void Update()