Integrating Vortex Studio with Unreal Engine
This information is intended for users of Vortex Studio and Unreal Engine who want to integrate Vortex Studio simulation capabilities with Unreal, within a single process. This integration SDK is useful for single process simulation, VR, and using advanced blueprints logic in Unreal.
- 1 Getting started...
- 2 Tell me about...
- 3 Installing the Vortex Studio Plugin
- 4 Running a Sample Project
- 5 Organizing Vortex Studio Assets
- 5.1 Example
- 6 Creating Your First Project
- 7 Managing the Frame Rate Between Vortex Studio and the Unreal Editor
- 8 Importing Mechanisms into Unreal
- 9 Enabling Vortex Simulation
- 10 Get/Set Vortex Studio Mechanism Inputs and Outputs (IO)
- 11 Earthworks Systems
- 11.1 Soilbin
- 11.2 Soil particles
- 11.3 Deformable Terrain
- 12 Visualizing the Vortex Simulation for Debugging Purposes Using the Vortex Remote Debugger
- 13 Supported Colliding Objects in Unreal
- 14 Mapping Contact Materials
- 15 Packaging Your Project
- 16 Viewing Vortex Studio Log Files in the Unreal Editor
- 17 Limitations
To use the following guide, you must be familiar with Vortex mechanisms, Vortex Graphics Galleries, and the Unreal Editor.
In the following documentation, you will be able to simulate Vortex mechanisms just like any other assets in an Unreal level.
With the Vortex Studio Plugin for Unreal Engine, the Unreal Editor lets you connect to parameters that you expose in Vortex Studio.
Any Vortex Studio simulation parameter can be sent to a function in an Unreal blueprint (get/set) and included in your Unreal level.
Vortex Studio automatically detects landscape components that you create in Unreal 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 the simulation, Vortex Studio sends information about the position and orientation of each body to the Unreal Engine. Parameters and outputs can be accessed via the mechanism's interface. To ensure smooth gameplay with accurate synchronization and realistic movements, Vortex Studio sends information about the position and orientation of each body to the Unreal Engine. Parameters and outputs that you expose using a VHL interface let you control the Mechanism in Unreal.
Vortex Studio manages external devices, such as motion platforms and CANopen-compliant devices for controlling vehicles and enriching simulation.
Getting started...
| Tell me about... |