Interface IXRInteractionStrengthInteractable

An interface that represents an Interactable component which can express an interaction strength amount, which is a normalized value [0.0, 1.0] that describes the strength of selection.

Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Interactables
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public interface IXRInteractionStrengthInteractable : IXRInteractable
Remarks

For interactors that use motion controller input, this is typically based on the analog trigger or grip press amount. It can also be based on a poke amount for how deep a poke interactor has pressed into an interactable.

Properties

largestInteractionStrength

The largest interaction strength value of all interactors hovering or selecting this interactable.

Declaration
IReadOnlyBindableVariable<float> largestInteractionStrength { get; }
Property Value
Type Description
IReadOnlyBindableVariable<float>
See Also

Methods

GetInteractionStrength(IXRInteractor)

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

Declaration
float GetInteractionStrength(IXRInteractor interactor)
Parameters
Type Name Description
IXRInteractor interactor

The specific interactor to get the interaction strength between.
Returns
Type Description
float

Returns a value [0.0, 1.0] of the interaction strength.
See Also

ProcessInteractionStrength(UpdatePhase)

The XRInteractionManager calls this method to signal to update the interaction strength.

Declaration
void ProcessInteractionStrength(XRInteractionUpdateOrder.UpdatePhase updatePhase)
Parameters
Type Name Description
XRInteractionUpdateOrder.UpdatePhase updatePhase

The update phase during which this method is called.
See Also

See Also