Class HapticImpulsePlayer

Component that allows for sending haptic impulses to a device.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

HapticImpulsePlayer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

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, bool)

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, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/Haptics/Haptic Impulse Player", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Haptics.HapticImpulsePlayer.html")]
public class HapticImpulsePlayer : MonoBehaviour

Properties

amplitudeMultiplier

Amplitude multiplier which can be used to dampen the haptic impulses sent by this component.

Declaration

public float amplitudeMultiplier { get; set; }

Property Value

Type	Description
float

hapticOutput

Specifies the output haptic control or controller that haptic impulses will be sent to.

Declaration

public XRInputHapticImpulseProvider hapticOutput { get; set; }

Property Value

Type	Description
XRInputHapticImpulseProvider

Methods

Awake()

See MonoBehaviour.

Declaration

protected void Awake()

OnDisable()

See MonoBehaviour.

Declaration

protected void OnDisable()

OnEnable()

See MonoBehaviour.

Declaration

protected void OnEnable()

SendHapticImpulse(float, float)

Sends a haptic impulse on the configured channel or default channel of the configured device.

Declaration

public bool SendHapticImpulse(float amplitude, float duration)

Parameters

Type	Name	Description
float	amplitude	The desired motor amplitude that should be within a [0-1] range.
float	duration	The desired duration of the impulse in seconds.

Returns

Type	Description
bool	Returns true if successful. Otherwise, returns false.

Remarks

This method considers sending the haptic impulse a success (and thus returns true) if the haptic impulse was successfully sent to the device even if frequency is ignored or not supported by the device.
Uses the default frequency of the device.

SendHapticImpulse(float, float, float)

Sends a haptic impulse on the configured channel or default channel of the configured device.

Declaration

public bool SendHapticImpulse(float amplitude, float duration, float frequency)

Parameters

Type	Name	Description
float	amplitude	The desired motor amplitude that should be within a [0-1] range.
float	duration	The desired duration of the impulse in seconds.
float	frequency	The desired frequency of the impulse in Hz. A value of 0 means to use the default frequency of the device.

Returns

Type	Description
bool	Returns true if successful. Otherwise, returns false.

Remarks

This method considers sending the haptic impulse a success (and thus returns true) if the haptic impulse was successfully sent to the device even if frequency is ignored or not supported by the device.
Frequency is currently only functional when the OpenXR Plugin (com.unity.xr.openxr) package is installed and the input action is using an input binding to a Haptic Control.