Difference between revisions of "Unreal Engine: OptiTrack Live Link Plugin"

(Minor edits to title names)
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
  
  
=Live Link Plugin Setup=
+
=Setup=
 
----
 
----
 
<div class="padded">
 
<div class="padded">
Line 56: Line 56:
 
=Using the Plugin=
 
=Using the Plugin=
 
----
 
----
==Moving Static Mesh or Camera Actors==
+
==Static Meshes or Camera Actors==
 
<div class="padded">
 
<div class="padded">
====1. Add a camera object, or a static mesh object, that you wish to move====
+
====1. Add the camera object or static mesh object that you wish to move====
 
<div class="padded">  
 
<div class="padded">  
 
Add a camera actor from the Place Actors pane or a static mesh from the project into your scene. For the static meshes, make sure their Mobility setting is set to ''Movable'' under the Transform properties.
 
Add a camera actor from the Place Actors pane or a static mesh from the project into your scene. For the static meshes, make sure their Mobility setting is set to ''Movable'' under the Transform properties.
Line 68: Line 68:
 
</div>
 
</div>
  
====2. Add LiveLinkController Component====
+
====2. Add a LiveLinkController Component====
 
<div class="padded">
 
<div class="padded">
 
Select an actor you want to animate, click the “Add Component” button on the details pane, and add ''Live Link Controller''.
 
Select an actor you want to animate, click the “Add Component” button on the details pane, and add ''Live Link Controller''.
Line 88: Line 88:
 
</div>
 
</div>
  
==Live Link Timecode Setup==
+
==Timecode Setup==
 
When the camera system is synchronized to another master sync device and a timecode signal is feeding into [[External_Device_Sync_Guide:_eSync|eSync]], then the received timecode can be used in UE project through the plugin.
 
When the camera system is synchronized to another master sync device and a timecode signal is feeding into [[External_Device_Sync_Guide:_eSync|eSync]], then the received timecode can be used in UE project through the plugin.
  
Line 112: Line 112:
 
[[Image:LiveLink_Timecode_7.png|thumb|center|550px|Timecode shown in the Take Recorder pane.]]
 
[[Image:LiveLink_Timecode_7.png|thumb|center|550px|Timecode shown in the Take Recorder pane.]]
 
</div>
 
</div>
 +
</div>
 +
 +
==Skeletons==
 +
<div class="padded">
 +
====1. Create a new Animation Blueprint====
 +
<div class="padded">
 +
Right click the mesh you would like to use and select "Create > Anim Blueprint"
 +
 +
<center><ul>
 +
<div class="thumblist">[[Image:LLSkeleton_New_Anim_Blueprint.png|thumb|400px|New animation blueprint.]]</div>
 +
</ul></center>
 +
 +
</div>
 +
 +
====2. Name and Open the Animation Blueprint====
 +
<div class="padded">
 +
Name the animation blueprint something reasonable, then double click it to open the blueprint.
 +
 +
[[Image:LLSkeleton_Rename.png|thumb|center|600px|Rename blueprint.]]
 +
</div>
 +
 +
====3. Hook up your Blueprint====
 +
<div class="padded">
 +
Create a "Live Link Pose" component and connect it to the "Output Pose". Assign the "Live Link Subject Name" to the skeleton that you would like to use.
 +
 +
[[Image:LLSkeleton_Blueprint.png|thumb|center|600px|Connect to pose, then choose name.]]
 +
 +
Change the "Retarget Asset" property in the Details pane of the blueprint editor to "OptiTrackLiveLinkRetarget"
 +
 +
[[Image:LLSkeleton_Retarget.png|thumb|center|400px|Retargeting option.]]
 +
 +
</div>
 +
 +
====4. Getting the Skeleton to Animate====
 +
<div class="padded">
 +
 +
To animate the skeleton in real time click the Animation Blueprint from earlier. In the Details pane press "+ Add Component > Live Link Skeleton Animation". After you add that component the mesh should start animating.
 +
 +
To animate the skeleton in a game, just press the play button. Adding the "Live Link Skeleton Animation" object is not necessary to animate in play mode.
 +
 +
[[Image:LLSkeleton_LiveTrackingComponent.png|thumb|center|600px|Component to animate skeleton.]]
 +
 +
</div>
 +
 +
====Debugging Note====
 +
<div class="padded">
 +
If the retargeting doesn't match the mesh correctly, then you can create a new OptiTrackLiveLinkRetarget blueprint from scratch and modify the bone mapping names.
 +
 +
[[Image:LLSkeleton_Debugging.png|thumb|center|650px|Options for retargeting to different names.]]
 +
 +
</div>
 +
 
</div>
 
</div>
  

Latest revision as of 17:05, 24 August 2021

Main PageOptiTrack Unreal Engine 4 Plugin → Unreal Engine: OptiTrack Live Link Plugin

Overview

This page provides instructions on how to use the OptiTrack Unreal Engin Live Link plugin. The plugin communicates with Unreal's built-in Live Link system by providing a Live Link source for receiving tracking data streamed from Motive. This plugin can be used for controlling cameras and objects in virtual production applications. When needed, the OptiTrack Unreal Engine 4 Plugin can also be alongside this plugin.


Setup


1. [Motive] Setup rigid body streaming in Motive.

Get Motive streaming with at least one rigid body. Make sure the Streaming settings are configured correctly, and the rigid body is active under the Assets pane.

2. [UE] Install the OptiTrack plugins in Unreal Engine (UE).

You can install the OptiTrack Unreal Engine plugin by putting the plugin files into one of the following directories:

  • A global engine plugin can be placed in C:\Program Files\Epic Games\[Engine Version]\Engine\Plugins
  • A project-specific plugin can be placed in [Project Directory]\Plugins

3. [UE] Enable the plugins in UE project.

Go to Edit → Plugins and enable two of the required plugins. First one is the OptiTrack - Live Link plugin under Installed group, and the second one is the built-in Live Link plugin under Built-In group.

OptiTrack - Live Link plugin. Make sure the plugins are placed in the plugins folder either in the project or engine directory.
Built-In Live Link plugin.

4. [UE] Open the LiveLink pane

Open the LiveLink pane from Window → Live Link in the toolbar.

    LiveLine pane in UE.
    LiveLine pane in UE.

5. [UE] Configure and create a new OptiTrack source

In the LiveLink pane under Source options, go to the OptiTrack Source menu and configure the proper connection settings and click Create. Please make sure to use matching network settings configured from the Streaming pane in Motive.

Creating OptiTrack source with client streaming settings.

6. [UE] Check the Connection.

If the streaming settings are correct and the connection to Motive server is successful, the plugin will list out all of the detected rigid bodies, and they should have green dots next to them indicating that the corresponding rigid body has been created and is receiving data. If the dots are yellow, it means that the client has stopped receiving data. Check if Motive is still tracking or if there is a connection error.

Connected to the rigid body data stream.

Using the Plugin


Static Meshes or Camera Actors

1. Add the camera object or static mesh object that you wish to move

Add a camera actor from the Place Actors pane or a static mesh from the project into your scene. For the static meshes, make sure their Mobility setting is set to Movable under the Transform properties.

    Camera actor listed under the Place Actors pane.
    Actor mobility set to movable.

2. Add a LiveLinkController Component

Select an actor you want to animate, click the “Add Component” button on the details pane, and add Live Link Controller.

Live Link Controller component needs be added.

3. Select the target rigid body

Under the Live Link Controller component properties → Subject Representation, select the target rigid body.

The target rigid body selected under Live Link Controller component properties.

4. Check

Once the target rigid body is selected, each object with the Live Link Controller component attached and configured will be animated in the scene.

Timecode Setup

When the camera system is synchronized to another master sync device and a timecode signal is feeding into eSync, then the received timecode can be used in UE project through the plugin.

1. Set Timecode Provider under project settings

From Edit → Project Settings, search timecode and under Engine - General settings, you should find settings for the timecode. Here, set the the Timecode Provider to LiveLinkTimeCodeProvider.

Select the timecode provider under project settings.

2. Set OptiTrack source in the Live Link pane as the Timecode Provider

Open the Live Link pane, and select the OptiTrack subject that we created when first setting up the plugin connection. Then, under its properties, check the Timecode Provider box.

Enable timecode provider setting in the plugin.

3. Check

The timecode from Motive should now be seen in the Take Recorder pane. Take Recorder pane can be found under Window → Cinematic → Take Recorder in the toolbar.

Timecode shown in the Take Recorder pane.

Skeletons

1. Create a new Animation Blueprint

Right click the mesh you would like to use and select "Create > Anim Blueprint"

    New animation blueprint.

2. Name and Open the Animation Blueprint

Name the animation blueprint something reasonable, then double click it to open the blueprint.

Rename blueprint.

3. Hook up your Blueprint

Create a "Live Link Pose" component and connect it to the "Output Pose". Assign the "Live Link Subject Name" to the skeleton that you would like to use.

Connect to pose, then choose name.

Change the "Retarget Asset" property in the Details pane of the blueprint editor to "OptiTrackLiveLinkRetarget"

Retargeting option.

4. Getting the Skeleton to Animate

To animate the skeleton in real time click the Animation Blueprint from earlier. In the Details pane press "+ Add Component > Live Link Skeleton Animation". After you add that component the mesh should start animating.

To animate the skeleton in a game, just press the play button. Adding the "Live Link Skeleton Animation" object is not necessary to animate in play mode.

Component to animate skeleton.

Debugging Note

If the retargeting doesn't match the mesh correctly, then you can create a new OptiTrackLiveLinkRetarget blueprint from scratch and modify the bone mapping names.

Options for retargeting to different names.

Standalone Game Mode


For testing the project in standalone game mode, or when developing an nDislay application, the Live Link plugin settings must be saved out and selected as the default preset to be loaded onto the project. If this is not done, the configured settings may not get applied. After configuring the LiveLink plugin settings, save out the preset from the Live Link pane first. Then, open the Project Settings and find Live Link section in the sidebar. Here, you can select the default Live Link preset to load onto the project, as shown in the screenshot below. Once the preset is properly saved and loaded, the corresponding plugin settings will be applied to the standalone game mode.

If all the configuration is correct, the actors will get animated in the newly opened game window when playing the project in the standalone game mode.

  • Creating a preset from Live Link panel. Select Save As Preset
  • Assigning the preset in the Project Settings.
  • Playing a scene in standalone game mode.

Troubleshooting


Q - Trying to add more than 64 frames in the same frame. Oldest frames will be discarded.

A - This notification message may appear at the bottom of the Live Link pane if the frame rate in the data stream doesn't match the rendering frame rate inside UE. This is within notification within the Engine only, so it should not interfere with the project. If this notification must be removed, you can go to the Project Settings → Engine → General Settings → Framerate section, check Use Fixed Frame Rate option, and set the Fixed Frame Rate to be the same rate as the Motive frame rate.

LiveLink TS Framerate.png