Top Description Constructors Methods
org.lwjgl.openvr

public Class VRChaperoneSetup

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
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.

Constructor Summary

AccessConstructor and Description
protected
VRChaperoneSetup()

Method Summary

Modifier and TypeMethod and Description
public static boolean
nVRChaperoneSetup_ExportLiveToBuffer(long pBuffer, long pnBufferLength)

public static boolean
nVRChaperoneSetup_GetLiveCollisionBoundsInfo(long pQuadsBuffer, long punQuadsCount)

Unsafe version of: GetLiveCollisionBoundsInfo

public static boolean
nVRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose(long pmatSeatedZeroPoseToRawTrackingPose)

Unsafe version of: GetLiveSeatedZeroPoseToRawTrackingPose

public static boolean
nVRChaperoneSetup_GetWorkingCollisionBoundsInfo(long pQuadsBuffer, long punQuadsCount)

Unsafe version of: GetWorkingCollisionBoundsInfo

public static boolean
nVRChaperoneSetup_GetWorkingPlayAreaRect(long rect)

Unsafe version of: GetWorkingPlayAreaRect

public static boolean
nVRChaperoneSetup_GetWorkingPlayAreaSize(long pSizeX, long pSizeZ)

Unsafe version of: GetWorkingPlayAreaSize

public static boolean
nVRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose(long pmatSeatedZeroPoseToRawTrackingPose)

Unsafe version of: GetWorkingSeatedZeroPoseToRawTrackingPose

public static boolean
nVRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose(long pmatStandingZeroPoseToRawTrackingPose)

Unsafe version of: GetWorkingStandingZeroPoseToRawTrackingPose

public static boolean
nVRChaperoneSetup_ImportFromBufferToWorking(long pBuffer, int nImportFlags)

public static void
nVRChaperoneSetup_SetWorkingCollisionBoundsInfo(long pQuadsBuffer, int unQuadsCount)

Unsafe version of: SetWorkingCollisionBoundsInfo

public static void
nVRChaperoneSetup_SetWorkingPerimeter(long pPointBuffer, int unPointCount)

Unsafe version of: SetWorkingPerimeter

public static void
nVRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose(long pMatSeatedZeroPoseToRawTrackingPose)

Unsafe version of: SetWorkingSeatedZeroPoseToRawTrackingPose

public static void
nVRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose(long pMatStandingZeroPoseToRawTrackingPose)

Unsafe version of: SetWorkingStandingZeroPoseToRawTrackingPose

public static boolean
VRChaperoneSetup_CommitWorkingCopy(int
one of:
VR#EChaperoneConfigFile_LiveVR#EChaperoneConfigFile_Temp
configFile)

Saves the current working copy to disk.

public static boolean
VRChaperoneSetup_ExportLiveToBuffer(ByteBuffer pBuffer, IntBuffer pnBufferLength)

public static boolean
VRChaperoneSetup_GetLiveCollisionBoundsInfo(HmdQuad.Buffer pQuadsBuffer, IntBuffer punQuadsCount)

Returns the number of Quads if the buffer points to null.

public static boolean
VRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pmatSeatedZeroPoseToRawTrackingPose)

Returns the preferred seated position.

public static boolean
VRChaperoneSetup_GetWorkingCollisionBoundsInfo(HmdQuad.Buffer pQuadsBuffer, IntBuffer punQuadsCount)

Returns the number of Quads if the buffer points to null.

public static boolean
VRChaperoneSetup_GetWorkingPlayAreaRect(HmdQuad rect)

Returns the 4 corner positions of the Play Area (formerly named Soft Bounds) from the working copy.

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.

public static boolean
VRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pmatSeatedZeroPoseToRawTrackingPose)

Returns the preferred seated position from the working copy.

public static boolean
VRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose(HmdMatrix34 pmatStandingZeroPoseToRawTrackingPose)

Returns the standing origin from the working copy.

public static void
VRChaperoneSetup_HideWorkingSetPreview()

Hides the chaperone data in the working set to preview in the compositor (if it was visible).

public static boolean
VRChaperoneSetup_ImportFromBufferToWorking(ByteBuffer pBuffer, int nImportFlags)

public static void
VRChaperoneSetup_ReloadFromDisk(int
one of:
VR#EChaperoneConfigFile_LiveVR#EChaperoneConfigFile_Temp
configFile)

Tear everything down and reload it from the file on disk.

public static void
VRChaperoneSetup_RevertWorkingCopy()

Reverts the working copy to match the live chaperone calibration.

public static void
VRChaperoneSetup_RoomSetupStarting()

Fires an event that the tracking system can use to know room setup is about to begin.

public static void
VRChaperoneSetup_SetWorkingCollisionBoundsInfo(HmdQuad.Buffer pQuadsBuffer)

Sets the Collision Bounds in the working copy.

public static void
VRChaperoneSetup_SetWorkingPerimeter(HmdVector2.Buffer pPointBuffer)

Sets the Collision Bounds in the working copy

public static void
VRChaperoneSetup_SetWorkingPlayAreaSize(float sizeX, float sizeZ)

Sets the Play Area in the working copy.

public static void
VRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pMatSeatedZeroPoseToRawTrackingPose)

Sets the preferred seated position in the working copy.

public static void
VRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose(HmdMatrix34 pMatStandingZeroPoseToRawTrackingPose)

Sets the preferred standing position in the working copy.

public static void
VRChaperoneSetup_ShowWorkingSetPreview()

Shows the chaperone data in the working set to preview in the compositor.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

VRChaperoneSetupback to summary
protected VRChaperoneSetup()

Method Detail

nVRChaperoneSetup_ExportLiveToBufferback to summary
public static boolean nVRChaperoneSetup_ExportLiveToBuffer(long pBuffer, long pnBufferLength)
nVRChaperoneSetup_GetLiveCollisionBoundsInfoback to summary
public static boolean nVRChaperoneSetup_GetLiveCollisionBoundsInfo(long pQuadsBuffer, long punQuadsCount)

Unsafe version of: GetLiveCollisionBoundsInfo

nVRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPoseback to summary
public static boolean nVRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose(long pmatSeatedZeroPoseToRawTrackingPose)

Unsafe version of: GetLiveSeatedZeroPoseToRawTrackingPose

nVRChaperoneSetup_GetWorkingCollisionBoundsInfoback to summary
public static boolean nVRChaperoneSetup_GetWorkingCollisionBoundsInfo(long pQuadsBuffer, long punQuadsCount)

Unsafe version of: GetWorkingCollisionBoundsInfo

nVRChaperoneSetup_GetWorkingPlayAreaRectback to summary
public static boolean nVRChaperoneSetup_GetWorkingPlayAreaRect(long rect)

Unsafe version of: GetWorkingPlayAreaRect

nVRChaperoneSetup_GetWorkingPlayAreaSizeback to summary
public static boolean nVRChaperoneSetup_GetWorkingPlayAreaSize(long pSizeX, long pSizeZ)

Unsafe version of: GetWorkingPlayAreaSize

nVRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPoseback to summary
public static boolean nVRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose(long pmatSeatedZeroPoseToRawTrackingPose)

Unsafe version of: GetWorkingSeatedZeroPoseToRawTrackingPose

nVRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPoseback to summary
public static boolean nVRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose(long pmatStandingZeroPoseToRawTrackingPose)

Unsafe version of: GetWorkingStandingZeroPoseToRawTrackingPose

nVRChaperoneSetup_ImportFromBufferToWorkingback to summary
public static boolean nVRChaperoneSetup_ImportFromBufferToWorking(long pBuffer, int nImportFlags)
nVRChaperoneSetup_SetWorkingCollisionBoundsInfoback to summary
public static void nVRChaperoneSetup_SetWorkingCollisionBoundsInfo(long pQuadsBuffer, int unQuadsCount)

Unsafe version of: SetWorkingCollisionBoundsInfo

nVRChaperoneSetup_SetWorkingPerimeterback to summary
public static void nVRChaperoneSetup_SetWorkingPerimeter(long pPointBuffer, int unPointCount)

Unsafe version of: SetWorkingPerimeter

nVRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPoseback to summary
public static void nVRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose(long pMatSeatedZeroPoseToRawTrackingPose)

Unsafe version of: SetWorkingSeatedZeroPoseToRawTrackingPose

nVRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPoseback to summary
public static void nVRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose(long pMatStandingZeroPoseToRawTrackingPose)

Unsafe version of: SetWorkingStandingZeroPoseToRawTrackingPose

VRChaperoneSetup_CommitWorkingCopyback to summary
public static boolean VRChaperoneSetup_CommitWorkingCopy(int configFile)

Saves the current working copy to disk.

Parameters
configFile:int

one of:

VR#EChaperoneConfigFile_LiveVR#EChaperoneConfigFile_Temp
Annotations
@NativeType:bool
VRChaperoneSetup_ExportLiveToBufferback to summary
public static boolean VRChaperoneSetup_ExportLiveToBuffer(ByteBuffer pBuffer, IntBuffer pnBufferLength)
Annotations
@NativeType:bool
VRChaperoneSetup_GetLiveCollisionBoundsInfoback to summary
public static boolean VRChaperoneSetup_GetLiveCollisionBoundsInfo(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.

Annotations
@NativeType:bool
VRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPoseback to summary
public static boolean VRChaperoneSetup_GetLiveSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pmatSeatedZeroPoseToRawTrackingPose)

Returns the preferred seated position.

Annotations
@NativeType:bool
VRChaperoneSetup_GetWorkingCollisionBoundsInfoback to summary
public static boolean VRChaperoneSetup_GetWorkingCollisionBoundsInfo(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.

Annotations
@NativeType:bool
VRChaperoneSetup_GetWorkingPlayAreaRectback to summary
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).

Annotations
@NativeType:bool
VRChaperoneSetup_GetWorkingPlayAreaSizeback to summary
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.

Annotations
@NativeType:bool
VRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPoseback to summary
public static boolean VRChaperoneSetup_GetWorkingSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pmatSeatedZeroPoseToRawTrackingPose)

Returns the preferred seated position from the working copy.

Annotations
@NativeType:bool
VRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPoseback to summary
public static boolean VRChaperoneSetup_GetWorkingStandingZeroPoseToRawTrackingPose(HmdMatrix34 pmatStandingZeroPoseToRawTrackingPose)

Returns the standing origin from the working copy.

Annotations
@NativeType:bool
VRChaperoneSetup_HideWorkingSetPreviewback to summary
public static void VRChaperoneSetup_HideWorkingSetPreview()

Hides the chaperone data in the working set to preview in the compositor (if it was visible).

VRChaperoneSetup_ImportFromBufferToWorkingback to summary
public static boolean VRChaperoneSetup_ImportFromBufferToWorking(ByteBuffer pBuffer, int nImportFlags)
Annotations
@NativeType:bool
VRChaperoneSetup_ReloadFromDiskback to summary
public static void VRChaperoneSetup_ReloadFromDisk(int configFile)

Tear everything down and reload it from the file on disk.

Parameters
configFile:int

one of:

VR#EChaperoneConfigFile_LiveVR#EChaperoneConfigFile_Temp
VRChaperoneSetup_RevertWorkingCopyback to summary
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.

VRChaperoneSetup_RoomSetupStartingback to summary
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.

VRChaperoneSetup_SetWorkingCollisionBoundsInfoback to summary
public static void VRChaperoneSetup_SetWorkingCollisionBoundsInfo(HmdQuad.Buffer pQuadsBuffer)

Sets the Collision Bounds in the working copy.

Note

ceiling height is ignored.

VRChaperoneSetup_SetWorkingPerimeterback to summary
public static void VRChaperoneSetup_SetWorkingPerimeter(HmdVector2.Buffer pPointBuffer)

Sets the Collision Bounds in the working copy

VRChaperoneSetup_SetWorkingPlayAreaSizeback to summary
public static void VRChaperoneSetup_SetWorkingPlayAreaSize(float sizeX, float sizeZ)

Sets the Play Area in the working copy.

VRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPoseback to summary
public static void VRChaperoneSetup_SetWorkingSeatedZeroPoseToRawTrackingPose(HmdMatrix34 pMatSeatedZeroPoseToRawTrackingPose)

Sets the preferred seated position in the working copy.

VRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPoseback to summary
public static void VRChaperoneSetup_SetWorkingStandingZeroPoseToRawTrackingPose(HmdMatrix34 pMatStandingZeroPoseToRawTrackingPose)

Sets the preferred standing position in the working copy.

VRChaperoneSetup_ShowWorkingSetPreviewback to summary
public static void VRChaperoneSetup_ShowWorkingSetPreview()

Shows the chaperone data in the working set to preview in the compositor.