Class TouchController
- Namespace
- Stride.VirtualReality
- Assembly
- Stride.VirtualReality.dll
public abstract class TouchController : IDisposable
- Inheritance
-
TouchController
- Implements
- Extension Methods
Properties
AngularVelocity
public abstract Vector3 AngularVelocity { get; }
Property Value
Grip
public abstract float Grip { get; }
Property Value
HapticsSupport
Degree to which this touch controller type supports haptics. None: no haptics support, controller does not vibrate. Limited: cannot vibrate at any specific frequency or amplitude. Corresponding parameter is ignored. Full: vibrate method respects both frequency and vibration parameters
public abstract TouchController.ControllerHaptics HapticsSupport { get; }
Property Value
IndexPointing
public abstract bool IndexPointing { get; }
Property Value
IndexResting
public abstract bool IndexResting { get; }
Property Value
LinearVelocity
public abstract Vector3 LinearVelocity { get; }
Property Value
Position
public abstract Vector3 Position { get; }
Property Value
Rotation
public abstract Quaternion Rotation { get; }
Property Value
State
public abstract DeviceState State { get; }
Property Value
ThumbAxis
public abstract Vector2 ThumbAxis { get; }
Property Value
ThumbResting
public abstract bool ThumbResting { get; }
Property Value
ThumbUp
public abstract bool ThumbUp { get; }
Property Value
ThumbstickAxis
public abstract Vector2 ThumbstickAxis { get; }
Property Value
Trigger
public abstract float Trigger { get; }
Property Value
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public virtual void Dispose()
IsPressReleased(TouchControllerButton)
Returns true if in this frame the button was released
public abstract bool IsPressReleased(TouchControllerButton button)
Parameters
button
TouchControllerButton
Returns
IsPressed(TouchControllerButton)
Returns true if button switched is in the pressed state
public abstract bool IsPressed(TouchControllerButton button)
Parameters
button
TouchControllerButton
Returns
IsPressedDown(TouchControllerButton)
Returns true if in this frame the button switched to pressed state
public abstract bool IsPressedDown(TouchControllerButton button)
Parameters
button
TouchControllerButton
Returns
IsTouchReleased(TouchControllerButton)
Returns true if in this frame the button was released
public abstract bool IsTouchReleased(TouchControllerButton button)
Parameters
button
TouchControllerButton
Returns
IsTouched(TouchControllerButton)
Returns true if button switched is in the pressed state
public abstract bool IsTouched(TouchControllerButton button)
Parameters
button
TouchControllerButton
Returns
IsTouchedDown(TouchControllerButton)
Returns true if in this frame the button switched to pressed state
public abstract bool IsTouchedDown(TouchControllerButton button)
Parameters
button
TouchControllerButton
Returns
Update(GameTime)
public virtual void Update(GameTime time)
Parameters
time
GameTime
Vibrate(int, float, float)
Vibrate the controller for a fixed duration. Do so at specified frequency/amplitude if supported by runtime. Oculus runtime supports vibrating at frequency 0.0, 0.5, or 1.0, and amplitude in range [0.0, 1.0] openVR supports vibrating, but does not support frequency or amplitude openXR and WindowsMixedReality currently do not support vibration.
public abstract Task Vibrate(int durationMs, float frequency = 1, float amplitude = 1)
Parameters
durationMs
intVibration duration, in milliseconds
frequency
floatFrequency of vibration in range [0.0, 1.0]
amplitude
floatAmplitude of vibration in range [0.0, 1.0]