This section describes the different elements that are included in the Vicon Unity plugin, so you can better understand what they do and when to use them.

The plugin is organized into folders to separate the different components, as shown in the Unity Project window this image.

This section contains information on each of these folders and their components:

Materials

The Materials folder contains the basic materials used by the GameObjects in the sample scenes.

In your project, you don't need to change or edit any of these materials - these examples are primarily for demonstration purposes.

Plugins

ThePluginsfolder contains Vicon Datastream libraries and dependencies that the Vicon VR for Unity plugin uses to stream subjects and headsets to Unity software.

The scripts use these plugins to add streaming functionality to the plugin.

In your project, you don't need to change or edit any of these plugins.

Prefab

The Prefab folder contains pre-built GameObjects with scripts attached.

Use these prefabs to quickly set up your project.

HMDPrefab

This prefab is an empty GameObject with Camera and Pose Provider child objects.

Use the HMDPrefab to quickly set up head-mounted displays (HMDs) in your Unity project.

Use the Camera object to capture an area of the Unity scene to send to the HMD.

The Pose Provider contains the HMDScript component, which connects the Unity GameObject to the HMD object in Vicon. For more detailed information on how this works, see the description of the HMDScript.

In your project, you don't need to use this prefab. To use an HMD without this prefab, create your own HMD GameObject with both a Camera and an HMDScript component.

ViconDataStreamPrefab

This prefab is an empty GameObject that contains the Vicon Data Stream Client script component.

Use this prefab to quickly connect your Unity project to the Vicon Data Stream server as a client. For more detailed information on how this works, see the description of the Vicon Data Stream Client script.

Each of the provided sample Scenes has an instance of the ViconDataStreamPrefab already.

In your project, you don't need to use this prefab. To use the Vicon plugin without this prefab, create your own custom DataStream GameObject with a ViconDataStreamClient component and add it to every scene.

PropMeshes

The PropMeshes folder contains four example prop meshes to help you start adding props to your Unity project; a flashlight, a katana, a raygun, and a Vicon Pulsar.

These are all single-segment props, so work with the SubjectScript rather than the RBScript.

Use these to quickly see your motion capture props as virtual representations in your Unity project.

In your project, you can use these meshes or your own custom prop meshes.

Scenes

The Scenes folder contains two example scenes, pre-filled with GameObjects and prefabs.

Use the example scenes to quickly set up your Unity project to communicate with your Vicon software.

In your project, you can expand these scenes as needed, or use them as a reference to set up new or existing scenes to work with the plugin.

ViconSubjectScriptExample

This scene demonstrates how to use the Vicon plugin with a subject.

There is an instance of the ViconDataStreamPrefab in the scene to create the client connection.

There is a single character model in the scene, with the SubjectScript already attached.

Use this scene to quickly test the connection between your Vicon software and your Unity project:

1. Start capturing a subject's movement in Vicon.
2. Enter the Host Name and Port in the ViconDataStreamPrefab.
3. Enter the Subject Name in the SubjectScript on the character model.
4. Select play to see the animation information translated onto the Unity mesh.

For more thorough documentation on streaming data from a subject to Unity with any assets or project, see Stream data from a full body and retarget to a mesh in Unity.

ViconHMDScriptExample

This scene demonstrates how to use the Vicon VR plugin with a head-mounted display (HMD).

The scene includes a basic arrangement of models to explore.

The scene had an instance of the ViconDataStreamPrefab to create the client connection.

The scene also includes a HMDPrefab GameObject ready for use with a headset.

Use this scene to quickly test the connection between an HMD, Vicon software, and your Unity project:

1. Create an HMD object in Vicon and enter the capture volume.
2. Enter the Host Name and Port in the ViconDataStreamPrefab.
3. Enter the HMD Name in the HMDScript on the HMDPrefab.
4. Select play to look around the Unity scene with the HMD.

For more thorough documentation on streaming data between an HMD and Unity with any assets or project, see Use a head-mounted display.

Scripts

The Scripts folder contains scripts that set up communication between the plugin and your Vicon software.

In your project, add these scripts to your GameObjects to set them up to work with your Vicon software.

HMDScript

This script combines the head-mounted display (HMD) inertial movement unit (IMU) data with the Vicon positional data. This means that the XR plugin in Unity can access the position, rotation, and acceleration information of the headset and apply it to the HMD GameObject in the Scene.

When you add the HMDScript to a GameObject as a component, it has the following public fields:

Both the HMD Name and Client fields need to be correctly populated for the HMDScript to work as expected.

In your project, you can choose to add this component directly to your own custom HMD GameObject, rather than using the provided HMDPrefab. Your HMD GameObject must be set up with the same structure as the HMDPrefab, including a child object with a Camera attached, for this script to work.

RBScript

This script streams Vicon data onto a GameObject that is not rigged and does not contain any segment bones, such as a cube.

When you add the RBScript to a GameObject as a component, it has the following public fields:

Both the Object Name and Client fields need to be correctly populated for the RBScript to work as expected.

In your project, add this component to simple GameObjects to create a link with Vicon mocap data.

SubjectScript

This script streams Vicon data onto a rigged skeleton. This includes single-segment props, such as those included in the PropMeshes folder.

When you add the SubjectScript to a GameObject as a component, it has the following public fields:

Both theSubject Name and Client fields need to be correctly populated for the SubjectScript to work as expected.

In your project, add this component to GameObjects with rigged skeletons to create a link with Vicon mocap data.

ViconDataStreamClient

This script connects your Unity project to the Vicon Data Stream server as a client.

When you add the SubjectScript to a GameObject as a component, it has the following public fields:

Both the Host Name and Portfields need to be correctly populated for the ViconDataStreamClient to work as expected. The other fields are optional and don't need to be populated.

In your project, you can choose to add this component directly to your own custom version of a ViconDataStream GameObject, rather than using the provided ViconDataStreamPrefab.

ViconSkins

The ViconSkins folder contains example full-body meshes and skins to help you start setting up full-body motion capture in your Unity project.

Use these to quickly see your motion capture subjects as virtual representations in your Unity project.

The folder contains six meshes you can use, each suitable for a different marker set or subject type.

Two skins are in separate folders - ViconFemaleEvoke.fbm and ViconMaleEvoke.fbm. You can add these to any of the provided meshes to change their appearance.

In your project, you can use these meshes and skins or your own custom subject versions.