Class VRChaperoneSetup

java.lang.Object
org.lwjgl.openvr.VRChaperoneSetup

public class VRChaperoneSetup extends Object
Manages the working copy of the chaperone info. By default this will be the same as the live copy. Any changes made with this interface will stay in the working copy until CommitWorkingCopy is called, at which point the working copy and the live copy will be the same again.
  • Method Details

    • VRChaperoneSetup_CommitWorkingCopy

      public static boolean VRChaperoneSetup_CommitWorkingCopy(int configFile)
      Saves the current working copy to disk.
      Parameters:
      configFile - one of:
      VR.EChaperoneConfigFile_LiveVR.EChaperoneConfigFile_Temp
    • VRChaperoneSetup_RevertWorkingCopy

      public static void VRChaperoneSetup_RevertWorkingCopy()
      Reverts the working copy to match the live chaperone calibration.

      To modify existing data this MUST be do WHILE getting a non-error ChaperoneCalibrationStatus. Only after this should you do gets and sets on the existing data.

    • nVRChaperoneSetup_GetWorkingPlayAreaSize

      public static boolean nVRChaperoneSetup_GetWorkingPlayAreaSize(long pSizeX, long pSizeZ)
      Unsafe version of: GetWorkingPlayAreaSize
    • VRChaperoneSetup_GetWorkingPlayAreaSize

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

      public static boolean nVRChaperoneSetup_GetWorkingPlayAreaRect(long rect)
      Unsafe version of: GetWorkingPlayAreaRect
    • VRChaperoneSetup_GetWorkingPlayAreaRect

      public static boolean VRChaperoneSetup_GetWorkingPlayAreaRect(HmdQuad rect)
      Returns the 4 corner positions of the Play Area (formerly named Soft Bounds) from the working copy.

      Corners are in clockwise order. Tracking space center (0,0,0) is the center of the Play Area. It's a rectangle. 2 sides are parallel to the X axis and 2 sides are parallel to the Z axis. Height of every corner is 0Y (on the floor).

    • nVRChaperoneSetup_GetWorkingCollisionBoundsInfo

      public static boolean nVRChaperoneSetup_GetWorkingCollisionBoundsInfo(long pQuadsBuffer, long punQuadsCount)
    • VRChaperoneSetup_GetWorkingCollisionBoundsInfo

      public static boolean VRChaperoneSetup_GetWorkingCollisionBoundsInfo(@Nullable HmdQuad.Buffer pQuadsBuffer, IntBuffer punQuadsCount)
      Returns the number of Quads if the buffer points to null. Otherwise it returns Quads into the buffer up to the max specified from the working copy.
    • nVRChaperoneSetup_GetLiveCollisionBoundsInfo

      public static boolean nVRChaperoneSetup_GetLiveCollisionBoundsInfo(long pQuadsBuffer, long punQuadsCount)
      Unsafe version of: GetLiveCollisionBoundsInfo
    • VRChaperoneSetup_GetLiveCollisionBoundsInfo

      public static boolean VRChaperoneSetup_GetLiveCollisionBoundsInfo(@Nullable HmdQuad.Buffer pQuadsBuffer, IntBuffer punQuadsCount)
      Returns the number of Quads if the buffer points to null. Otherwise it returns Quads into the buffer up to the max specified.
    • nVRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose

      public static boolean nVRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose(long pmatSeatedZeroPoseToRawTrackingPose)
    • VRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose

      public static boolean VRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pmatSeatedZeroPoseToRawTrackingPose)
      Returns the preferred seated position from the working copy.
    • nVRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose

      public static boolean nVRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose(long pmatStandingZeroPoseToRawTrackingPose)
    • VRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose

      public static boolean VRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose(HmdMatrix34 pmatStandingZeroPoseToRawTrackingPose)
      Returns the standing origin from the working copy.
    • VRChaperoneSetup_SetWorkingPlayAreaSize

      public static void VRChaperoneSetup_SetWorkingPlayAreaSize(float sizeX, float sizeZ)
      Sets the Play Area in the working copy.
    • nVRChaperoneSetup_SetWorkingCollisionBoundsInfo

      public static void nVRChaperoneSetup_SetWorkingCollisionBoundsInfo(long pQuadsBuffer, int unQuadsCount)
    • VRChaperoneSetup_SetWorkingCollisionBoundsInfo

      public static void VRChaperoneSetup_SetWorkingCollisionBoundsInfo(HmdQuad.Buffer pQuadsBuffer)
      Sets the Collision Bounds in the working copy.

      Note: ceiling height is ignored.

    • nVRChaperoneSetup_SetWorkingPerimeter

      public static void nVRChaperoneSetup_SetWorkingPerimeter(long pPointBuffer, int unPointCount)
      Unsafe version of: SetWorkingPerimeter
    • VRChaperoneSetup_SetWorkingPerimeter

      public static void VRChaperoneSetup_SetWorkingPerimeter(HmdVector2.Buffer pPointBuffer)
      Sets the Collision Bounds in the working copy
    • nVRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose

      public static void nVRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose(long pMatSeatedZeroPoseToRawTrackingPose)
    • VRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose

      public static void VRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pMatSeatedZeroPoseToRawTrackingPose)
      Sets the preferred seated position in the working copy.
    • nVRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose

      public static void nVRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose(long pMatStandingZeroPoseToRawTrackingPose)
    • VRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose

      public static void VRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose(HmdMatrix34 pMatStandingZeroPoseToRawTrackingPose)
      Sets the preferred standing position in the working copy.
    • VRChaperoneSetup_ReloadFromDisk

      public static void VRChaperoneSetup_ReloadFromDisk(int configFile)
      Tear everything down and reload it from the file on disk.
      Parameters:
      configFile - one of:
      VR.EChaperoneConfigFile_LiveVR.EChaperoneConfigFile_Temp
    • nVRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose

      public static boolean nVRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose(long pmatSeatedZeroPoseToRawTrackingPose)
    • VRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose

      public static boolean VRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pmatSeatedZeroPoseToRawTrackingPose)
      Returns the preferred seated position.
    • nVRChaperoneSetup_ExportLiveToBuffer

      public static boolean nVRChaperoneSetup_ExportLiveToBuffer(long pBuffer, long pnBufferLength)
    • VRChaperoneSetup_ExportLiveToBuffer

      public static boolean VRChaperoneSetup_ExportLiveToBuffer(@Nullable ByteBuffer pBuffer, IntBuffer pnBufferLength)
    • nVRChaperoneSetup_ImportFromBufferToWorking

      public static boolean nVRChaperoneSetup_ImportFromBufferToWorking(long pBuffer, int nImportFlags)
    • VRChaperoneSetup_ImportFromBufferToWorking

      public static boolean VRChaperoneSetup_ImportFromBufferToWorking(ByteBuffer pBuffer, int nImportFlags)
    • VRChaperoneSetup_ShowWorkingSetPreview

      public static void VRChaperoneSetup_ShowWorkingSetPreview()
      Shows the chaperone data in the working set to preview in the compositor.
    • VRChaperoneSetup_HideWorkingSetPreview

      public static void VRChaperoneSetup_HideWorkingSetPreview()
      Hides the chaperone data in the working set to preview in the compositor (if it was visible).
    • VRChaperoneSetup_RoomSetupStarting

      public static void VRChaperoneSetup_RoomSetupStarting()
      Fires an event that the tracking system can use to know room setup is about to begin.

      This lets the tracking system make any last minute adjustments that should be incorporated into the new setup. If the user is adjusting live in HMD using a tweak tool, keep in mind that calling this might cause the user to see the room jump.