vr::IVRChaperoneSetup Class Reference

#include <openvr_mingw.h>

Public Member Functions
bool	CommitWorkingCopy (EChaperoneConfigFile configFile)
void	RevertWorkingCopy ()
bool	GetWorkingPlayAreaSize (float *pSizeX, float *pSizeZ)
bool	GetWorkingPlayAreaRect (HmdQuad_t *rect)
bool	GetWorkingCollisionBoundsInfo (VR_OUT_ARRAY_COUNT(punQuadsCount) HmdQuad_t *pQuadsBuffer, uint32_t *punQuadsCount)
bool	GetLiveCollisionBoundsInfo (VR_OUT_ARRAY_COUNT(punQuadsCount) HmdQuad_t *pQuadsBuffer, uint32_t *punQuadsCount)
bool	GetWorkingSeatedZeroPoseToRawTrackingPose (HmdMatrix34_t *pmatSeatedZeroPoseToRawTrackingPose)
bool	GetWorkingStandingZeroPoseToRawTrackingPose (HmdMatrix34_t *pmatStandingZeroPoseToRawTrackingPose)
void	SetWorkingPlayAreaSize (float sizeX, float sizeZ)
void	SetWorkingCollisionBoundsInfo (VR_ARRAY_COUNT(unQuadsCount) HmdQuad_t *pQuadsBuffer, uint32_t unQuadsCount)
void	SetWorkingSeatedZeroPoseToRawTrackingPose (const HmdMatrix34_t *pMatSeatedZeroPoseToRawTrackingPose)
void	SetWorkingStandingZeroPoseToRawTrackingPose (const HmdMatrix34_t *pMatStandingZeroPoseToRawTrackingPose)
void	ReloadFromDisk (EChaperoneConfigFile configFile)
bool	GetLiveSeatedZeroPoseToRawTrackingPose (HmdMatrix34_t *pmatSeatedZeroPoseToRawTrackingPose)
void	SetWorkingCollisionBoundsTagsInfo (VR_ARRAY_COUNT(unTagCount) uint8_t *pTagsBuffer, uint32_t unTagCount)
bool	GetLiveCollisionBoundsTagsInfo (VR_OUT_ARRAY_COUNT(punTagCount) uint8_t *pTagsBuffer, uint32_t *punTagCount)
bool	SetWorkingPhysicalBoundsInfo (VR_ARRAY_COUNT(unQuadsCount) HmdQuad_t *pQuadsBuffer, uint32_t unQuadsCount)
bool	GetLivePhysicalBoundsInfo (VR_OUT_ARRAY_COUNT(punQuadsCount) HmdQuad_t *pQuadsBuffer, uint32_t *punQuadsCount)
bool	ExportLiveToBuffer (VR_OUT_STRING() char *pBuffer, uint32_t *pnBufferLength)
bool	ImportFromBufferToWorking (const char *pBuffer, uint32_t nImportFlags)

Member Function Documentation

CommitWorkingCopy()

bool vr::IVRChaperoneSetup::CommitWorkingCopy ( EChaperoneConfigFile configFile )

inline

Saves the current working copy to disk

ExportLiveToBuffer()

bool vr::IVRChaperoneSetup::ExportLiveToBuffer ( VR_OUT_STRING() char * pBuffer, uint32_t * pnBufferLength )

inline

GetLiveCollisionBoundsInfo()

bool vr::IVRChaperoneSetup::GetLiveCollisionBoundsInfo ( VR_OUT_ARRAY_COUNT(punQuadsCount) HmdQuad_t * pQuadsBuffer, uint32_t * punQuadsCount )

inline

Returns the number of Quads if the buffer points to null. Otherwise it returns Quads into the buffer up to the max specified.

GetLiveCollisionBoundsTagsInfo()

bool vr::IVRChaperoneSetup::GetLiveCollisionBoundsTagsInfo ( VR_OUT_ARRAY_COUNT(punTagCount) uint8_t * pTagsBuffer, uint32_t * punTagCount )

inline

GetLivePhysicalBoundsInfo()

bool vr::IVRChaperoneSetup::GetLivePhysicalBoundsInfo ( VR_OUT_ARRAY_COUNT(punQuadsCount) HmdQuad_t * pQuadsBuffer, uint32_t * punQuadsCount )

inline

GetLiveSeatedZeroPoseToRawTrackingPose()

bool vr::IVRChaperoneSetup::GetLiveSeatedZeroPoseToRawTrackingPose ( HmdMatrix34_t * pmatSeatedZeroPoseToRawTrackingPose )

inline

Returns the preferred seated position.

GetWorkingCollisionBoundsInfo()

bool vr::IVRChaperoneSetup::GetWorkingCollisionBoundsInfo ( VR_OUT_ARRAY_COUNT(punQuadsCount) HmdQuad_t * pQuadsBuffer, uint32_t * punQuadsCount )

inline

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.

GetWorkingPlayAreaRect()

bool vr::IVRChaperoneSetup::GetWorkingPlayAreaRect ( HmdQuad_t * rect )

inline

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

GetWorkingPlayAreaSize()

bool vr::IVRChaperoneSetup::GetWorkingPlayAreaSize ( float * pSizeX, float * pSizeZ )

inline

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.

GetWorkingSeatedZeroPoseToRawTrackingPose()

bool vr::IVRChaperoneSetup::GetWorkingSeatedZeroPoseToRawTrackingPose ( HmdMatrix34_t * pmatSeatedZeroPoseToRawTrackingPose )

inline

Returns the preferred seated position from the working copy.

GetWorkingStandingZeroPoseToRawTrackingPose()

bool vr::IVRChaperoneSetup::GetWorkingStandingZeroPoseToRawTrackingPose ( HmdMatrix34_t * pmatStandingZeroPoseToRawTrackingPose )

inline

Returns the standing origin from the working copy.

ImportFromBufferToWorking()

bool vr::IVRChaperoneSetup::ImportFromBufferToWorking ( const char * pBuffer, uint32_t nImportFlags )

inline

ReloadFromDisk()

void vr::IVRChaperoneSetup::ReloadFromDisk ( EChaperoneConfigFile configFile )

inline

Tear everything down and reload it from the file on disk

RevertWorkingCopy()

void vr::IVRChaperoneSetup::RevertWorkingCopy ( )

inline

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.

SetWorkingCollisionBoundsInfo()

void vr::IVRChaperoneSetup::SetWorkingCollisionBoundsInfo ( VR_ARRAY_COUNT(unQuadsCount) HmdQuad_t * pQuadsBuffer, uint32_t unQuadsCount )

inline

Sets the Collision Bounds in the working copy.

SetWorkingCollisionBoundsTagsInfo()

void vr::IVRChaperoneSetup::SetWorkingCollisionBoundsTagsInfo ( VR_ARRAY_COUNT(unTagCount) uint8_t * pTagsBuffer, uint32_t unTagCount )

inline

SetWorkingPhysicalBoundsInfo()

bool vr::IVRChaperoneSetup::SetWorkingPhysicalBoundsInfo ( VR_ARRAY_COUNT(unQuadsCount) HmdQuad_t * pQuadsBuffer, uint32_t unQuadsCount )

inline

SetWorkingPlayAreaSize()

void vr::IVRChaperoneSetup::SetWorkingPlayAreaSize ( float sizeX, float sizeZ )

inline

Sets the Play Area in the working copy.

SetWorkingSeatedZeroPoseToRawTrackingPose()

void vr::IVRChaperoneSetup::SetWorkingSeatedZeroPoseToRawTrackingPose ( const HmdMatrix34_t * pMatSeatedZeroPoseToRawTrackingPose )

inline

Sets the preferred seated position in the working copy.

SetWorkingStandingZeroPoseToRawTrackingPose()

void vr::IVRChaperoneSetup::SetWorkingStandingZeroPoseToRawTrackingPose ( const HmdMatrix34_t * pMatStandingZeroPoseToRawTrackingPose )

inline

Sets the preferred standing position in the working copy.

---

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

• openvr/openvr_mingw.h