Inheritance
XRBaseController
[DefaultExecutionOrder(-29990)]
[DisallowMultipleComponent]
public abstract class XRBaseController : MonoBehaviour
Properties
(Read Only) The current activate interaction state.
Declaration
public InteractionState activateInteractionState { get; }
Property Value
Declaration
public float anchorControlDeadzone { get; set; }
Property Value
Declaration
public float anchorControlOffAxisDeadzone { get; set; }
Property Value
Whether this model animates in response to interaction events.
Declaration
public bool animateModel { get; set; }
Property Value
Used to disable an input state changing in the interactor. Useful for swapping to a different interactor on the same object.
Declaration
public bool enableInputActions { get; set; }
Property Value
Whether input tracking is enabled for this controller.
Declaration
public bool enableInputTracking { get; set; }
Property Value
Whether the controller model should be hidden.
Declaration
public bool hideControllerModel { get; set; }
Property Value
The animation transition to enable when de-selecting.
Declaration
public string modelDeSelectTransition { get; set; }
Property Value
The model prefab to show for this controller.
Declaration
public Transform modelPrefab { get; set; }
Property Value
The animation transition to enable when selecting.
Declaration
public string modelSelectTransition { get; set; }
Property Value
The model transform that is used as the parent for the controller model.
Declaration
public Transform modelTransform { get; set; }
Property Value
(Read Only) The current select interaction state.
Declaration
public InteractionState selectInteractionState { get; }
Property Value
(Read Only) The current ui press interaction state.
Declaration
public InteractionState uiPressInteractionState { get; }
Property Value
The time within the frame that the controller will sample input.
Declaration
public XRBaseController.UpdateType updateTrackingType { get; set; }
Property Value
Methods
Declaration
protected virtual void ApplyControllerState(XRInteractionUpdateOrder.UpdatePhase updatePhase, XRControllerState controllerState)
Parameters
Declaration
protected virtual void Awake()
Declaration
public virtual bool GetControllerState(out XRControllerState controllerState)
Parameters
Returns
This method is automatically called for "Just Before Render" input updates for VR devices.
Declaration
protected virtual void OnBeforeRender()
UnityEngine.Application.onBeforeRender
Declaration
protected virtual void OnDisable()
Declaration
protected virtual void OnEnable()
Play a haptic impulse on the controller if one is available.
Declaration
public virtual bool SendHapticImpulse(float amplitude, float duration)
Parameters
Type |
Name |
Description |
Single |
amplitude |
Amplitude (from 0.0 to 1.0) to play impulse at.
|
Single |
duration |
Duration (in seconds) to play haptic impulse.
|
Returns
Declaration
public virtual void SetControllerState(XRControllerState controllerState)
Parameters
Declaration
Declaration
protected virtual void UpdateController()
Declaration
protected virtual void UpdateControllerModelAnimation()
Declaration
protected virtual void UpdateInput(XRControllerState controllerState)
Parameters
Declaration
protected virtual void UpdateTrackingInput(XRControllerState controllerState)
Parameters