Module vrOpenVR

Classes
vrOpenVRController Deprecated; use vrDeviceService, vrdVRDevice and vrdDeviceInteraction instead.
vrOpenVRFrameTimings The vrOpenVRFrameTimings class stores timing information from the OpenVR library that can be queried by calling getOpenVRFrameTimings().

Functions

vrOpenVRFrameTimings

getOpenVRFrameTimings()
Windows only: Retrieves the frame timings.

Pnt3f

getOpenVRTrackingOrigin()
Returns the OpenVR tracking reference origin.

int

getOpenVRTrackingOriginType()
Windows only: Retrieves the tracking origin type for OpenVR.

resetOpenVRHMDPose()
Resets the Seated Zero Pose for Seated tracking mode while OpenVR is running.

setOpenVRControllerTracking(s)
Windows only: Enables/Disables tracking of openvr controller.

setOpenVRHMDForceInterleavedReprojection(s)
Windows only: Enables/Disables forcing of interleaved reprojection.

setOpenVRHMDMirrorTextureView(eyeMode)
Windows only: Sets the view to show in the VRED UI while using an OpenVR HMD.

setOpenVRHMDTracking(s)
Windows only: Enables/Disables tracking of openvr hmd.

setOpenVRHMDUseHiddenAreaMesh(s)
Windows only: Enables/Disables the use of a hidden area mesh to mask out invisible areas in order to reduce shading costs.

setOpenVRTracking(s)
Windows only: Enables/Disables tracking of openvr hmd and controller.

setOpenVRTrackingOrigin(position)
Sets the tracking reference origin for OpenVR tracking.

setOpenVRTrackingOriginType(originType)
Windows only: Sets the tracking origin type for OpenVR.

Variables
	Finger_Index = `1`
	Finger_Middle = `2`
	Finger_Pinky = `4`
	Finger_Ring = `3`
	Finger_Thumb = `0`
	Hand_Left = `1`
	Hand_Right = `2`
	Hand_Undefined = `0`
	OVRButton_A = `7`
	OVRButton_ApplicationMenu = `1`
	OVRButton_Axis0 = `32`
	OVRButton_Axis1 = `33`
	OVRButton_Axis2 = `34`
	OVRButton_Axis3 = `35`
	OVRButton_Axis4 = `36`
	OVRButton_DPad_Down = `6`
	OVRButton_DPad_Left = `3`
	OVRButton_DPad_Right = `5`
	OVRButton_DPad_Up = `4`
	OVRButton_Grip = `2`
	OVRButton_ProximitySensor = `31`
	OVRButton_System = `0`
	Pose_Fist = `1004`
	Pose_Picking = `1001`
	Pose_Pointing = `1002`
	Pose_ThumbsUp = `1003`
	Visualization_Controller = `0`
	Visualization_ControllerAndHand = `2`
	Visualization_Hand = `1`

Function Details

getOpenVRFrameTimings()

Windows only: Retrieves the frame timings.

Returns: vrOpenVRFrameTimings: see vrOpenVRFrameTimings documentation for more details.

getOpenVRTrackingOrigin()

Returns the OpenVR tracking reference origin. Default is (0, 0, 0). Can be changed with setOpenVRTrackingOrigin.

Returns: Pnt3f: the OpenVR tracking reference origin .

getOpenVRTrackingOriginType()

Windows only: Retrieves the tracking origin type for OpenVR.

Returns: int: 0 = Seated, 1 = Standing (Room Scale).

resetOpenVRHMDPose()

Resets the Seated Zero Pose for Seated tracking mode while OpenVR is running.

Execute this command while wearing the HMD and sitting in a comfortable position.

setOpenVRControllerTracking(s)

Windows only: Enables/Disables tracking of openvr controller.

Parameters:

s (bool) - On/Off.

setOpenVRHMDForceInterleavedReprojection(s)

Windows only: Enables/Disables forcing of interleaved reprojection. If enabled, the scene will be rendered with half the frame rate and every other frame will be interpolated.

Parameters:

s (bool) - On/Off.

setOpenVRHMDMirrorTextureView(eyeMode)

Windows only: Sets the view to show in the VRED UI while using an OpenVR HMD.

Parameters:

eyeMode (int) - Left Eye = 0, Right Eye = 1, Both Eyes = 2. The default is 0.

setOpenVRHMDTracking(s)

Windows only: Enables/Disables tracking of openvr hmd.

Parameters:

s (bool) - On/Off.

setOpenVRHMDUseHiddenAreaMesh(s)

Windows only: Enables/Disables the use of a hidden area mesh to mask out invisible areas in order to reduce shading costs.

Parameters:

s (bool) - On/Off.

setOpenVRTracking(s)

Windows only: Enables/Disables tracking of openvr hmd and controller.

Parameters:

s (bool) - On/Off.

setOpenVRTrackingOrigin(position)

Sets the tracking reference origin for OpenVR tracking. Use it to correct any offsets in the scene. This function always assumes Y-Up, even if Z-up is set in the scene.

If the tracking origin should be at pos = (x_scene, y_scene, z_scene) in the VRED scene, call setOpenVRTrackingOrigin(Pnt3f(-x_scene, -z_scene, y_scene)).

Parameters:

position (Pnt3f) - Position offset for the OpenVR tracking.

setOpenVRTrackingOriginType(originType)

Windows only: Sets the tracking origin type for OpenVR.

Parameters:

originType (int) - 0 = Seated, 1 = Standing.