docs.unity3d.com
    Show / Hide Table of Contents

    Class XRControllerRecording

    The XRControllerRecording ScriptableObject stores position, rotation, and Interaction state changes from the XR Controller for playback.

    Inheritance
    Object
    Object
    ScriptableObject
    XRControllerRecording
    Inherited Members
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    [CreateAssetMenu(menuName = "XR/XR Controller Recording")]
    [Serializable]
    [PreferBinarySerialization]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.1/api/UnityEngine.XR.Interaction.Toolkit.XRControllerRecording.html")]
    public class XRControllerRecording : ScriptableObject, ISerializationCallbackReceiver

    Properties

    duration

    (Read Only) Total playback time for this recording.

    Declaration
    public double duration { get; }
    Property Value
    Type Description
    Double

    frames

    (Read Only) Frames stored in this recording.

    Declaration
    public List<XRControllerState> frames { get; }
    Property Value
    Type Description
    List<XRControllerState>

    Methods

    AddRecordingFrame(Double, Vector3, Quaternion, Boolean, Boolean, Boolean)

    (Deprecated) Adds a recording of a frame.

    Declaration
    [Obsolete("AddRecordingFrame has been deprecated. Use the overload method with the XRControllerState parameter or the method AddRecordingFrameNonAlloc.")]
    public void AddRecordingFrame(double time, Vector3 position, Quaternion rotation, bool selectActive, bool activateActive, bool pressActive)
    Parameters
    Type Name Description
    Double time

    The time for this controller frame.

    Vector3 position

    The position for this controller frame.

    Quaternion rotation

    The rotation for this controller frame.

    Boolean selectActive

    Whether select is active or not.

    Boolean activateActive

    Whether activate is active or not.

    Boolean pressActive

    Whether press is active or not.

    See Also
    AddRecordingFrame(XRControllerState)
    AddRecordingFrameNonAlloc(XRControllerState)

    AddRecordingFrame(XRControllerState)

    Adds a recording of a frame. Duplicates the supplied state object and adds the copy as a frame recording.

    Declaration
    public void AddRecordingFrame(XRControllerState state)
    Parameters
    Type Name Description
    XRControllerState state

    The XRControllerState to be recorded.

    See Also
    AddRecordingFrameNonAlloc(XRControllerState)

    AddRecordingFrameNonAlloc(XRControllerState)

    Adds a recording of a frame. Adds the supplied state object as a frame recording; does not allocate new memory.

    Declaration
    public void AddRecordingFrameNonAlloc(XRControllerState state)
    Parameters
    Type Name Description
    XRControllerState state

    The XRControllerState to be recorded.

    See Also
    AddRecordingFrame(XRControllerState)

    InitRecording()

    Initializes this recording by clearing all frames stored.

    Declaration
    public void InitRecording()

    SaveRecording()

    Saves this recording and writes to disk.

    Declaration
    public void SaveRecording()

    Explicit Interface Implementations

    ISerializationCallbackReceiver.OnAfterDeserialize()

    See OnAfterDeserialize.

    Declaration
    void ISerializationCallbackReceiver.OnAfterDeserialize()
    Implements
    ISerializationCallbackReceiver.OnAfterDeserialize()

    ISerializationCallbackReceiver.OnBeforeSerialize()

    See OnBeforeSerialize.

    Declaration
    void ISerializationCallbackReceiver.OnBeforeSerialize()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023