vr::IVRChaperone Class Reference

#include <openvr_mingw.h>

Public Member Functions
ChaperoneCalibrationState	GetCalibrationState ()
bool	GetPlayAreaSize (float *pSizeX, float *pSizeZ)
bool	GetPlayAreaRect (HmdQuad_t *rect)
void	ReloadInfo (void)
void	SetSceneColor (HmdColor_t color)
void	GetBoundsColor (HmdColor_t *pOutputColorArray, int nNumOutputColors, float flCollisionBoundsFadeDistance, HmdColor_t *pOutputCameraColor)
bool	AreBoundsVisible ()
void	ForceBoundsVisible (bool bForce)

Member Function Documentation

AreBoundsVisible()

bool vr::IVRChaperone::AreBoundsVisible ( )

inline

Determine whether the bounds are showing right now

ForceBoundsVisible()

void vr::IVRChaperone::ForceBoundsVisible ( bool bForce )

inline

Force the bounds to show, mostly for utilities

GetBoundsColor()

void vr::IVRChaperone::GetBoundsColor ( HmdColor_t * pOutputColorArray, int nNumOutputColors, float flCollisionBoundsFadeDistance, HmdColor_t * pOutputCameraColor )

inline

Get the current chaperone bounds draw color and brightness

GetCalibrationState()

ChaperoneCalibrationState vr::IVRChaperone::GetCalibrationState ( )

inline

Get the current state of Chaperone calibration. This state can change at any time during a session due to physical base station changes.

GetPlayAreaRect()

bool vr::IVRChaperone::GetPlayAreaRect ( HmdQuad_t * rect )

inline

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).

GetPlayAreaSize()

bool vr::IVRChaperone::GetPlayAreaSize ( float * pSizeX, float * pSizeZ )

inline

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.

ReloadInfo()

void vr::IVRChaperone::ReloadInfo ( void )

inline

Reload Chaperone data from the .vrchap file on disk.

SetSceneColor()

void vr::IVRChaperone::SetSceneColor ( HmdColor_t color )

inline

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

---

The documentation for this class was generated from the following file:

• openvr/openvr_mingw.h