Package org.vivecraft.api.data

Enum Class VRBodyPart

java.lang.Object
java.lang.Enum<VRBodyPart>
org.vivecraft.api.data.VRBodyPart
All Implemented Interfaces:
Serializable, Comparable<VRBodyPart>, Constable
public enum VRBodyPart extends Enum<VRBodyPart>
Corresponds to the different tracked device roles that are supported by Vivecraft.
Since:
1.3.0

  • Enum Constant Details

    • MAIN_HAND

      public static final VRBodyPart MAIN_HAND
      Main hand of the player, this is the hand the player points with. Which one that is can be identified with VRPose.isLeftHanded() or VRClientAPI.isLeftHanded() for the local player
      Since:
      1.3.0

    • OFF_HAND

      public static final VRBodyPart OFF_HAND

    • RIGHT_FOOT

      public static final VRBodyPart RIGHT_FOOT

    • LEFT_FOOT

      public static final VRBodyPart LEFT_FOOT

    • WAIST

      public static final VRBodyPart WAIST

    • RIGHT_KNEE

      public static final VRBodyPart RIGHT_KNEE

    • LEFT_KNEE

      public static final VRBodyPart LEFT_KNEE

    • RIGHT_ELBOW

      public static final VRBodyPart RIGHT_ELBOW

    • LEFT_ELBOW

      public static final VRBodyPart LEFT_ELBOW

  • Method Details

    • values

      public static VRBodyPart[] values()
      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 VRBodyPart valueOf(String name)
      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

    • opposite

      public VRBodyPart opposite()
      Gets the VRBodyPart which is the same type but on the opposite side of the body. VRBodyParts that don't have an opposite counterpart will return itself.
      Returns:
      the opposite VRBodyPart
      Since:
      1.3.0

    • fromInteractionHand

      public static VRBodyPart fromInteractionHand(InteractionHand hand)
      Gets the corresponding VRBodyPart to the provided InteractionHand
      Parameters:
      hand - InteractionHand to convert
      Returns:
      VRBodyPart that corresponds to the given InteractionHand
      Since:
      1.3.0

    • availableInMode

      public boolean availableInMode(FBTMode fbtMode)
      Whether this body part type is available in the provided full-body tracking mode.
      Parameters:
      fbtMode - The full-body tracking mode to check.
      Returns:
      Whether this body part has available data in the provided mode.
      Since:
      1.3.0

    • isFoot

      public boolean isFoot()
      Checks if this VRBodyPart is a foot
      Returns:
      Whether this body part is a foot.
      Since:
      1.3.0

    • isHand

      public boolean isHand()
      Checks if this VRBodyPart is a hand
      Returns:
      Whether this body part is a hand.
      Since:
      1.3.0