Package gaiasky.vr.openvr

Class VRContext

java.lang.Object

gaiasky.vr.openvr.VRContext

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

public class VRContext
extends Object
implements com.badlogic.gdx.utils.Disposable

Responsible for initializing the VR system, managing rendering surfaces, getting tracking device poses, submitting the rendering results to the HMD and rendering the surfaces side by side to the companion window on the desktop. Wrapper around OpenVR.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VRContext.Space	Space in which matrices and vectors are returned in by VRContext.VRDevice methods taking a VRContext.Space.
static enum	VRContext.VRControllerRole	The role of a VRContext.VRDevice of type VRContext.VRDeviceType.Controller
class	VRContext.VRDevice	Represents a tracked VR device such as the head mounted display, wands etc.
static class	VRContext.VRDevicePose	Represents the pose of a VRContext.VRDevice, including its transform, velocity and angular velocity.
static enum	VRContext.VRDeviceProperty
static enum	VRContext.VRDeviceType	Type of a VRContext.VRDevice

Constructor Summary

Constructors

Constructor	Description
VRContext()	Creates a new VRContext, initializes the VR system, and sets up rendering surfaces with depth attachments.
VRContext(float renderTargetMultiplier, boolean hasStencil)	Creates a new VRContext, initializes the VR system, and sets up rendering surfaces.

Method Summary

Modifier and Type	Method	Description
void	addListener(VRDeviceListener listener)	Adds a VRDeviceListener to receive events
void	begin()	Start rendering.
void	dispose()
VRContext.VRDevice	getControllerByRole(VRContext.VRControllerRole role)
VRContext.VRDevice	getDeviceByType(VRContext.VRDeviceType type)
com.badlogic.gdx.utils.Array<VRContext.VRDevice>	getDevices()
com.badlogic.gdx.utils.Array<VRContext.VRDevice>	getDevicesByType(VRContext.VRDeviceType type)
int	getHeight()
com.badlogic.gdx.math.Vector3	getTrackerSpaceOriginToWorldSpaceTranslationOffset()	Returns the tracker space to world space translation offset.
com.badlogic.gdx.math.Matrix4	getTrackerSpaceToWorldspaceRotationOffset()	Returns the tracker space to world space rotation offset.
int	getWidth()
static void	hmdMat34ToMatrix4(org.lwjgl.openvr.HmdMatrix34 hmd, com.badlogic.gdx.math.Matrix4 mat)
static void	hmdMat4toMatrix4(org.lwjgl.openvr.HmdMatrix44 hdm, com.badlogic.gdx.math.Matrix4 mat)
void	pollEvents()	Get the latest tracking data and send events to VRDeviceListener instance registered with the context.
void	removeListener(VRDeviceListener listener)	Removes a VRDeviceListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VRContext

public VRContext()

Creates a new VRContext, initializes the VR system, and sets up rendering surfaces with depth attachments.

VRContext

public VRContext(float renderTargetMultiplier,
 boolean hasStencil)

Creates a new VRContext, initializes the VR system, and sets up rendering surfaces.

Parameters:

renderTargetMultiplier - multiplier to scale the render surface dimensions as a replacement for multisampling

hasStencil - whether the rendering surfaces should have a stencil buffer

Method Details

hmdMat4toMatrix4

public static void hmdMat4toMatrix4(org.lwjgl.openvr.HmdMatrix44 hdm,
 com.badlogic.gdx.math.Matrix4 mat)

hmdMat34ToMatrix4

public static void hmdMat34ToMatrix4(org.lwjgl.openvr.HmdMatrix34 hmd,
 com.badlogic.gdx.math.Matrix4 mat)

getWidth

public int getWidth()

getHeight

public int getHeight()

getTrackerSpaceOriginToWorldSpaceTranslationOffset

public com.badlogic.gdx.math.Vector3 getTrackerSpaceOriginToWorldSpaceTranslationOffset()

Returns the tracker space to world space translation offset. All positional vectors returned by VRContext.VRDevice methods taking a VRContext.Space.World are multiplied offset by this vector. This allows offsetting VRContext.VRDevice positions and orientations in world space.

getTrackerSpaceToWorldspaceRotationOffset

public com.badlogic.gdx.math.Matrix4 getTrackerSpaceToWorldspaceRotationOffset()

Returns the tracker space to world space rotation offset. All rotational vectors returned by VRContext.VRDevice methods taking a VRContext.Space.World are rotated by this offset. This allows offsetting VRContext.VRDevice orientations in world space. The matrix needs to only have rotational components.

addListener

public void addListener(VRDeviceListener listener)

Adds a VRDeviceListener to receive events

removeListener

public void removeListener(VRDeviceListener listener)

Removes a VRDeviceListener

getDeviceByType

public VRContext.VRDevice getDeviceByType(VRContext.VRDeviceType type)

Returns:

the first VRContext.VRDevice of the given VRContext.VRDeviceType or null.

getDevicesByType

public com.badlogic.gdx.utils.Array<VRContext.VRDevice> getDevicesByType(VRContext.VRDeviceType type)

Returns:

all VRContext.VRDevice instances of the given VRContext.VRDeviceType.

getDevices

public com.badlogic.gdx.utils.Array<VRContext.VRDevice> getDevices()

Returns:

all currently connected VRContext.VRDevice instances.

getControllerByRole

public VRContext.VRDevice getControllerByRole(VRContext.VRControllerRole role)

Returns:

the VRContext.VRDevice of ype VRContext.VRDeviceType.Controller that matches the role, or null.

begin

public void begin()

Start rendering. Call beginEye to set up rendering for each individual eye. End rendering by calling #end

pollEvents

public void pollEvents()

Get the latest tracking data and send events to VRDeviceListener instance registered with the context.

Must be called before begin!

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable