Top Description Constructors Methods
org.lwjgl.openvr

public Class VRChaperone

extends Object
Class Inheritance
Imports
java.nio.*, org.lwjgl.system.*
HIGH LEVEL TRACKING SPACE ASSUMPTIONS:

Constructor Summary

AccessConstructor and Description
protected
VRChaperone()

Method Summary

Modifier and TypeMethod and Description
public static void
nVRChaperone_GetBoundsColor(long pOutputColorArray, int nNumOutputColors, float flCollisionBoundsFadeDistance, long pOutputCameraColor)

Unsafe version of: GetBoundsColor

public static boolean
nVRChaperone_GetPlayAreaRect(long rect)

Unsafe version of: GetPlayAreaRect

public static boolean
nVRChaperone_GetPlayAreaSize(long pSizeX, long pSizeZ)

Unsafe version of: GetPlayAreaSize

public static native void
nVRChaperone_SetSceneColor(long color, long __functionAddress)

Unsafe version of: SetSceneColor

public static void
nVRChaperone_SetSceneColor(long color)

Unsafe version of: SetSceneColor

public static boolean
VRChaperone_AreBoundsVisible()

Determine whether the bounds are showing right now.

public static void
VRChaperone_ForceBoundsVisible(boolean bForce)

Force the bounds to show, mostly for utilities.

public static void
VRChaperone_GetBoundsColor(HmdColor.Buffer pOutputColorArray, float flCollisionBoundsFadeDistance, HmdColor pOutputCameraColor)

Get the current chaperone bounds draw color and brightness.

public static int
VRChaperone_GetCalibrationState()

Get the current state of Chaperone calibration.

public static boolean
VRChaperone_GetPlayAreaRect(HmdQuad rect)

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

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.

public static void
VRChaperone_ReloadInfo()

Reload Chaperone data from the .vrchap file on disk.

public static void
VRChaperone_ResetZeroPose(int
one of:
VR#ETrackingUniverseOrigin_TrackingUniverseSeated
VR#ETrackingUniverseOrigin_TrackingUniverseStanding
VR#ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
eTrackingUniverseOrigin)

Sets the zero pose for the given tracker coordinate system to the current position and yaw of the HMD.

public static void
VRChaperone_SetSceneColor(HmdColor color)

Optionally give the chaperone system a hit about the color and brightness in the scene.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

VRChaperoneback to summary
protected VRChaperone()

Method Detail

nVRChaperone_GetBoundsColorback to summary
public static void nVRChaperone_GetBoundsColor(long pOutputColorArray, int nNumOutputColors, float flCollisionBoundsFadeDistance, long pOutputCameraColor)

Unsafe version of: GetBoundsColor

nVRChaperone_GetPlayAreaRectback to summary
public static boolean nVRChaperone_GetPlayAreaRect(long rect)

Unsafe version of: GetPlayAreaRect

nVRChaperone_GetPlayAreaSizeback to summary
public static boolean nVRChaperone_GetPlayAreaSize(long pSizeX, long pSizeZ)

Unsafe version of: GetPlayAreaSize

nVRChaperone_SetSceneColorback to summary
public static native void nVRChaperone_SetSceneColor(long color, long __functionAddress)

Unsafe version of: SetSceneColor

nVRChaperone_SetSceneColorback to summary
public static void nVRChaperone_SetSceneColor(long color)

Unsafe version of: SetSceneColor

VRChaperone_AreBoundsVisibleback to summary
public static boolean VRChaperone_AreBoundsVisible()

Determine whether the bounds are showing right now.

Annotations
@NativeType:bool
VRChaperone_ForceBoundsVisibleback to summary
public static void VRChaperone_ForceBoundsVisible(boolean bForce)

Force the bounds to show, mostly for utilities.

VRChaperone_GetBoundsColorback to summary
public static void VRChaperone_GetBoundsColor(HmdColor.Buffer pOutputColorArray, float flCollisionBoundsFadeDistance, HmdColor pOutputCameraColor)

Get the current chaperone bounds draw color and brightness.

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

Annotations
@NativeType:ChaperoneCalibrationState
VRChaperone_GetPlayAreaRectback to summary
public static boolean VRChaperone_GetPlayAreaRect(HmdQuad rect)

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

Corners are in counter-clockwise order. Standing 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
VRChaperone_GetPlayAreaSizeback to summary
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.

Annotations
@NativeType:bool
VRChaperone_ReloadInfoback to summary
public static void VRChaperone_ReloadInfo()

Reload Chaperone data from the .vrchap file on disk.

VRChaperone_ResetZeroPoseback to summary
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:int

one of:

VR#ETrackingUniverseOrigin_TrackingUniverseSeated
VR#ETrackingUniverseOrigin_TrackingUniverseStanding
VR#ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
VRChaperone_SetSceneColorback to summary
public static void VRChaperone_SetSceneColor(HmdColor color)

Optionally give the chaperone system a hit about the color and brightness in the scene.