VRControllerclass
Represents a VR controller, along with its transform, velocity, and inputs.
Methods11
Showing 11 methods
public virtual override Sandbox.VR.VRController <Clone>$()
public float GetFingerCurl(int index)
Get the skeletal value (from 0 to 1) of a specified finger curl index.
| Parameter | Type | Description |
|---|---|---|
| index | int | — |
float—public float GetFingerSplay(int index)
Get the skeletal value (from 0 to 1) of a specified finger splay index.
| Parameter | Type | Description |
|---|---|---|
| index | int | — |
float—public float GetFingerValue(Sandbox.VR.FingerValue value)
Get the skeletal value (from 0 to 1) of a specified `Sandbox.VR.FingerValue` - includes curl and splay.
| Parameter | Type | Description |
|---|---|---|
| value | FingerValue | — |
float—public System.Collections.Generic.List`1<Sandbox.VR.VRHandJointData> GetJointData()
Obsolete: Please use GetJoints()
public Sandbox.VR.VRHandJointData[] GetJoints(Sandbox.VR.MotionRange motionRange = 0)
Returns joint data for a specific motion range.
| Parameter | Type | Description |
|---|---|---|
| motionRange = 0 | MotionRange | Whether the joints returned represent a raw hand pose, or one that represents the hand wrapping around the controller. |
public Sandbox.Model GetModel()
Retrieves or creates a cached model that can be used to render this controller.
public void StopAllHaptics()
Stops all rumble and haptic events on this controller.
void—public void StopAllVibrations()
Stop all vibration events on this controller.
void—public void TriggerHaptics(Sandbox.HapticEffect effect, float lengthScale = 1, float frequencyScale = 1, float amplitudeScale = 1)
Trigger a vibration based on a predefined `Sandbox.HapticPattern`. All `Sandbox.HapticPattern`s are normalized (start at 0, peak at 1).
| Parameter | Type | Description |
|---|---|---|
| effect | HapticEffect | The pattern to use |
| lengthScale = 1 | float | The amount to scale the pattern's length by. |
| frequencyScale = 1 | float | The amount to scale the pattern's frequency by. |
| amplitudeScale = 1 | float | The amount to scale the pattern's amplitude by. |
void—public void TriggerHapticVibration(float duration, float frequency, float amplitude)
Triggers a haptic vibration event on the controller for this hand.
Obsolete: Use TriggerHaptics instead
Note
If a haptic event is already running it will be interrupted immediately.
| Parameter | Type | Description |
|---|---|---|
| duration | float | How long the haptic action should last (in seconds - can be 0 to "pulse" it) |
| frequency | float | How often the haptic motor should bounce (0 - 320 in hz. The lower end being more useful) |
| amplitude | float | How intense the haptic should be (0 - 1) |
void—No results match this filter.
Properties9
Showing 9 properties
public virtual Transform Sandbox.VR.VRController.AimTransform { get; set; }
The aim pose transform in world space (pointing forward).
public Sandbox.VR.DigitalInput Sandbox.VR.VRController.ButtonA { get; set; }
The primary button on this controller (Usually A, can be X for Oculus Touch)
public Sandbox.VR.DigitalInput Sandbox.VR.VRController.ButtonB { get; set; }
The secondary button on this controller (Usually B, can be Y for Oculus Touch)
public Sandbox.VR.AnalogInput Sandbox.VR.VRController.Grip { get; set; }
The grip input on this controller
public bool Sandbox.VR.VRController.IsHandTracked { get; set; }
Is this controller currently being represented using full hand tracking?
bool—public Sandbox.VR.AnalogInput2D Sandbox.VR.VRController.Joystick { get; set; }
The primary joystick input on this controller
public Sandbox.VR.DigitalInput Sandbox.VR.VRController.JoystickPress { get; set; }
The primary joystick press on this controller
public virtual Transform Sandbox.VR.VRController.Transform { get; set; }
The grip pose transform in world space (centered on palm/grip).
public Sandbox.VR.AnalogInput Sandbox.VR.VRController.Trigger { get; set; }
The trigger input on this controller
No results match this filter.