UxrControllerHapticEventArgs Class

Wraps information about a haptic request event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    UltimateXR.Devices.UxrControllerHapticEventArgs
Namespace: UltimateXR.Devices
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrControllerHapticEventArgs : EventArgs


The UxrControllerHapticEventArgs type exposes the following members.

Constructors

NameDescription
Public methodUxrControllerHapticEventArgs(UxrHandSide, UxrHapticClip) Constructor that registers a Clip event.
Public methodUxrControllerHapticEventArgs(UxrHandSide, Single, Single, Single, UxrHapticMode) Constructor that registers a Raw event.

Properties

NameDescription
Public propertyAmplitude Gets the haptic feedback raw amplitude if the event is Raw.
Public propertyDurationSeconds Gets the haptic feedback duration in seconds if the event is Raw.
Public propertyFrequency Gets the haptic feedback raw frequency if the event is Raw.
Public propertyHandSide Gets the haptic feedback target hand.
Public propertyHapticClip Gets the haptic clip if the event is Clip.
Public propertyHapticEventType Gets the haptic event type.
Public propertyHapticMode Gets the haptic feedback playback mode.

Methods

NameDescription
Public methodStatic memberGetHapticStopEvent Generates a Stop event for the given hand

Extension Methods

NameDescription
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Devices Namespace