This topic describes how to install the Vicon SteamVR plugin for fusing Vicon positional data with SteamVR IMU rotational data in Unreal Engine 4.

Which versions are covered?
The following instructions cover the Unreal SteamVR plugin for Unreal Engine versions 4.25 and 4.26.



Install the SteamVR plugin

To install the Vicon SteamVR plugin, complete the following procedures:

Before you begin

Before you begin the installation, ensure you have the necessary components and installation.

  • 1 x PC with Vicon software
  • 1 x PC with Unreal Engine 4 installed
  • PCs connected via LAN
Supported headsets
These HMDs have been tested for use with the Vicon Unreal plugin:
  • Oculus Rift / Rift S
  • HP Reverb
  • HP Reverb G2
  • HTC Vive / Vive Pro*

* Due to the requirements of the HTC headsets, they must also be visible by an HTC Vive Base Station.

Install the Vicon LiveLink DataStream Plugin

The Vicon SteamVR plugin relies on the LiveLink plugin being installed.

Run the SteamVR plugin installer

  1. Before running the installer, ensure the engine version downloaded matches the desired engine version.



  2. Double-click the MSI file to run the installer.

  3. Accept the license agreement and click Next.
    The installer should automatically detect the installed version of the engine.
  4. If the installer did not detect the engine, click Browse.
  5. Navigate to the installed engine location (by default C:\Program Files\Epic Games\UE_4.x) and click OK.



  6. Click Next again and finally Install.

Set up the plugin in the editor

  1. Create and launch an existing project or open an existing one.
  2. Open the Plugins browser by navigating to Edit > Plugins.



  3. In the Plugins window go to the Virtual Reality section.

  4. Ensure the Vicon SteamVR plugin is enabled.



  5. Ensure all other Virtual Reality plugins are disabled (they can interfere with the Vicon plugin).

  6. If required, restart the editor.

Initialize Vicon Fusion

This topic describes how to set up VR fusion between Vicon positional data and HMD IMU rotational data.

Note
Currently this is only possible using Blueprints. In the future, other methods may become available.

Before you begin

Ensure you have the following prerequisites:

  • 1 x PC with Vicon software
  • 1 x PC with Unreal Engine 4 installed
  • PCs connected via LAN
  • SteamVR installed (WindowsMR plugin for SteamVR if required)
  • A supported VR HMD (SteamVR) with appropriate software installed
  • Vicon LiveLink Datastream Plugin is installed. See Install and set up the LiveLink plugin.
  • Vicon SteamVR Plugin is installed. See Install the SteamVR plugin.
  • UE4 Project open
  • Live Link source created using one of the methods described in Create a Vicon Live Link source.

Set up a headset using the Blueprint function

Create a new Blueprint

  1. In the content browser, right-click and under Create Basic Asset choose Blueprint Class.



  2. In the dialog box, choose Actor so that it can be spawned or placed in the level.

  3. Give the resulting blueprint a suitable name and open it up.
  4. In the new blueprint, in the toolbar along the top, navigate to the Event Graph.

Set up the blueprint function

  1. Right-click in an empty spot in the graph and search for "Initialize Vicon Headset".



  2. Select this function to spawn a node in the graph.
  3. Connect an event trigger to the input of the node.
    (In this example the event "EventBeginPlay" will be used. This will cause the Live Link connection to be created once play has been started.)
  4. Enter the name of the HMD prop/object from the Vicon software.



  5. Compile and save the blueprint.
  6. Drag the blueprint from the content browser directly in the level.