Package org.lwjgl.openvr

Class VRChaperone

java.lang.Object
org.lwjgl.openvr.VRChaperone
public class VRChaperone extends Object
HIGH LEVEL TRACKING SPACE ASSUMPTIONS:
  • 0,0,0 is the preferred standing area center.
  • 0Y is the floor height.
  • -Z is the preferred forward facing direction.

  • Method Details

    • VRChaperone_GetCalibrationState

      public static int VRChaperone_GetCalibrationState()
      Get the current state of Chaperone calibration. This state can change at any time during a session due to physical base station changes.

    • nVRChaperone_GetPlayAreaSize

      public static boolean nVRChaperone_GetPlayAreaSize(long pSizeX, long pSizeZ)
      Unsafe version of: GetPlayAreaSize

    • VRChaperone_GetPlayAreaSize

      public static boolean VRChaperone_GetPlayAreaSize(FloatBuffer pSizeX, FloatBuffer pSizeZ)
      Returns the width and depth of the Play Area (formerly named Soft Bounds) in X and Z. Tracking space center(0, 0, 0) is the center of the Play Area.

    • nVRChaperone_GetPlayAreaRect

      public static boolean nVRChaperone_GetPlayAreaRect(long rect)
      Unsafe version of: GetPlayAreaRect

    • VRChaperone_GetPlayAreaRect

      public static boolean VRChaperone_GetPlayAreaRect(HmdQuad rect)
      Returns a quad describing the Play Area (formerly named Soft Bounds).

      The corners form a rectangle. Corners are in counter-clockwise order, starting at the front-right. The positions are given relative to the standing origin. The center of the rectangle is the center of the user's calibrated play space, not necessarily the standing origin. The Play Area's forward direction goes from its center through the mid-point of a line drawn between the first and second corner. The quad lies on the XZ plane (height = 0y), with 2 sides parallel to the X-axis and two sides parallel to the Z-axis of the user's calibrated Play Area.

    • VRChaperone_ReloadInfo

      public static void VRChaperone_ReloadInfo()
      Reload Chaperone data from the .vrchap file on disk.

    • nVRChaperone_SetSceneColor

      public static void nVRChaperone_SetSceneColor(long color, long __functionAddress)
      Unsafe version of: SetSceneColor

    • nVRChaperone_SetSceneColor

      public static void nVRChaperone_SetSceneColor(long color)
      Unsafe version of: SetSceneColor

    • VRChaperone_SetSceneColor

      public static void VRChaperone_SetSceneColor(HmdColor color)
      Optionally give the chaperone system a hit about the color and brightness in the scene.

    • nVRChaperone_GetBoundsColor

      public static void nVRChaperone_GetBoundsColor(long pOutputColorArray, int nNumOutputColors, float flCollisionBoundsFadeDistance, long pOutputCameraColor)
      Unsafe version of: GetBoundsColor

    • VRChaperone_GetBoundsColor

      public static void VRChaperone_GetBoundsColor(HmdColor.Buffer pOutputColorArray, float flCollisionBoundsFadeDistance, HmdColor pOutputCameraColor)
      Get the current chaperone bounds draw color and brightness.

    • VRChaperone_AreBoundsVisible

      public static boolean VRChaperone_AreBoundsVisible()
      Determine whether the bounds are showing right now.

    • VRChaperone_ForceBoundsVisible

      public static void VRChaperone_ForceBoundsVisible(boolean bForce)
      Force the bounds to show, mostly for utilities.

    • VRChaperone_ResetZeroPose

      public static void VRChaperone_ResetZeroPose(int eTrackingUniverseOrigin)
      Sets the zero pose for the given tracker coordinate system to the current position and yaw of the HMD.

      After ResetZeroPose all GetDeviceToAbsoluteTrackingPose calls as the origin will be relative to this new zero pose. The new zero coordinate system will not change the fact that the Y axis is up in the real world, so the next pose returned from GetDeviceToAbsoluteTrackingPose after a call to ResetZeroPose may not be exactly an identity matrix.

      NOTE: This function overrides the user's previously saved zero pose and should only be called as the result of a user action. Users are also able to set their zero pose via the OpenVR Dashboard.

      Parameters:
      eTrackingUniverseOrigin - one of:
      VR.ETrackingUniverseOrigin_TrackingUniverseSeated
      VR.ETrackingUniverseOrigin_TrackingUniverseStanding
      VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated