Package com.jme3.input.vr

Enum Class VRInputType

java.lang.Object
java.lang.Enum<VRInputType>
com.jme3.input.vr.VRInputType
All Implemented Interfaces:
Serializable, Comparable<VRInputType>, Constable
@Deprecated public enum VRInputType extends Enum<VRInputType>
Deprecated.
The type of a VR input. This enumeration enables to determine which part of the VR device is involved within input callback.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    OculusBottomButton
    Deprecated.
    The lower (not counting menu) buttons on the Oculus Touch controllers - A on the right controller, and X on the left.
    OculusBottomTouch
    Deprecated.
    The capacitive touch sensors on the lower buttons (X and A) of the Oculus Touch.
    OculusGripAxis
    Deprecated.
    The 'grab' button on the Oculus Touch controllers.
    OculusIndexPointing
    Deprecated.
    Is the user pointing their finger forwards, as if to press a button? This is internally calculated from proximity and filtering is applied - it should be used rather than !OculusIndexTouch, as it will probably lead to better results.
    OculusIndexTouch
    Deprecated.
    Is the user resting their finger on the trigger of an Oculus Touch controller?
    OculusMenuButton
    Deprecated.
    The game-usable menu button, under and to the left of the 'X' button on the left controller.
    OculusThumbrestTouch
    Deprecated.
    The capacitive touch sensors on the thumbrests of the Oculus Touch - this is a textured pad on the Oculus Touch controller next to the ABXY buttons for users to reset their thumbs on.
    OculusThumbstickAxis
    Deprecated.
    The thumbstick on the Oculus Touch controllers.
    OculusThumbstickButton
    Deprecated.
    The 'click' button on the Oculus Touch thumbsticks.
    OculusThumbstickTouch
    Deprecated.
    The capacitive touch sensors on the thumbsticks of the Oculus Touch.
    OculusThumbUp
    Deprecated.
    The state of a software calculation based on the capacitive touch sensor values that determine if the user has lifted their thumb off the controller, and can be used for gesture support.
    OculusTopButton
    Deprecated.
    The upper buttons on the Oculus Touch controllers - B on the right controller, and Y on the left.
    OculusTopTouch
    Deprecated.
    The capacitive touch sensors on the top buttons (Y and B) of the Oculus Touch.
    OculusTriggerAxis
    Deprecated.
    The trigger button on the Oculus Touch controllers.
    ViveGripButton
    Deprecated.
    an HTC vive grip button (about Vive controller).
    ViveMenuButton
    Deprecated.
    an HTC vive menu button (about Vive controller).
    ViveTrackpadAxis
    Deprecated.
    an HTC vive trackpad axis (about Vive controller).
    ViveTriggerAxis
    Deprecated.
    an HTC vive trigger axis (about Vive controller).

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getValue()
    Deprecated.
    Get the value (code) of the input type.
    static VRInputType
    valueOf(String name)
    Deprecated.
    Returns the enum constant of this class with the specified name.
    static VRInputType[]
    values()
    Deprecated.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ViveTriggerAxis

      public static final VRInputType ViveTriggerAxis
      Deprecated.
      an HTC vive trigger axis (about Vive controller).

    • ViveTrackpadAxis

      public static final VRInputType ViveTrackpadAxis
      Deprecated.
      an HTC vive trackpad axis (about Vive controller).

    • ViveGripButton

      public static final VRInputType ViveGripButton
      Deprecated.
      an HTC vive grip button (about Vive controller).

    • ViveMenuButton

      public static final VRInputType ViveMenuButton
      Deprecated.
      an HTC vive menu button (about Vive controller).

    • OculusThumbstickAxis

      public static final VRInputType OculusThumbstickAxis
      Deprecated.
      The thumbstick on the Oculus Touch controllers. Unlike the Vive controllers where the touchpad is commonly used as a virtual DPad, you should avoid using the thumbstick for purposes that do not require analog input.

    • OculusTriggerAxis

      public static final VRInputType OculusTriggerAxis
      Deprecated.
      The trigger button on the Oculus Touch controllers. This is the button under the user's index finger, and should not be used to pick up objects. See the Oculus Developer documentation.

    • OculusGripAxis

      public static final VRInputType OculusGripAxis
      Deprecated.
      The 'grab' button on the Oculus Touch controllers. This button should only (unless you have a compelling reason otherwise) be used to pick up objects.

    • OculusTopButton

      public static final VRInputType OculusTopButton
      Deprecated.
      The upper buttons on the Oculus Touch controllers - B on the right controller, and Y on the left.

    • OculusBottomButton

      public static final VRInputType OculusBottomButton
      Deprecated.
      The lower (not counting menu) buttons on the Oculus Touch controllers - A on the right controller, and X on the left.

    • OculusThumbstickButton

      public static final VRInputType OculusThumbstickButton
      Deprecated.
      The 'click' button on the Oculus Touch thumbsticks.

    • OculusMenuButton

      public static final VRInputType OculusMenuButton
      Deprecated.
      The game-usable menu button, under and to the left of the 'X' button on the left controller. Most games use this to pause - it preferably should be used for at least that purpose, and is uncomfortable to rest your thumb on (in games where you suddenly have to pause/open a menu).

    • OculusTopTouch

      public static final VRInputType OculusTopTouch
      Deprecated.
      The capacitive touch sensors on the top buttons (Y and B) of the Oculus Touch.

    • OculusBottomTouch

      public static final VRInputType OculusBottomTouch
      Deprecated.
      The capacitive touch sensors on the lower buttons (X and A) of the Oculus Touch.

    • OculusThumbstickTouch

      public static final VRInputType OculusThumbstickTouch
      Deprecated.
      The capacitive touch sensors on the thumbsticks of the Oculus Touch.

    • OculusThumbrestTouch

      public static final VRInputType OculusThumbrestTouch
      Deprecated.
      The capacitive touch sensors on the thumbrests of the Oculus Touch - this is a textured pad on the Oculus Touch controller next to the ABXY buttons for users to reset their thumbs on. While it probably goes without saying, only use this for gesture support and do not bind game elements to it.

    • OculusThumbUp

      public static final VRInputType OculusThumbUp
      Deprecated.
      The state of a software calculation based on the capacitive touch sensor values that determine if the user has lifted their thumb off the controller, and can be used for gesture support. This should be used instead of calculating this yourself based on the touch results of all the other parts of the controller.

    • OculusIndexTouch

      public static final VRInputType OculusIndexTouch
      Deprecated.
      Is the user resting their finger on the trigger of an Oculus Touch controller?

    • OculusIndexPointing

      public static final VRInputType OculusIndexPointing
      Deprecated.
      Is the user pointing their finger forwards, as if to press a button? This is internally calculated from proximity and filtering is applied - it should be used rather than !OculusIndexTouch, as it will probably lead to better results.

  • Method Details

    • values

      public static VRInputType[] values()
      Deprecated.
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VRInputType valueOf(String name)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Deprecated.
      Get the value (code) of the input type.
      Returns:
      the value (code) of the input type.