XR Interaction Toolkit

https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.5/
Admin
A high-level, component-based interaction system for creating VR and AR experiences in Unity with...
Tokens:329,551
Snippets:4,951
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Movement.ContinuousMoveProvider.html

Standard MonoBehaviour start method.

```csharp
protected void Start()
```

--------------------------------

### onStart

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.Gesture-1.html

An event that triggers when a gesture is started.

```APIDOC
## public event Action<T> onStart

### Description
Calls the methods in its invocation list when a gesture is started.

### Event Type
Action<T>
```

--------------------------------

### Override registrationMode Example

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Transformers.XRBaseGrabTransformer.html

Example of overriding the registration mode to register as a Multiple Grab Transformer.

```csharp
protected override RegisterMode registrationMode => RegisterMode.Multiple;
```

--------------------------------

### OnStart Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.PinchGesture.html

Handles initialization logic when the gesture begins.

```csharp
protected override void OnStart()
```

--------------------------------

### slopInches

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.DragGestureRecognizer.html

Gets or sets the distance in inches a user's touch can drift from the start position before the drag gesture is interpreted as started.

```APIDOC
## slopInches

### Description
Distance in inches a user's touch can drift from the start position before the drag gesture is interpreted as started.

### Declaration
`public float slopInches { get; set; }`

### Property Value
- **Type**: float
```

--------------------------------

### slopInches

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.PinchGestureRecognizer.html

Gets or sets the distance in inches a user's touch gap can drift from the start position before the pinch gesture is interpreted as started.

```APIDOC
### Property
`public float slopInches { get; set; }`

Distance in inches a user's touch gap can drift from the start position before the pinch gesture is interpreted as started.
```

--------------------------------

### TryPrepareLocomotion Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.LocomotionProvider.html

Attempts to transition the provider into the Preparing state, succeeding only if isLocomotionActive is false.

```csharp
protected bool TryPrepareLocomotion()
```

--------------------------------

### tapStartPositionInput

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.Inputs.ScreenSpaceSelectInput.html

Gets or sets the input reader used for the screen tap start position.

```APIDOC
### Property: tapStartPositionInput

**Declaration:** `public XRInputValueReader<Vector2> tapStartPositionInput { get; set; }`

**Description:** Input to use for the screen tap start position.
```

--------------------------------

### Configure Ray Origin Transform

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

Sets or gets the starting position and direction for ray casts.

```csharp
public Transform rayOriginTransform { get; set; }
```

--------------------------------

### Initialization and Registration

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.NearFarInteractor.html

Methods for initializing internal references and handling registration with the XR UI Input Module.

```csharp
protected virtual void InitializeReferences()
```

```csharp
protected virtual void OnRegistered(UIInteractorRegisteredEventArgs args)
```

--------------------------------

### slopRotation Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.TwistGestureRecognizer.html

Gets or sets the rotation threshold in degrees required to trigger the start of a twist gesture.

```csharp
public float slopRotation { get; set; }
```

--------------------------------

### slopInches Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.DragGestureRecognizer.html

Gets or sets the distance in inches a touch can drift before the drag gesture is considered started.

```csharp
public float slopInches { get; set; }
```

--------------------------------

### TryStartLocomotionImmediately Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.LocomotionProvider.html

Transitions the provider into the Moving state immediately, bypassing the canStartMoving check.

```csharp
protected bool TryStartLocomotionImmediately()
```

--------------------------------

### angleThresholdRadians

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.TwoFingerDragGestureRecognizer.html

Gets or sets the maximum angle of divergence between the paths of both fingers for a two-finger drag gesture to be interpreted as started.

```APIDOC
### Property
`public float angleThresholdRadians { get; set; }`

Maximum angle of the divergence between the paths of both fingers for a two-finger drag gesture to be interpreted as started.
```

--------------------------------

### CanStart Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.TwistGesture.html

Determines if the gesture is eligible to begin.

```csharp
protected override bool CanStart()
```

--------------------------------

### Access instance property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets the singleton runtime instance of the simulator.

```csharp
public static XRInteractionSimulator instance { get; }
```

--------------------------------

### OnLocomotionStarting Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Movement.ContinuousMoveProvider.html

Callback invoked when locomotion enters the Moving state.

```csharp
protected override void OnLocomotionStarting()
```

--------------------------------

### slopRotation

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.TwistGestureRecognizer.html

Gets or sets the rotation threshold in degrees that a user's touches must twist from the start positions before the gesture is recognized.

```APIDOC
### Property

#### slopRotation

`public float slopRotation { get; set; }`

Rotation in degrees a user's touches must twist from the start positions before the twist gesture is interpreted as started.
```

--------------------------------

### FinishSetup Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRSimulatedController.html

Overrides the base XRController setup finalization method.

```csharp
protected override void FinishSetup()
```

--------------------------------

### slopMotionDirectionDegrees

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.PinchGestureRecognizer.html

Gets or sets the threshold angle of motion of a user's touches used when determining if the pinch gesture is able to start.

```APIDOC
### Property
`public float slopMotionDirectionDegrees { get; set; }`

Threshold angle of motion of a user's touches used when determining if the pinch gesture is able to start.
```

--------------------------------

### CanStart Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.PinchGesture.html

Determines if the pinch gesture can be initiated.

```csharp
protected override bool CanStart()
```

--------------------------------

### Configure startingSingleGrabTransformers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Defines the grab transformers linked at startup for single-interactor scenarios.

```csharp
public List<XRBaseGrabTransformer> startingSingleGrabTransformers { get; set; }
```

--------------------------------

### FollowPresetDatumProperty(FollowPreset)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.BodyUI.FollowPresetDatumProperty.html

Initializes a new instance of the FollowPresetDatumProperty class with a direct FollowPreset value.

```APIDOC
## FollowPresetDatumProperty(FollowPreset)

### Description
Initializes a new instance of the FollowPresetDatumProperty class using a direct FollowPreset value.

### Parameters
- **value** (FollowPreset) - The FollowPreset value to be stored.
```

--------------------------------

### Get Object Reference Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputButtonReader.html

Gets the object reference that is used as the input source when the mode is set to ObjectReference.

```csharp
public IXRInputButtonReader GetObjectReference()
```

--------------------------------

### Lifecycle and Configuration Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.Inputs.TouchscreenGestureInputLoader.html

Standard MonoBehaviour lifecycle methods and the manual configuration refresh method.

```csharp
protected void Awake()
```

```csharp
protected void OnDisable()
```

```csharp
protected void OnEnable()
```

```csharp
public void RefreshGestureRecognizersConfiguration()
```

--------------------------------

### Namespace Migration Examples

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/manual/upgrade-guide-3.0.html

Examples showing the transformation of class references from the old namespace structure to the new fully qualified or imported structure.

```csharp
XRBaseInteractable m_Interactable;
```

```csharp
UnityEngine.XR.Interaction.Toolkit.Interactables.XRBaseInteractable m_Interactable;
```

```csharp
using UnityEngine.XR.Interaction.Toolkit.Interactables;

...

XRBaseInteractable m_Interactable;
```

--------------------------------

### FollowPresetDatumProperty(FollowPresetDatum)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.BodyUI.FollowPresetDatumProperty.html

Initializes a new instance of the FollowPresetDatumProperty class with a reference to a FollowPresetDatum container.

```APIDOC
## FollowPresetDatumProperty(FollowPresetDatum)

### Description
Initializes a new instance of the FollowPresetDatumProperty class using a reference to a FollowPresetDatum container.

### Parameters
- **datum** (FollowPresetDatum) - The FollowPresetDatum container reference.
```

--------------------------------

### bodyTransformer

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.LocomotionMediator.html

Gets the XRBodyTransformer linked with this mediator.

```APIDOC
## Property: bodyTransformer

### Description
The XRBodyTransformer linked with this mediator.

### Declaration
`public XRBodyTransformer bodyTransformer { get; }`

### Returns
- **XRBodyTransformer** - The associated body transformer.
```

--------------------------------

### StartClimbGrab Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Climbing.ClimbProvider.html

Initiates a climb grab using the specified interactable and interactor.

```csharp
public void StartClimbGrab(ClimbInteractable climbInteractable, IXRSelectInteractor interactor)
```

--------------------------------

### Registering for FocusExitEvent

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.FocusExitEventArgs.html

Demonstrates how to subscribe to focus events on an XRBaseInteractable and handle the associated event arguments.

```csharp
using UnityEngine;
using UnityEngine.XR.Interaction.Toolkit;
using UnityEngine.XR.Interaction.Toolkit.Interactors;
using UnityEngine.XR.Interaction.Toolkit.Interactables;
/// <summary>
/// This class is an example script that highlights the various XR Interaction events and demonstrates how to create callbacks for each event.
/// </summary>
class XRInteractionEventsSample : MonoBehaviour
{
// The interactor to listen to hover and select interaction events. Connect an XRBaseInteractor like NearFarInteractor or XRRayInteractor to this
// property in the Editor.
[SerializeField]
XRBaseInteractor m_ExampleInteractor;
// The interactable to listen to focus and activate events. Connect XRBaseInteractable like XRGrabInteractable to this property in the Editor
[SerializeField]
XRBaseInteractable m_ExampleInteractable;

void OnEnable()
{
    if (m_ExampleInteractor != null)
    {
        // Add listener to hover events
        m_ExampleInteractor.hoverEntered.AddListener(OnInteractorHoverEntered);
        m_ExampleInteractor.hoverExited.AddListener(OnInteractorHoverExited);

        // Add listener to select events
        m_ExampleInteractor.selectEntered.AddListener(OnInteractorSelectEntered);
        m_ExampleInteractor.selectExited.AddListener(OnInteractorSelectExited);
    }
    else
    {
        Debug.LogWarning("Example interactor is null. No hover or select event callbacks will be executed in this example. Ensure the ExampleInteractor field has a " + typeof(XRBaseInteractor) + " assigned.", this);
    }

    if (m_ExampleInteractable != null)
    {
        // Add listener to focus events
        m_ExampleInteractable.focusEntered.AddListener(OnInteractableFocusEntered);
        m_ExampleInteractable.focusExited.AddListener(OnInteractableFocusExited);

        // Add listener to activate events
        m_ExampleInteractable.activated.AddListener(OnInteractableActivated);
        m_ExampleInteractable.deactivated.AddListener(OnInteractableDeactivated);
    }
    else
    {
        Debug.LogWarning("Example interactable is null. No focus or activate event callbacks will be executed in this example. Ensure the ExampleInteractable field has a " + typeof(XRBaseInteractable) + " assigned.", this);
    }
}

void OnDisable()
{
    if (m_ExampleInteractor != null)
    {
        // Remove listener to hover events
        m_ExampleInteractor.hoverEntered.RemoveListener(OnInteractorHoverEntered);
        m_ExampleInteractor.hoverExited.RemoveListener(OnInteractorHoverExited);

        // Remove listener to select events
        m_ExampleInteractor.selectEntered.RemoveListener(OnInteractorSelectEntered);
        m_ExampleInteractor.selectExited.RemoveListener(OnInteractorSelectExited);
    }

    if (m_ExampleInteractable != null)
    {
        // Remove listener to focus events
        m_ExampleInteractable.focusEntered.RemoveListener(OnInteractableFocusEntered);
        m_ExampleInteractable.focusExited.RemoveListener(OnInteractableFocusExited);

        // Remove listener to activate events
        m_ExampleInteractable.activated.RemoveListener(OnInteractableActivated);
        m_ExampleInteractable.deactivated.RemoveListener(OnInteractableDeactivated);
    }
}

void OnInteractorHoverEntered(HoverEnterEventArgs args)
{
    // Example of casting args objects to interactor and interactable base classes
    var interactor = args.interactorObject as XRBaseInteractor;
    var interactable = args.interactableObject as XRBaseInteractable;
```

--------------------------------

### rayOriginTransform

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

The starting position and direction of any ray casts.

```APIDOC
### Property: rayOriginTransform

**Type:** Transform

The starting position and direction of any ray casts. Automatically instantiated and set in Awake() if null.
```

--------------------------------

### scaleOverTimeInput

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

Gets or sets the input for scaling over time.

```APIDOC
## Property: scaleOverTimeInput

### Description
The input to use for providing a scale value to grab transformers for scaling over time. This effectively scales the selected grab interactable while the input is pushed in either direction.

### Type
`XRInputValueReader<Vector2>`

### Remarks
Uses the y-axis as the scale input.
```

--------------------------------

### LocomotionProvider Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.LocomotionProvider.html

Lifecycle and state transition methods for the locomotion provider.

```csharp
protected virtual void Awake()
```

```csharp
protected virtual void OnDisable()
```

```csharp
protected virtual void OnEnable()
```

```csharp
protected virtual void OnLocomotionEnding()
```

```csharp
protected virtual void OnLocomotionStarting()
```

```csharp
protected virtual void OnLocomotionStateChanging(LocomotionState state)
```

```csharp
protected bool TryEndLocomotion()
```

--------------------------------

### lineType

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

Gets or sets the type of ray cast.

```APIDOC
### Property: lineType

**Type**: XRRayInteractor.LineType

**Description**: Gets or sets the type of ray cast.
```

--------------------------------

### Lifecycle and Processing Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.XRUIInputModule.html

Methods for initializing the module and processing input ticks.

```csharp
protected override void Awake()
```

```csharp
protected override void DoProcess()
```

--------------------------------

### interactionManager

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRBaseInteractor.html

Gets or sets the XRInteractionManager associated with this interactor.

```APIDOC
## public XRInteractionManager interactionManager { get; set; }

### Description
The XRInteractionManager that this Interactor will communicate with.
```

--------------------------------

### Handling Snap Volume Registration Events

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.InteractableSnapVolumeRegisteredEventArgs.html

Example handlers for snap volume registration and unregistration events.

```csharp
void OnSnapVolumeRegistered(InteractableSnapVolumeRegisteredEventArgs args)
{
    // Logic for snap volume registered event goes here
    if (args.snapVolume != null && args.snapVolume == m_ExampleSnapVolume)
        Debug.Log(args.snapVolume.transform.name + " is registered with " + args.manager.transform.name, this);
}

void OnSnapVolumeUnregistered(InteractableSnapVolumeUnregisteredEventArgs args)
{
    // Logic for snap volume unregistered event goes here
    if (args.snapVolume != null && args.snapVolume == m_ExampleSnapVolume)
        Debug.Log(args.snapVolume.transform.name + " is unregistered with " + args.manager.transform.name, this);
}
```

--------------------------------

### Configure startingMultipleGrabTransformers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Defines the grab transformers linked at startup for multi-interactor scenarios.

```csharp
public List<XRBaseGrabTransformer> startingMultipleGrabTransformers { get; set; }
```

--------------------------------

### interactionManager

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRBaseInteractable.html

Gets or sets the XRInteractionManager associated with this interactable.

```APIDOC
## interactionManager

### Description
The XRInteractionManager that this Interactable will communicate with.

### Property
public XRInteractionManager interactionManager { get; set; }
```

--------------------------------

### pokeStateData

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRPokeInteractor.html

Gets the current poke state data.

```APIDOC
### Property: pokeStateData

- **Type**: IReadOnlyBindableVariable<PokeStateData>
- **Description**: Unity.XR.CoreUtils.Bindings.Variables.IReadOnlyBindableVariable that updates whenever the poke logic state is evaluated.
```

--------------------------------

### XRControllerState()

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRControllerState.html

Initializes a new instance of the XRControllerState class.

```APIDOC
## XRControllerState()

### Description
Initializes and returns an instance of XRControllerState.
```

--------------------------------

### Setup Rigidbody Grab

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Configures the Rigidbody when an object is grabbed. Derived classes should call the base method to ensure future drop events are handled correctly.

```csharp
protected virtual void SetupRigidbodyGrab(Rigidbody rigidbody)
```

--------------------------------

### containingGroup

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.IXRGroupMember.html

Gets the IXRInteractionGroup that currently contains this member.

```APIDOC
### Property: containingGroup

**Type**: IXRInteractionGroup

**Description**: The Interaction Group that contains this member. Returns null if the member is not currently part of a group.
```

--------------------------------

### Initialize(InputDevice)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.HapticImpulseCommandChannelGroup.html

Initializes the channel group with a specific input device.

```APIDOC
### Method: Initialize(InputDevice device)

**Description**: Initialize the channel group with the given device. Does nothing if already initialized with the same device.

**Parameters**:
- **device** (InputDevice): The input device that haptic impulses should be sent to.
```

--------------------------------

### rightCurrentHandExpression

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets the current right hand expression.

```APIDOC
### Property: rightCurrentHandExpression

**Type:** SimulatedHandExpression

**Description:** The right hand expression which the simulated hands should currently simulate.
```

--------------------------------

### Access startingHoverFilters property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRBaseInteractable.html

Gets or sets the initial hover filters used at startup.

```csharp
public List<Object> startingHoverFilters { get; set; }
```

--------------------------------

### rightControllerTransform

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets or sets the Transform for the right controller.

```APIDOC
### Property: rightControllerTransform

**Type:** Transform

**Description:** The Transform that contains the right controller. Automatically set to the reference to the right controller in the XRInputModalityManager if unset.
```

--------------------------------

### simulatedHandExpressions

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.SimulatedHandPlaybackManager.html

Gets the list of simulated hand expressions.

```APIDOC
### Property: simulatedHandExpressions

#### Description
The list of simulated hand expressions.

#### Type
List<SimulatedHandExpression>

#### Access
Read-only
```

--------------------------------

### FollowPresetDatumProperty Constructors

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.BodyUI.FollowPresetDatumProperty.html

Constructors for initializing the property with either a direct value or a datum reference.

```csharp
public FollowPresetDatumProperty(FollowPreset value)
```

```csharp
public FollowPresetDatumProperty(FollowPresetDatum datum)
```

--------------------------------

### channelCount

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.HapticImpulseSingleChannelGroup.html

Gets the number of haptic channels in the group.

```APIDOC
## Property: channelCount

### Description
The number of haptic channels on the device.

### Returns
- **int** - The count of channels.
```

--------------------------------

### XRControllerState(XRControllerState)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRControllerState.html

Initializes a new instance of the XRControllerState class by copying an existing state.

```APIDOC
## XRControllerState(XRControllerState value)

### Description
Initializes and returns an instance of XRControllerState by copying the values from another XRControllerState object.
```

--------------------------------

### Registering FocusExitEvent Callbacks

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.FocusExitEvent.html

Example demonstrating how to subscribe to focus exit events on an XRBaseInteractable using AddListener.

```csharp
using UnityEngine;
using UnityEngine.XR.Interaction.Toolkit;
using UnityEngine.XR.Interaction.Toolkit.Interactors;
using UnityEngine.XR.Interaction.Toolkit.Interactables;
/// <summary>
/// This class is an example script that highlights the various XR Interaction events and demonstrates how to create callbacks for each event.
/// </summary>
class XRInteractionEventsSample : MonoBehaviour
{
// The interactor to listen to hover and select interaction events. Connect an XRBaseInteractor like NearFarInteractor or XRRayInteractor to this
// property in the Editor.
[SerializeField]
XRBaseInteractor m_ExampleInteractor;
// The interactable to listen to focus and activate events. Connect XRBaseInteractable like XRGrabInteractable to this property in the Editor
[SerializeField]
XRBaseInteractable m_ExampleInteractable;

void OnEnable()
{
    if (m_ExampleInteractor != null)
    {
        // Add listener to hover events
        m_ExampleInteractor.hoverEntered.AddListener(OnInteractorHoverEntered);
        m_ExampleInteractor.hoverExited.AddListener(OnInteractorHoverExited);

        // Add listener to select events
        m_ExampleInteractor.selectEntered.AddListener(OnInteractorSelectEntered);
        m_ExampleInteractor.selectExited.AddListener(OnInteractorSelectExited);
    }
    else
    {
        Debug.LogWarning("Example interactor is null. No hover or select event callbacks will be executed in this example. Ensure the ExampleInteractor field has a " + typeof(XRBaseInteractor) + " assigned.", this);
    }

    if (m_ExampleInteractable != null)
    {
        // Add listener to focus events
        m_ExampleInteractable.focusEntered.AddListener(OnInteractableFocusEntered);
        m_ExampleInteractable.focusExited.AddListener(OnInteractableFocusExited);

        // Add listener to activate events
        m_ExampleInteractable.activated.AddListener(OnInteractableActivated);
        m_ExampleInteractable.deactivated.AddListener(OnInteractableDeactivated);
    }
    else
    {
        Debug.LogWarning("Example interactable is null. No focus or activate event callbacks will be executed in this example. Ensure the ExampleInteractable field has a " + typeof(XRBaseInteractable) + " assigned.", this);
    }
}

void OnDisable()
{
    if (m_ExampleInteractor != null)
    {
        // Remove listener to hover events
        m_ExampleInteractor.hoverEntered.RemoveListener(OnInteractorHoverEntered);
        m_ExampleInteractor.hoverExited.RemoveListener(OnInteractorHoverExited);
```

--------------------------------

### GetEvaluatorAt(int)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Filtering.XRTargetFilter.html

Gets the evaluator at the given index.

```APIDOC
## GetEvaluatorAt(int)

### Description
Gets the evaluator in the given index.

### Declaration
`public XRTargetEvaluator GetEvaluatorAt(int index)`

### Parameters
- **index** (int) - Required - Index of the evaluator to return. Must be smaller than evaluatorCount and not negative.

### Returns
- **XRTargetEvaluator** - The evaluator in the given index.
```

--------------------------------

### startingSingleGrabTransformers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Gets or sets the grab transformers that this Interactable automatically links at startup for a single interactor.

```APIDOC
## public List<XRBaseGrabTransformer> startingSingleGrabTransformers { get; set; }

### Description
The grab transformers that this Interactable automatically links at startup (optional, may be empty). These are used when there is a single interactor selecting this object.
```

--------------------------------

### count

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Filtering.IXRFilterList-1.html

Gets the number of items currently in the list.

```APIDOC
## Property: count

### Description
Returns the total number of items stored in the list.

### Return Type
int
```

--------------------------------

### InitRecording()

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRControllerRecording.html

Initializes the recording session by clearing all previously stored frames.

```APIDOC
### public void InitRecording()

#### Description
Initializes this recording by clearing all frames stored.
```

--------------------------------

### formatId

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.Inputs.TouchscreenGestureInputControllerState.html

Gets the memory format identifier for TouchscreenGestureInputControllerState.

```APIDOC
### Property: formatId

#### Description
Memory format identifier for TouchscreenGestureInputControllerState.

#### Declaration
`public static FourCC formatId { get; }`

#### Property Value
- **Type**: FourCC
```

--------------------------------

### MonoBehaviour Lifecycle Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Gaze.XRGazeAssistance.html

Standard Unity lifecycle methods implemented by the XRGazeAssistance class.

```csharp
protected void LateUpdate()
```

```csharp
protected void OnDisable()
```

```csharp
protected void OnEnable()
```

```csharp
protected void Start()
```

```csharp
protected void Update()
```

--------------------------------

### format

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.Inputs.TouchscreenGestureInputControllerState.html

Gets the data format identifier of the state.

```APIDOC
### Property: format

#### Description
The data format identifier of the state.

#### Declaration
`public FourCC format { get; }`

#### Property Value
- **Type**: FourCC
```

--------------------------------

### TeleportVolumeDestinationSettingsDatumProperty(TeleportVolumeDestinationSettings)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation.TeleportVolumeDestinationSettingsDatumProperty.html

Initializes a new instance of the TeleportVolumeDestinationSettingsDatumProperty class with a direct value.

```APIDOC
## TeleportVolumeDestinationSettingsDatumProperty(TeleportVolumeDestinationSettings value)

### Description
Initializes a new instance of the TeleportVolumeDestinationSettingsDatumProperty class using a direct TeleportVolumeDestinationSettings value.

### Parameters
- **value** (TeleportVolumeDestinationSettings) - The settings value to be contained.
```

--------------------------------

### ReadWasPerformedThisFrame()

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputButtonReader.html

Reads whether the button started being pressed during this frame.

```APIDOC
## ReadWasPerformedThisFrame()

### Description
Read whether the button performed this frame, which typically means whether the button started being pressed during this frame.

### Returns
- **bool** - Returns true if the button performed this frame. Otherwise, returns false.
```

--------------------------------

### XRInputHapticImpulseProvider Constructors

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.XRInputHapticImpulseProvider.html

Initializes a new instance of the XRInputHapticImpulseProvider class.

```APIDOC
## Constructor: XRInputHapticImpulseProvider()

### Description
Initializes and returns an instance of XRInputHapticImpulseProvider.

## Constructor: XRInputHapticImpulseProvider(string, bool, InputSourceMode)

### Description
Initializes and returns an instance of XRInputHapticImpulseProvider with specific input configuration.

### Parameters
- **name** (string) - The name of the directly serialized embedded input action.
- **wantsInitialStateCheck** (bool) - Whether the action should start performing if already actuated when the action is enabled.
- **inputSourceMode** (XRInputHapticImpulseProvider.InputSourceMode) - The initial input source mode.
```

--------------------------------

### selectEnteredClip Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Feedback.SimpleAudioFeedback.html

The AudioClip played when a select interaction starts.

```csharp
public AudioClip selectEnteredClip { get; set; }
```

--------------------------------

### ReadWasPerformedThisFrame()

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.AR.Inputs.ScreenSpaceSelectInput.html

Checks if the button started its action during the current frame.

```APIDOC
### public bool ReadWasPerformedThisFrame()

#### Description
Read whether the button performed this frame, which typically means whether the button started being pressed during this frame. This is typically only true for one single frame.

#### Returns
- **bool** - Returns true if the button performed this frame. Otherwise, returns false.
```

--------------------------------

### Using XRInputHapticImpulseProvider with XRInputReaderUtility

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputReaderUtility.html

Demonstrates how to implement a property setter for an XRInputHapticImpulseProvider using the utility method.

```csharp
[SerializeField]
XRInputHapticImpulseProvider m_HapticOutput = new XRInputHapticImpulseProvider("Haptic");
public XRInputHapticImpulseProvider hapticOutput
{
get => m_HapticOutput;
set => XRInputReaderUtility.SetInputProperty(ref m_HapticOutput, value, this);
}
void OnEnable()
{
m_HapticOutput.EnableDirectActionIfModeUsed();
}
void OnDisable()
{
m_HapticOutput.DisableDirectActionIfModeUsed();
}
```

--------------------------------

### Setup Rigidbody Drop

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Configures the Rigidbody when an object is dropped. Derived classes should call the base method to maintain proper state transitions.

```csharp
protected virtual void SetupRigidbodyDrop(Rigidbody rigidbody)
```

--------------------------------

### Accessing lastFocused

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRInteractionManager.html

Gets the last IXRFocusInteractable that was focused by any IXRInteractor.

```csharp
public IXRFocusInteractable lastFocused { get; protected set; }
```

--------------------------------

### trackableType

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

Gets or sets the ARTrackable types considered for ARRaycast.

```APIDOC
## Property: trackableType

### Description
The ARTrackable types that will taken into consideration with the performed ARRaycast.

### Type
`TrackableType`
```

--------------------------------

### Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.XRInputHapticImpulseProvider.html

Methods for managing the input action state and retrieving haptic channel information.

```csharp
public void DisableDirectActionIfModeUsed()
```

```csharp
public void EnableDirectActionIfModeUsed()
```

```csharp
public IXRHapticImpulseChannelGroup GetChannelGroup()
```

```csharp
public IXRHapticImpulseProvider GetObjectReference()
```

```csharp
public void SetObjectReference(IXRHapticImpulseProvider value)
```

--------------------------------

### timeToAutoDeselect

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

Gets or sets the duration before automatically deselecting an interactable.

```APIDOC
## Property: timeToAutoDeselect

### Description
Number of seconds for which this Interactor will keep an Interactable selected before automatically deselecting it.

### Type
`float`

### Remarks
This only applies when an interactable is selected due to hoverToSelect.
```

--------------------------------

### Initialize recording

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRControllerRecording.html

Clears all currently stored frames to prepare for a new recording.

```csharp
public void InitRecording()
```

--------------------------------

### ClimbSettingsDatumProperty(ClimbSettings)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Climbing.ClimbSettingsDatumProperty.html

Initializes a new instance of the ClimbSettingsDatumProperty class with a constant ClimbSettings value.

```APIDOC
## ClimbSettingsDatumProperty(ClimbSettings value)

### Description
Initializes a new instance of the ClimbSettingsDatumProperty class with a constant ClimbSettings value.

### Parameters
- **value** (ClimbSettings) - The constant value to be serialized.
```

--------------------------------

### scaleMode

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRRayInteractor.html

Gets or sets the scale mode supported by the implementation.

```APIDOC
## Property: scaleMode

### Description
Property representing the scale mode that is supported by the implementation of the interface.

### Type
`ScaleMode`
```

--------------------------------

### XRBodyYawRotation.angleDelta

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.XRBodyYawRotation.html

Gets or sets the amount in degrees to rotate the originTransform.

```APIDOC
### Property: angleDelta

#### Description
Gets or sets the amount in degrees to rotate the originTransform.

#### Type
float
```

--------------------------------

### Lifecycle Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.XRUIInputModule.html

Standard Unity lifecycle overrides for the input module.

```csharp
protected override void OnDestroy()
```

```csharp
protected override void OnDisable()
```

```csharp
protected override void OnEnable()
```

--------------------------------

### GetInteractionStrength

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRBaseInteractor.html

Gets the interaction strength between the given interactable and this interactor.

```APIDOC
## GetInteractionStrength(IXRInteractable)

### Description
Gets the interaction strength between the given interactable and this interactor.

### Parameters
- **interactable** (IXRInteractable) - The specific interactable to get the interaction strength between.

### Returns
- **float** - Returns a value [0.0, 1.0] of the interaction strength.
```

--------------------------------

### OnBeforeRender Lifecycle Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRInteractionManager.html

Delegate method for registering VR input updates, executed with a specific order attribute.

```csharp
[BeforeRenderOrder(100)]
protected virtual void OnBeforeRender()
```

--------------------------------

### Define XRInputDeviceFloatValueReader class

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputDeviceFloatValueReader.html

The class definition includes attributes for HelpURL and CreateAssetMenu, allowing it to be created as an asset in the Unity Editor.

```csharp
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputDeviceFloatValueReader.html")]
[CreateAssetMenu(fileName = "XRInputDeviceFloatValueReader", menuName = "XR/Input Value Reader/float")]
public class XRInputDeviceFloatValueReader : XRInputDeviceValueReader<float>, IXRInputValueReader<float>, IXRInputValueReader
```

--------------------------------

### linkedBody

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.ScriptableConstrainedBodyManipulator.html

Gets the XRMovableBody instance currently associated with this manipulator.

```APIDOC
### Property: linkedBody

**Type**: XRMovableBody

**Description**: The body whose originTransform is being moved by this manipulator.
```

--------------------------------

### Constructors

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.XRInputHapticImpulseProvider.html

Constructors for initializing the haptic impulse provider.

```csharp
public XRInputHapticImpulseProvider()
```

```csharp
public XRInputHapticImpulseProvider(string name = null, bool wantsInitialStateCheck = false, XRInputHapticImpulseProvider.InputSourceMode inputSourceMode = InputSourceMode.InputActionReference)
```

--------------------------------

### selectedInteractableMovementTypeOverride

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRBaseInteractor.html

Gets the overriding movement type for the selected Interactable.

```APIDOC
## public virtual XRBaseInteractable.MovementType? selectedInteractableMovementTypeOverride { get; }

### Description
Allows an interactor to override the movement type of a selected interactable. This is useful for changing behavior based on the specific interactor type, such as forcing instantaneous movement in a socket interactor.
```

--------------------------------

### interactionLayers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRBaseInteractor.html

Gets or sets the interaction layer mask for the interactor.

```APIDOC
## public InteractionLayerMask interactionLayers { get; set; }

### Description
Allows interaction with Interactables whose Interaction Layer Mask overlaps with any Layer in this Interaction Layer Mask.
```

--------------------------------

### XRInputValueReader()

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputValueReader-1.html

Initializes a new instance of the XRInputValueReader class.

```APIDOC
### Constructor
`public XRInputValueReader()`

Initializes and returns an instance of XRInputValueReader<TValue>.
```

--------------------------------

### Subscribe to XRInteractionManager registration events

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.InteractableSnapVolumeUnregisteredEventArgs.html

Demonstrates how to subscribe to various registration and unregistration events, including snapVolumeUnregistered, within a MonoBehaviour.

```csharp
using UnityEngine;
using UnityEngine.XR.Interaction.Toolkit;
using UnityEngine.XR.Interaction.Toolkit.Interactables;
using UnityEngine.XR.Interaction.Toolkit.Interactors;
/// <summary>
/// This class is an example script that registration events and demonstrates how to create callbacks for each event.
/// </summary>
class XRInteractionManagerRegistrationEventsSample : MonoBehaviour
{
[SerializeField]
XRInteractionManager m_InteractionManager;
XRInteractionGroup m_ExampleInteractionGroup;
NearFarInteractor m_ExampleInteractor;
XRGrabInteractable m_ExampleInteractable;
XRInteractableSnapVolume m_ExampleSnapVolume;

void Awake()
{
    // Try to find an interaction manager if necessary.
    if (m_InteractionManager == null)
        m_InteractionManager = FindAnyObjectByType<XRInteractionManager>();

    // Note, the code below is creating the XRInteractionGroup, NearFarInteractor, XRGrabInteractable, and XRInteractableSnapVolume before subscribing
    // to the interaction manager register/unregister events. Therefore, the initial register callback will not be logged.
    // To demonstrate these callbacks, enable/disable each example game object in the hierarchy to receive the register/unregister callbacks.

    // XRInteractionGroup automatically registers with the interaction manager on Awake
    var interactionGroupGO = new GameObject("Example Interaction Group");
    m_ExampleInteractionGroup = interactionGroupGO.AddComponent<XRInteractionGroup>();

    // XRBaseInteractor automatically registers with the interaction manager on Enable
    var interactorGO = new GameObject("Example Interactor");
    m_ExampleInteractor = interactorGO.AddComponent<NearFarInteractor>();

    // XRBaseInteractable automatically registers with the interaction manager on Enable
    var interactableGO = new GameObject("Example Interactable");
    m_ExampleInteractable = interactableGO.AddComponent<XRGrabInteractable>();

    // XRInteractableSnapVolume automatically registers with the interaction manager on Enable
    var snapVolumeGO = new GameObject("Example Snap Volume");
    m_ExampleSnapVolume = snapVolumeGO.AddComponent<XRInteractableSnapVolume>();
}

void OnEnable()
{
    if (m_InteractionManager == null)
    {
        Debug.LogWarning("Interaction manager is null. No registration events will be executed in this example. Ensure there is an " + typeof(XRInteractionManager) + " in the scene.", this);
        return;
    }

    // Subscribe to the interaction manager registration events
    m_InteractionManager.interactionGroupRegistered += OnInteractionGroupRegistered;
    m_InteractionManager.interactorRegistered += OnInteractorRegistered;
    m_InteractionManager.interactableRegistered += OnInteractableRegistered;
    m_InteractionManager.snapVolumeRegistered += OnSnapVolumeRegistered;

    m_InteractionManager.interactionGroupUnregistered += OnInteractionGroupUnregistered;
    m_InteractionManager.interactorUnregistered += OnInteractorUnregistered;
    m_InteractionManager.interactableUnregistered += OnInteractableUnregistered;
    m_InteractionManager.snapVolumeUnregistered += OnSnapVolumeUnregistered;
}

void OnDisable()
{
    if (m_InteractionManager == null)
        return;
```

--------------------------------

### Managing defaultParameters

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Comfort.TunnelingVignetteController.html

Gets or sets the default VignetteParameters for the controller.

```csharp
public VignetteParameters defaultParameters { get; set; }
```

--------------------------------

### interactionLayers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRBaseInteractable.html

Gets or sets the interaction layer mask for this interactable.

```APIDOC
## interactionLayers

### Description
Allows interaction with Interactors whose Interaction Layer Mask overlaps with any Layer in this Interaction Layer Mask.

### Property
public InteractionLayerMask interactionLayers { get; set; }
```

--------------------------------

### TeleportVolumeDestinationSettingsDatumProperty(TeleportVolumeDestinationSettingsDatum)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation.TeleportVolumeDestinationSettingsDatumProperty.html

Initializes a new instance of the TeleportVolumeDestinationSettingsDatumProperty class with a datum reference.

```APIDOC
## TeleportVolumeDestinationSettingsDatumProperty(TeleportVolumeDestinationSettingsDatum datum)

### Description
Initializes a new instance of the TeleportVolumeDestinationSettingsDatumProperty class using a reference to a TeleportVolumeDestinationSettingsDatum container.

### Parameters
- **datum** (TeleportVolumeDestinationSettingsDatum) - The datum reference to be contained.
```

--------------------------------

### pokeWidth

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRPokeInteractor.html

Gets or sets the width threshold for poke evaluation.

```APIDOC
### Property: pokeWidth

- **Type**: float
- **Description**: The width threshold within which an interaction can begin to be evaluated as a poke.
```

--------------------------------

### Using XRInputValueReader with XRInputReaderUtility

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputReaderUtility.html

Demonstrates how to implement a property setter for an XRInputValueReader using the generic utility method.

```csharp
[SerializeField]
XRInputValueReader<Vector2> m_LeftHandMoveInput = new XRInputValueReader<Vector2>("Left Hand Move");
public XRInputValueReader<Vector2> leftHandMoveInput
{
get => m_LeftHandMoveInput;
set => XRInputReaderUtility.SetInputProperty(ref m_LeftHandMoveInput, value, this);
}
void OnEnable()
{
m_LeftHandMoveInput.EnableDirectActionIfModeUsed();
}
void OnDisable()
{
m_LeftHandMoveInput.DisableDirectActionIfModeUsed();
}
```

--------------------------------

### pokeInteractionOffset

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRPokeInteractor.html

Gets or sets the distance offset for poke triggering.

```APIDOC
### Property: pokeInteractionOffset

- **Type**: float
- **Description**: Distance along the poke interactable interaction axis that allows for a poke to be triggered sooner/with less precision.
```

--------------------------------

### Handling Interactable Registration Events

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.InteractableSnapVolumeRegisteredEventArgs.html

Example handlers for interactable registration and unregistration events.

```csharp
void OnInteractableRegistered(InteractableRegisteredEventArgs args)
{
    // Example of casting args objects to interactable base class
    var interactable = args.interactableObject as XRBaseInteractable;

    // Logic for interactable registered event goes here
    if (interactable != null && interactable == m_ExampleInteractable)
        Debug.Log(args.interactableObject.transform.name + " is registered with " + args.manager.transform.name, this);
}

void OnInteractableUnregistered(InteractableUnregisteredEventArgs args)
{
    // Example of casting args objects to interactable base class
    var interactable = args.interactableObject as XRBaseInteractable;

    // Logic for interactable unregistered event goes here
    if (interactable != null && interactable == m_ExampleInteractable)
        Debug.Log(args.interactableObject.transform.name + " is unregistered with " + args.manager.transform.name, this);
}
```

--------------------------------

### pokeDepth

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRPokeInteractor.html

Gets or sets the depth threshold for poke evaluation.

```APIDOC
### Property: pokeDepth

- **Type**: float
- **Description**: The depth threshold within which an interaction can begin to be evaluated as a poke.
```

--------------------------------

### ClimbSettingsDatumProperty(ClimbSettingsDatum)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Climbing.ClimbSettingsDatumProperty.html

Initializes a new instance of the ClimbSettingsDatumProperty class with a reference to a ClimbSettingsDatum container.

```APIDOC
## ClimbSettingsDatumProperty(ClimbSettingsDatum datum)

### Description
Initializes a new instance of the ClimbSettingsDatumProperty class with a reference to a ClimbSettingsDatum container.

### Parameters
- **datum** (ClimbSettingsDatum) - The ScriptableObject container reference.
```

--------------------------------

### smoothPositionAmount

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Gets or sets the scale factor for position smoothing.

```APIDOC
## smoothPositionAmount

### Description
Scale factor for how much smoothing is applied while following the position of the Interactor when selected.

### Property Value
- **Type**: float
- **Access**: Read/Write
```

--------------------------------

### sphereCastRadius

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.Casters.CurveInteractionCaster.html

Gets or sets the radius used for sphere casting.

```APIDOC
## Property: sphereCastRadius

### Description
Defines the radius for sphere casting operations.

### Declaration
`public float sphereCastRadius { get; set; }`
```

--------------------------------

### startingHoverFilters

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRBaseInteractor.html

Gets or sets the hover filters used to populate the hoverFilters list at startup.

```APIDOC
## public List<Object> startingHoverFilters { get; set; }

### Description
Used to initialize the hover filters list when the object starts. For runtime modifications, use the hoverFilters list instead.
```

--------------------------------

### StartSocketSnapping Method

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRSocketInteractor.html

Initiates the socket snapping process for a given XRGrabInteractable.

```csharp
protected virtual bool StartSocketSnapping(XRGrabInteractable grabInteractable)
```

--------------------------------

### tintRenderers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.Visuals.XRTintInteractableVisual.html

Gets or sets the list of renderers that will be affected by the tinting.

```APIDOC
### Property: tintRenderers

**Declaration:** `public List<Renderer> tintRenderers { get; set; }`

**Description:** The Renderer(s) to use for tinting (will default to any Renderer on the GameObject if not specified).
```

--------------------------------

### rightControllerTrackingState

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets or sets the tracking state for the right-hand controller.

```APIDOC
### Property: rightControllerTrackingState

**Type:** InputTrackingState

**Description:** Which tracking values the right-hand controller should report as being valid or meaningful to use.
```

--------------------------------

### XRControllerState(double, Vector3, Quaternion, InputTrackingState, bool)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.XRControllerState.html

Initializes a new instance of the XRControllerState class with tracking information.

```APIDOC
## XRControllerState(double time, Vector3 position, Quaternion rotation, InputTrackingState inputTrackingState, bool isTracked)

### Description
Initializes and returns an instance of XRControllerState with specific tracking parameters.
```

--------------------------------

### rightControllerIsTracked

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets or sets whether the right-hand controller is tracked.

```APIDOC
### Property: rightControllerIsTracked

**Type:** bool

**Description:** Whether the right-hand controller should report the pose as fully tracked or unavailable/inferred.
```

--------------------------------

### Initializing the Channel Group

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.HapticImpulseCommandChannelGroup.html

Sets up the channel group with a specific InputDevice. This operation is idempotent if the device is already initialized.

```csharp
public void Initialize(InputDevice device)
```

--------------------------------

### startingTargetFilter Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.XRBaseInteractor.html

Sets the target filter that is automatically linked at startup.

```csharp
public XRBaseTargetFilter startingTargetFilter { get; set; }
```

--------------------------------

### rightControllerInputMode

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets the current right controller input mode.

```APIDOC
### Property: rightControllerInputMode

**Type:** ControllerInputMode

**Description:** The right controller input mode which the controller should currently simulate.
```

--------------------------------

### quickActionControllerInputModes

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets or sets the subset of quick-action controller buttons/inputs.

```APIDOC
### Property: quickActionControllerInputModes

**Type:** List<ControllerInputMode>

**Description:** The subset of quick-action controller buttons/inputs that a user can shift through in the simulator.
```

--------------------------------

### Create a custom Editor for an Interactable

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/manual/extending-xri.html

Extend XRBaseInteractableEditor to manually control the layout and display of serialized properties in the Inspector.

```csharp
// ExampleInteractableEditor.cs in an Editor folder in Assets
// which explicitly defines a SerializedProperty to choose
// where to display it in the Inspector rather than using
// the default location.

using UnityEditor;
using UnityEditor.XR.Interaction.Toolkit.Interactables;

[CustomEditor(typeof(ExampleInteractable), true), CanEditMultipleObjects]
public class ExampleInteractableEditor : XRBaseInteractableEditor
{
    protected SerializedProperty m_AdditionalField;

    protected override void OnEnable()
    {
        base.OnEnable();
        m_AdditionalField = serializedObject.FindProperty("m_AdditionalField");
    }

    protected override void DrawProperties()
    {
        base.DrawProperties();
        EditorGUILayout.PropertyField(m_AdditionalField);
    }
}
```

--------------------------------

### startingMultipleGrabTransformers

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRGrabInteractable.html

Gets or sets the grab transformers that this Interactable automatically links at startup for multiple interactors.

```APIDOC
## public List<XRBaseGrabTransformer> startingMultipleGrabTransformers { get; set; }

### Description
The grab transformers that this Interactable automatically links at startup (optional, may be empty). These are used when there are multiple interactors selecting this object.
```

--------------------------------

### mouseScrollRotateSensitivity

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets or sets the sensitivity of rotation along the z-axis.

```APIDOC
## public float mouseScrollRotateSensitivity { get; set; }

### Description
Sensitivity of rotation along the z-axis (roll) when triggered by mouse scroll input.
```

--------------------------------

### TrackedDeviceEventData(EventSystem)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.TrackedDeviceEventData.html

Initializes a new instance of the TrackedDeviceEventData class.

```APIDOC
## Constructor: TrackedDeviceEventData(EventSystem)

### Description
Initializes and returns an instance of TrackedDeviceEventData with the specified event system.

### Syntax
`public TrackedDeviceEventData(EventSystem eventSystem)`

### Parameters
- **eventSystem** (EventSystem) - Required - The event system associated with the UI.
```

--------------------------------

### currentHandExpression Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets the current hand expression being simulated.

```csharp
public SimulatedHandExpression currentHandExpression { get; }
```

--------------------------------

### Lifecycle Methods

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactors.NearFarInteractor.html

Standard MonoBehaviour and XR interaction lifecycle methods.

```csharp
protected override void Awake()
```

```csharp
protected override void OnDisable()
```

```csharp
protected override void OnEnable()
```

--------------------------------

### controllerInputMode Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation.XRInteractionSimulator.html

Gets the current simulation mode for the controller.

```csharp
public ControllerInputMode controllerInputMode { get; }
```

--------------------------------

### name

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.InputFeatureUsageString-1.html

Gets or sets the string name of the usage feature.

```APIDOC
### Property: name

The string name of the usage feature, which maps to an input feature on a device.

#### Type
- string
```

--------------------------------

### Access startingSelectFilters property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRBaseInteractable.html

Gets or sets the initial select filters used at startup.

```csharp
public List<Object> startingSelectFilters { get; set; }
```

--------------------------------

### channelCount

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.HapticImpulseCommandChannelGroup.html

Gets the number of haptic channels available on the device.

```APIDOC
### Property: channelCount

**Description**: Returns the number of haptic channels on the device.

**Type**: int

**Access**: Read-only
```

--------------------------------

### transformToFollow Property

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.Attachment.InteractionAttachController.html

Gets or sets the transform that the anchor should follow.

```csharp
public Transform transformToFollow { get; set; }
```

--------------------------------

### ApplyPreset(Transform, Transform)

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.BodyUI.FollowPreset.html

Applies the preset to the specified tracking offsets for the left and right local positions and rotations, and recomputes dot product thresholds.

```APIDOC
### Method
`public void ApplyPreset(Transform leftTrackingOffset, Transform rightTrackingOffset)`

### Parameters
- **leftTrackingOffset** (Transform) - The Transform object that represents the left tracking offset.
- **rightTrackingOffset** (Transform) - The Transform object that represents the right tracking offset.
```

--------------------------------

### FollowPreset Class

Source: https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%403.5/api/UnityEngine.XR.Interaction.Toolkit.UI.BodyUI.FollowPreset.html

The FollowPreset class defines the configuration of a following behaviour for a hand or object, including position, rotation, and smoothing settings.

```APIDOC
## FollowPreset

### Description
Class that defines the configuration of a following behaviour for a hand or object. It determines how an object should follow the hand and includes specifications about local position and rotation, angle constraints, gaze snapping, and smoothing settings.

### Fields
- **PalmFacingUpHideMenuAngleThresholdDelta** (float) - The additional threshold angle, in degrees, used as a buffer to hide the menu when the palm is facing up.
- **PalmFacingUserHideMenuAngleThresholdDelta** (float) - The additional threshold angle, in degrees, used as a buffer to hide the menu when the palm is facing the user.
- **allowSmoothing** (bool) - Whether to allow smoothing of the following element position and rotation.
- **followLowerSmoothingValue** (float) - The lower bound of smoothing to apply.
- **followUpperSmoothingValue** (float) - The upper bound of smoothing to apply.
- **hideDelaySeconds** (float) - The amount of time in seconds to wait before hiding the following element after the hand is no longer tracked.
- **invertAxisForRightHand** (bool) - Given that the default reference hand for menus is the left hand, it may be required to mirror the reference axis for the right hand.
- **leftHandLocalPosition** (Vector3) - Local space anchor position for the left hand.
- **leftHandLocalRotation** (Vector3) - Local space anchor rotation for the left hand.
- **palmFacingUpDegreeAngleThreshold** (float) - The angle threshold in degrees to check if the palm reference axis is facing up.
- **palmFacingUserDegreeAngleThreshold** (float) - The angle threshold in degrees to check if the palm reference axis is facing the user.
```
Tokens:
Raw