VRInputAPI (jMonkeyEngine3)

All Known Implementing Classes:

LWJGLOpenVRInput, OculusVRInput, OpenVRInput, OSVRInput
```
public interface VRInputAPI
```
An interface that represents a VR input (typically a VR device such as a controller).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Vector3f`	`getAngularVelocity(int controllerIndex)` Get the controller angular velocity on all axes.
`Vector2f`	`getAxis(int controllerIndex, VRInputType forAxis)` Get the axis value for the given input on the given controller.
`Vector2f`	`getAxisDeltaSinceLastCall(int controllerIndex, VRInputType forAxis)` Get the controller axis delta from the last value.
`float`	`getAxisMultiplier()` Get the controller axis multiplier.
`Vector2f`	`getAxisRaw(int controllerIndex, VRInputType forAxis)` Get the axis value for the given input on the given controller.
`Vector3f`	`getFinalObserverPosition(int index)` Get the position of the input after all positional tracking is complete.
`Quaternion`	`getFinalObserverRotation(int index)` Get where is the controller pointing, after all rotations are combined.
`Quaternion`	`getOrientation(int index)` Get the orientation of the input.
`Vector3f`	`getPosition(int index)` Get the position of the input.
`java.lang.Object`	`getRawControllerState(int index)` Get the native wrapping of a controller state.
`VRTrackedController`	`getTrackedController(int index)` Get a tracked controller (for example, a hand controller) that is attached to the VR system.
`int`	`getTrackedControllerCount()` Get the number of tracked controllers (for example, hand controllers) attached to the VR system.
`Vector3f`	`getVelocity(int controllerIndex)` Get the controller velocity on all axes.
`boolean`	`init()` Initialize the input.
`boolean`	`isButtonDown(int controllerIndex, VRInputType checkButton)` Check if the given button is down (more generally if the given input type is activated).
`boolean`	`isInputDeviceTracking(int index)` Check if the input device is actually tracked (i-e if we can obtain a pose from the input).
`boolean`	`isInputFocused()` Check if the VR system has the focus and if it's not used by other process.
`void`	`resetInputSinceLastCall()` Reset the current activation of the inputs.
`void`	`setAxisMultiplier(float set)` Set the controller axis multiplier.
`void`	`swapHands()` Swap the two hands (exchange the hands controller 1 and 2 indices).
`void`	`triggerHapticPulse(int controllerIndex, float seconds)` Trigger a haptic pulse on the selected controller for the duration given in parameters (in seconds).
`void`	`updateConnectedControllers()` Update the connected controllers.
`void`	`updateControllerStates()` Update the controller states.
`boolean`	`wasButtonPressedSinceLastCall(int controllerIndex, VRInputType checkButton)` Check if the given button / input from the given controller has been just pressed / activated.

- Method Detail
  - isButtonDown
```
boolean isButtonDown(int controllerIndex,
                     VRInputType checkButton)
```
    Check if the given button is down (more generally if the given input type is activated).
    
    Parameters:
    
    controllerIndex - the index of the controller to check.
    
    checkButton - the button / input to check.
    
    Returns:
    
    true if the button / input is down / activated and false otherwise.
  - wasButtonPressedSinceLastCall
```
boolean wasButtonPressedSinceLastCall(int controllerIndex,
                                      VRInputType checkButton)
```
    Check if the given button / input from the given controller has been just pressed / activated.
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    checkButton - the button / input to check.
    
    Returns:
    
    true if the given button / input from the given controller has been just pressed / activated and false otherwise.
  - resetInputSinceLastCall
```
void resetInputSinceLastCall()
```
    Reset the current activation of the inputs. After a call to this method, all input activation is considered as new activation.
    
    See Also:
    
    wasButtonPressedSinceLastCall(int, VRInputType)
  - getAxisDeltaSinceLastCall
```
Vector2f getAxisDeltaSinceLastCall(int controllerIndex,
                                   VRInputType forAxis)
```
    Get the controller axis delta from the last value.
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    forAxis - the axis.
    
    Returns:
    
    the controller axis delta from the last call.
  - getVelocity
```
Vector3f getVelocity(int controllerIndex)
```
    Get the controller velocity on all axes.
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    Returns:
    
    the controller velocity on all axes.
    
    See Also:
    
    getAngularVelocity(int)
  - getAngularVelocity
```
Vector3f getAngularVelocity(int controllerIndex)
```
    Get the controller angular velocity on all axes.
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    Returns:
    
    the controller angular velocity on all axes.
    
    See Also:
    
    getVelocity(int)
  - getAxis
```
Vector2f getAxis(int controllerIndex,
                 VRInputType forAxis)
```
    Get the axis value for the given input on the given controller. This value is the raw value multiplied by the axis multiplier.
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    forAxis - the axis.
    
    Returns:
    
    the axis value for the given input on the given controller.
    
    See Also:
    
    getAxisRaw(int, VRInputType), getAxisMultiplier()
  - getAxisRaw
```
Vector2f getAxisRaw(int controllerIndex,
                    VRInputType forAxis)
```
    Get the axis value for the given input on the given controller.
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    forAxis - the axis.
    
    Returns:
    
    the axis value for the given input on the given controller.
    
    See Also:
    
    getAxis(int, VRInputType)
  - init
```
boolean init()
```
    Initialize the input.
    
    Returns:
    
    true if the initialization is successful and false otherwise.
  - getTrackedControllerCount
```
int getTrackedControllerCount()
```
    Get the number of tracked controllers (for example, hand controllers) attached to the VR system.
    
    Returns:
    
    the number of controllers attached to the VR system.
    
    See Also:
    
    getTrackedController(int)
  - getTrackedController
```
VRTrackedController getTrackedController(int index)
```
    Get a tracked controller (for example, a hand controller) that is attached to the VR system.
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    the tracked controller (for example, a hand controller) that is attached to the VR system.
    
    See Also:
    
    getTrackedControllerCount()
  - updateConnectedControllers
```
void updateConnectedControllers()
```
    Update the connected controllers. This method should be used just after the initialization of the input.
  - updateControllerStates
```
void updateControllerStates()
```
    Update the controller states. This method should be called before accessing any controller data.
  - getRawControllerState
```
java.lang.Object getRawControllerState(int index)
```
    Get the native wrapping of a controller state.
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    the native wrapping of a controller state.
  - swapHands
```
void swapHands()
```
    Swap the two hands (exchange the hands controller 1 and 2 indices).
  - getAxisMultiplier
```
float getAxisMultiplier()
```
    Get the controller axis multiplier. The controller axis raw data (trackpad, trigger, ...) value is multiplied by the one given in parameter.
    
    Returns:
    
    the controller axis multiplier.
    
    See Also:
    
    setAxisMultiplier(float)
  - setAxisMultiplier
```
void setAxisMultiplier(float set)
```
    Set the controller axis multiplier. The controller axis raw data (trackpad, trigger, ...) value is multiplied by the one given in parameter.
    
    Parameters:
    
    set - the controller axis multiplier.
    
    See Also:
    
    getAxisMultiplier()
  - isInputFocused
```
boolean isInputFocused()
```
    Check if the VR system has the focus and if it's not used by other process.
    
    Returns:
    
    true if the VR system has the focus and false otherwise.
  - isInputDeviceTracking
```
boolean isInputDeviceTracking(int index)
```
    Check if the input device is actually tracked (i-e if we can obtain a pose from the input).
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    true if the input device is actually tracked and false otherwise.
  - getOrientation
```
Quaternion getOrientation(int index)
```
    Get the orientation of the input.
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    the orientation of the input.
  - getPosition
```
Vector3f getPosition(int index)
```
    Get the position of the input.
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    the position of the input.
  - getFinalObserverRotation
```
Quaternion getFinalObserverRotation(int index)
```
    Get where is the controller pointing, after all rotations are combined. This position should include observer rotation from the VR application.
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    the rotation of the input after all positional tracking is complete.
  - getFinalObserverPosition
```
Vector3f getFinalObserverPosition(int index)
```
    Get the position of the input after all positional tracking is complete. This position should include observer position from the VR application.
    
    Parameters:
    
    index - the index of the controller.
    
    Returns:
    
    the position of the input after all positional tracking is complete.
  - triggerHapticPulse
```
void triggerHapticPulse(int controllerIndex,
                        float seconds)
```
    Trigger a haptic pulse on the selected controller for the duration given in parameters (in seconds).
    
    Parameters:
    
    controllerIndex - the index of the controller.
    
    seconds - the duration of the pulse in seconds.

Interface VRInputAPI

Method Summary

Method Detail

isButtonDown

wasButtonPressedSinceLastCall

resetInputSinceLastCall

getAxisDeltaSinceLastCall

getVelocity

getAngularVelocity

getAxis

getAxisRaw

init

getTrackedControllerCount

getTrackedController

updateConnectedControllers

updateControllerStates

getRawControllerState

swapHands

getAxisMultiplier

setAxisMultiplier

isInputFocused

isInputDeviceTracking

getOrientation

getPosition

getFinalObserverRotation

getFinalObserverPosition

triggerHapticPulse