Pre-Requisites

You must be familiar with Vortex Mechanisms, Vortex Graphics Galleries, and the Unity Editor.

Introduction

You can simulate Vortex mechanisms just like any other assets in a Unity scene with the Vortex Studio Package for Unity; the Unity Editor lets you connect to parameters that you expose in Vortex Studio.

Any Vortex Studio simulation parameter can be sent to a function in a Unity script (get/set), and included in your Unity scene.

Vortex Studio automatically detects terrain GameObjects that you create in Unity around a Vortex vehicle. A corresponding height field is created and streamed in Vortex Studio at run time. To monitor contacts and collisions during simulation, you can show the height field at the same time, using the Vortex Studio Remote Debugger application.

During simulation, Vortex Studio sends information about the position and orientation of each body to the Unity Engine. Parameters and outputs can be accessed via the mechanism's interface. To ensure smooth game play with accurate synchronization and realistic movements, Vortex Studio sends information about the position and orientation of each body to the Unity Engine. Parameters and outputs that you expose using a VHL interface let you control the Mechanism in Unity.

Vortex Studio manages external devices, such as motion platform and CANopen-compliant devices for controlling vehicles and enriching the simulation.

Installing the Vortex Studio Package

Installing the Vortex Studio Package involves downloading the package and copying the file to a folder with a path relative to your Unity project.
See the prerequisites section of Creating Your First Project for more details.

Running a Sample Project

The sample consists of the Vortex Sports Car mechanism that interacts with a Unity terrain with trees, static colliders and other simple Vortex mechanisms.

Before opening the project, make sure Vortex Studio 2020b is installed.

1. Copy the Vortex Studio Package (com.cmlabs.vortex.integration-1.0.0.tgz) into the 2020b directory of the extracted Sample Project archive, alongside the Sample directory.
   
   
   
2. Open the Unity Hub and click ADD on the Projects tab.
   
   
   
3. Select the Unity project directory 2020b/Sample and then open it by clicking on the project.
   
   
   If you don't select the Sample directory, you will get an Invalid project path error.
   
   
   
4. Hit the Play button and select the SportsCar gameobject to see the current Speed, RPM and Gear.
   
   
   
5. Be careful, you can hit the orange cones, but not the StaticCylinder in the middle.
   The car can now be driven using a gamepad.
   
   
   
6. Have a look at the SportsCar.cs and Cone.cs scripts to see how the mechanisms are integrated into Unity.

Organizing Vortex Studio Assets

This section assumes that you already have a good understanding of Vortex Studio Editor Documents.

The Vortex Studio package lets you import Vortex mechanisms to a Unity project.

To create a valid Unity project using Vortex Studio, you must copy the Vortex assets you want to use in your new Unity project under the Assets/StreamingAssets directory for the project. If the StreamingAssets directory does not exist, create it, since it will be needed when building your Unity game in order to keep all Vortex asset files intact. Vortex assets include files with the following formats:

• *.vxmechanism (Mechanism Document)
• *.vxassembly (Assembly Document)
• *.vxgraphicgallery (Graphics Gallery Document)
• *.vxc (Setup Document)
• *.vxmaterials (Material Table)

Example

In this example, you have the following folder hierarchy for the Vortex Sports Car mechanism:

• Sports Car
  
  • Dynamic
    • Sports Car.vxmechanism
    • Sports Car_Assembly.vxassembly
    • Sports Car.vxgraphicgallery

To build a valid Unity project, you must move the same folder structure to a sub-folder of the  Assets/StreamingAssets folder of your Unity project. The structure of your Unity project would appear as follows:

• MyProject
  • Assets
    • StreamingAssets 
      • Vortex_Mechanisms
        
        • Sports Car
          • Dynamic
            • Sports Car.vxmechanism
            • Sports Car_Assembly.vxassembly
            • Sports Car.vxgraphicgallery
  • Packages
    • manifest.json
  • ProjectSettings
    • ...
    • ...

Creating Your First Project

Bringing your first Vortex Studio project into Unity involves verifying that the package is installed/enabled and verifying settings for the project with the package.  

Prerequisites

To use the Vortex Integration in Unity package, you must have Vortex Studio 2020b and Unity 2019.3.

The Vortex Integration tarball package is currently only available on demand.

IMPORTANT: You must have a valid Unity user account and license to download the Unity Engine and use it.

To Create a New Unity Project Using the Vortex Studio Package

1. Open the Unity Hub.

   

   
   

2. Click on the the "NEW" button to create a new project.
   

   

3. Select the "3D" template and select your project's name and location. Then press on the "CREATE" button to create the project.
   

   

4. Here is what you should see once the Unity Editor is opened:
   

   

5. To use the Vortex Studio package for Unity, you have 2 options:
   1. Use the Unity Package Manager to import the Vortex Studio package to your Unity project. This will create a reference with an absolute path (not recommended if multiple users will work on the same Unity project from different computers).
      1. Get a copy of the Vortex Studio package for Unity on your local computer.
      2. Open the Unity Package Manager:
         

         

      3. Select the "Add package from tarball..." option:
         

         

      4. Select the ".tgz" file of the desired Vortex Studio package for Unity. The Unity Package Manager should now show your new package:
         

         

   2. Manually add a dependency to the Vortex Studio package as a relative path (this is the recommended approach).
      1. Get a copy of the Vortex Studio package for Unity on your local computer and put it alongside your Unity project (not under the Unity Project's root folder). Please note that it can be anywhere, as long as you can refer to it with a relative path (same drive for instance).
      2. Make sure your Unity Project is closed.
      3. In a Windows explorer window, navigate to your Unity Project's location and open the "manifest.json" file under the "Packages" directory.
         

         

      4. Here is the default content of this file:
         

         
         
         

      5. Add the following line to this file (as the first element) and save the file:

         "com.cmlabs.vortex.integration": "file:../../../com.cmlabs.vortex.integration-1.0.0.tgz",

         
         
         

         Please note that the path is relative to the "manifest.json" file.

      6. Re-open your Unity project:
         

         

      7. Validate that the Vortex Studio package is properly used by your project by opening the Unity Package Manager:
         
         
         

VortexApplication Component and VxApplication

VortexApplication Component

The VortexApplication Component is automatically added when entering Play mode.
A new GameObject named Vortex with the VortexApplication Component is added to the current scene on Runtime initialization.
The VortexApplication Component is flagged as DontDestroyOnLoad so it will be kept alive on scene transitions.

VxApplication

The VxApplication is only created once when the VortexApplication Component is instantiated.
The VxApplication is destroyed when the application (Game or Unity Editor) exits.

Verifying the Vortex Studio Version

You can verify that the correct version of Vortex is being used by switching to Play mode in the Unity editor and looking at the Console output.

About Vortex Studio Project Settings

You can customize several settings for your project in the Unity Editor from the Vortex Settings window available from the Edit menu.

Specifically, you can customize the following settings for your project:

Managing the Frame Rate Between Vortex Studio and Unity 

By default, new Unity projects use a fixed frame rate of 50 Hz. The Vortex Studio integration in Unity uses a fixed frame rate of 60 Hz. If you do not change the default settings, the simulation will run at unrealistic speeds.

IMPORTANT: To maintain fidelity and realism in the simulation, you must configure project settings so that Unity and Vortex Studio both use a fixed frame rate.

Example: Setting the Frame Rate in Vortex Studio and the Unity Editor

In this example, you want a simulation to run at 55 Hz.

To set the Frame Rate in the Unity Editor, do the following:

1. In the Unity Editor, open your project.
2. Click Edit and then click Project Settings...

   

3. In the Project Settings window, click Time.

   

4. The Fixed Timestep value is the interval that dictates when physics calculations and FixedUpdate() events are performed.
   A value of 0.02 second is 50 Hz (1/0.02 = 50) 
   The value for a 55 Hz frame rate would be (1/55 = 0.01818182)
   

   

5. It is recommended to tower the value of Maximum Allowed Timestep to 2 frames.
   
6. Close the Project Settings window and restart the project.

To set the Frame Rate in the Vortex Studio Editor, do the following:

Prerequisite: You must have a custom Application Setup Document (not the default one provided with Vortex Studio). For more information, see Vortex Studio Plugin Project Settings. Make sure the custom application setup document is saved in the Assets/StreamingAssets directory of your Unity project.

1. In the Vortex Settings window, select your custom setup as your Vortex Setup Document
   

2. Open your Setup Document in the Vortex Studio Editor.
   

   Known Issue

   The Edit Setup Document shortcut does not work if there are spaces in the path of your Setup Document. This is the case for the default Setup Document.
   Workaround: Use the Launch Vortex Editor shortcut and manually open the Setup Document.

3. In the Explorer panel, click Setup.

   

4. On the right of screen, in the Properties panel, set the Simulation Frame Rate value to 55.00.

   
   

5. To save your changes, click the Save button.

   

6. When you restart the Unity Editor, validate that the settings have been correctly configured.

Using a Vortex Mechanism in Unity

Making the Link Between Your Vortex Mechanism and a Unity Game Object

• See the section Organizing Vortex Studio Assets to place your Vortex content to make it visible to your Unity project.
• In the Inspector of the game object that represents the mechanism in Unity, click on Add Component.
• Select Script → Vortex → Vortex Mechanism.
• Drag your Vortex mechanism file from the Project view to the Mechanism File attribute of the Vortex Mechanism component.
  
• To access the functions of the Vortex Mechanism component, use or create another C# script on the same game object.
  

• You can easily find another component of the same game object with the GetComponent<> function.

  var mechanismComponent = GetComponent<Vortex.VortexMechanism>();

• Once you have access to the VortexMechanism component of your game object, you can access the methods that are part of its public interface.
  See the section The Vortex Mechanism Interface for a list of the available methods on the object.

The Vortex Mechanism Interface

Getting the Handle of the Mechanism

In some rare cases, you might need to give Vortex a reference to one of its own mechanisms from Unity. To get a handle which is meaningful to Vortex, use the following method.
Currently, the only use is with the SetInputExtensionPointer method.

public ulong GetMechanismHandle();

Setting/Getting the Value of Fields

The VortexMechanism component exposes many methods to allow you to read and write fields in your Vortex mechanism.
For more information, refer to the section Get/Set Vortex Studio Mechanism Inputs and Outputs (IO).

Other Useful Objects

PositionRotation

The following class is used as the return value of functions like GetOutputMatrix and can easily be applied to the transform of any game object by calling its ApplyOnTransform method.

public class PositionRotation
{
    public Vector3 position;
    public Quaternion rotation;

    public void ApplyOnTransform(Transform t);
}

For example:

using UnityEngine;
using Vortex;

public class MyMechanism : MonoBehaviour
{
	private VortexMechanism mechanismComponent;

	void Start()
	{
		mechanismComponent = GetComponent<VortexMechanism>();
	}

	void FixedUpdate()
	{
		var wt = mechanismComponent.GetOutputMatrix("MyVHL", "World Transform");
		wt.ApplyOnTransform(transform);
	}
}

Get/Set Vortex Studio Mechanism Inputs and Outputs (IO)

The purpose of using VortexMechanism components in your Unity project is not simply to load and unload Vortex mechanisms. It also allows you to get/set Vortex mechanism inputs and outputs (IO) from the Unity game.

Available IO for mechanisms are defined by the following mechanism interfaces:

• VHL Interfaces
• Control Interfaces

Outputs from these interfaces can be read from Vortex into the Unity game, while inputs can be set with new values from Unity into Vortex. For this purpose, a set of methods are exposed by the VortexMechanism component.

The following functions are available to you:

In each case, call the method with the name of the interface extension in Vortex and the name of the field in the interface.

For example, in a VHL interface with this name and field in Vortex:

You would write the following code in your C# script:

mechanismComponent.SetInputInt("Engine Interface", "rpm", 4000);

Visualizing the Vortex Simulation for Debugging Purposes Using the Vortex Remote Debugger

It can be useful to use the Vortex Studio Remote Debugger tool to visualize your simulation. The tool lets you inspect collision geometries, contacts, part origins and more, to identify the source of problems.

Supported Colliding Objects in Unity

Unity supports multiple colliding objects in your simulations, including terrain and static meshes.

Terrain

The Terrain is the primary tool to create a terrain in the Unity. This object uses a height map to define elevations of the terrain.

It offers tools to set the elevation and add vegetation.

The following image shows an example of a terrain:

You can inspect any generated height fields in the Vortex world using the Vortex Remote Debugger. The following image shows an example of generated height fields in the Vortex Remote Debugger:

Meshes That Do Not Simulate Physics

With the plugin, the application can generate collisions between a Vortex Mechanism and any Unity mesh that does not simulate physics (static). For example, the system can generate collisions with the following:

• Static mesh colliders
• Static primitive colliders
• Terrain
• Terrain trees

Example of Terrain with trees that Do Not Simulate Physics

The following image shows a tree prefab with a capsule collider.
This tree is placed on the terrain with the terrain paint tool.

You can visualize the resulting geometry in the Vortex Remote Debugger (only static colliders that have proximity with a mechanism are streamed at runtime to Vortex to create corresponding collision geometries):

Mapping Contact Materials

Not fully supported yet.
Every static object in Unity will have the default material in Vortex.
Unity Terrain gameobject will have the Ground material in Vortex if the PhysicalMaterial of the collider is set to None.

Build and run the Unity-Vortex application

Build the Unity-Vortex application

1. In the Unity Editor, open your scene and go to the Build Settings.
   
   
2. Add your scene to the build with the Add Open Scenes button.
   
   
   
3. Make sure the Architecture is set to x86_64.
   

4. Click the Build button and select the build destination directory.

   Note

   The Run part of the Build And Run will not work, since the built Unity-Vortex application needs to be launched from the Vortex Director.

Run from the Vortex Studio Director

1. Open the Vortex Studio Director and add a simulator to the list.
   
2. Name your simulator file and click OK
   
   
   
3. Select your Setup file
   
   
   
4. Add a simulator node
   
   
   
5. Select the Node and the Executable (browse to your Unity-Vortex application)
   
6. You can now Save and Launch your simulator.

Limitations

Supported Platform

The Vortex Studio Package for Unity only supports the "Windows (64-bit)" platform.

Simulation time

Vortex and Unity run in the same process; multiple process integration is not yet supported.
When running a fixed frame rate of 60 Hz, the 16 ms time budget is shared between Unity and Vortex.
If the Unity environment is complex and takes 10 ms to render, only 6 ms remain to be used by the Vortex simulation.