Class XRBaseController

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
XRBaseController
ActionBasedController
XRController
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[DefaultExecutionOrder(-29990)]
[DisallowMultipleComponent]
public abstract class XRBaseController : MonoBehaviour

Properties

activateInteractionState

(Read Only) The current activate interaction state.

Declaration
public InteractionState activateInteractionState { get; }
Property Value
Type Description
InteractionState

anchorControlDeadzone

Declaration
public float anchorControlDeadzone { get; set; }
Property Value
Type Description
Single

anchorControlOffAxisDeadzone

Declaration
public float anchorControlOffAxisDeadzone { get; set; }
Property Value
Type Description
Single

animateModel

Whether this model animates in response to interaction events.

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

enableInputActions

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
Type Description
Boolean

enableInputTracking

Whether input tracking is enabled for this controller.

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

hideControllerModel

Whether the controller model should be hidden.

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

modelDeSelectTransition

The animation transition to enable when de-selecting.

Declaration
public string modelDeSelectTransition { get; set; }
Property Value
Type Description
String

modelPrefab

The model prefab to show for this controller.

Declaration
public Transform modelPrefab { get; set; }
Property Value
Type Description
Transform

modelSelectTransition

The animation transition to enable when selecting.

Declaration
public string modelSelectTransition { get; set; }
Property Value
Type Description
String

modelTransform

The model transform that is used as the parent for the controller model.

Declaration
public Transform modelTransform { get; set; }
Property Value
Type Description
Transform
Remarks

Automatically instantiated and set in Awake(). Setting this will not automatically destroy the previous object.

selectInteractionState

(Read Only) The current select interaction state.

Declaration
public InteractionState selectInteractionState { get; }
Property Value
Type Description
InteractionState

uiPressInteractionState

(Read Only) The current ui press interaction state.

Declaration
public InteractionState uiPressInteractionState { get; }
Property Value
Type Description
InteractionState

updateTrackingType

The time within the frame that the controller will sample input.

Declaration
public XRBaseController.UpdateType updateTrackingType { get; set; }
Property Value
Type Description
XRBaseController.UpdateType
See Also

Methods

ApplyControllerState(XRInteractionUpdateOrder.UpdatePhase, XRControllerState)

Declaration
protected virtual void ApplyControllerState(XRInteractionUpdateOrder.UpdatePhase updatePhase, XRControllerState controllerState)
Parameters
Type Name Description
XRInteractionUpdateOrder.UpdatePhase updatePhase
XRControllerState controllerState

Awake()

Declaration
protected virtual void Awake()

GetControllerState(out XRControllerState)

Declaration
public virtual bool GetControllerState(out XRControllerState controllerState)
Parameters
Type Name Description
XRControllerState controllerState
Returns
Type Description
Boolean

OnBeforeRender()

This method is automatically called for "Just Before Render" input updates for VR devices.

Declaration
protected virtual void OnBeforeRender()
See Also
UnityEngine.Application.onBeforeRender

OnDisable()

Declaration
protected virtual void OnDisable()

OnEnable()

Declaration
protected virtual void OnEnable()

SendHapticImpulse(Single, Single)

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
Type Description
Boolean

Returns true if successful. Returns false otherwise.

SetControllerState(XRControllerState)

Declaration
public virtual void SetControllerState(XRControllerState controllerState)
Parameters
Type Name Description
XRControllerState controllerState

Update()

Declaration
protected void Update()

UpdateController()

Declaration
protected virtual void UpdateController()

UpdateControllerModelAnimation()

Update the animation on the instance of the modelPrefab (if the prefab contains an Animator).

Declaration
protected virtual void UpdateControllerModelAnimation()
See Also

UpdateInput(XRControllerState)

Declaration
protected virtual void UpdateInput(XRControllerState controllerState)
Parameters
Type Name Description
XRControllerState controllerState

UpdateTrackingInput(XRControllerState)

Declaration
protected virtual void UpdateTrackingInput(XRControllerState controllerState)
Parameters
Type Name Description
XRControllerState controllerState