Open topic with navigation

Vizard 7 » Reference » Stereo & Displays » Display devices » Oculus HMDs

7.6

Oculus HMDs

The oculus module adds support for the Oculus Rift HMD. The following sample code will setup the main window to render to the Oculus Rift HMD and link the HMD sensor to the main viewpoint.

A full sample script can be found at \examples\devices\oculusExample.py

Getting Started

In order to use the Oculus Rift HMD with Vizard you must first complete the following steps:

1. Download and install the Oculus Rift setup tool for version 1.38 or above. Note, the Rift requires Windows 7 or above.

2. Open the Oculus application and ensure all devices are connected and that your machine meets the minimum requirements. You can use the Oculus application to download and run demo content to ensure the Rift functions properly.

3. Open the Settings > General page within the Oculus application and enable the Unknown Sources option to allow Vizard scripts to run on the Rift HMD.

Oculus 0.8 Runtime

You can use the older 0.8 Oculus runtime with Vizard if you have a DK2 or DK1 and are unable to update to the latest runtime. Simply use the following code when importing the oculus module:

Troubleshooting

The image in the HMD stutters very badly

This can happen when the frame rate drops below the refresh rate of the HMD. Here are some techniques to resolve this issue:

• Reduce the rendering complexity of the scene (i.e. lower poly count, texture sizes, ...)

• On Windows 7 we also recommend that you disable DWM.

• Use the <hmd>.setTextureScale command (see below) to reduce the resolution of the rendered image in the HMD.

Screen/Ortho objects do not appear in the HMD

The Oculus SDK is provided the rendered image of the world and automatically performs the distortion correction before displaying the image in the HMD. All other rendering performed after the world (i.e. screen objects and sub windows) will not appear in the HMD. You can use GUI canvas nodes to display UI to the user with proper distortion correction applied. See the Oculus example script for sample code.

Rift HMD

The oculus.Rift class provides an interface for setting up the Oculus Rift HMD within Vizard and applying it to window for rendering. The oculus.Rift class constructor accepts the following optional keyword arguments:

The oculus.Rift object contains the following methods:

Rift Sensor

The Oculus sensor object provides the position and orientation data associated with the internal HMD sensor. The sensor has the following methods in addition to the standard extension sensor methods:

Touch Controller

The touch controller sensor provides position, orientation, and button data for the Rift Touch controllers. The sensor supports the following buttons:

Touch Controller objects support the standard extension sensor interface for providing position and button values. They also provide the following methods to access additional data:

Remote Controller

The remote controller sensor provides button data for the Rift Remote. The sensor supports the following buttons:

The remote sensor also provides the following methods:

Xbox Controller

The Xbox controller sensor provides button data for the Rift Xbox controller. The sensor supports the following buttons:

The Xbox sensor also provides the following methods:

Camera Sensor

The camera sensor provides position and orientation data for the HMD tracking camera. The sensor also provides the following methods:

Oculus Platform applications

To register your script as an Oculus Platform application and perform the required entitlement check, just add the following code to your script:

You can use the following code to handle the result of the entitlement check:

See also

In this section:

Elumens Dome

nVis HMDs

ACT Kern

Sensics

Fakespace Labs Wide5

iZ3D

Tridelity

Crescent

Sony HMDs

SteamVR HMDs

Viulux HMDs

Other sections:

Frame parallel

Frame sequential

Line interlaced

Anaglyphic (red/cyan glasses)