Varjo Markers

Note: you are currently viewing documentation for a beta or an older version of Varjo

Varjo Markers can be used to track static or dynamic real-world objects using the video pass-through cameras on Varjo XR headsets.

See Varjo Markers for more general information and printing instructions.

Varjo Markers are typically used in mixed reality applications, but can be also used without video pass-through rendering in virtual reality applications to align virtual objects in the scene with physical objects in the real world.

Using Varjo Markers

If you don’t have any printed markers yet, you can find the printing instructions from Varjo Markers.

If you want to use markers with video pass-through, enable the mixed reality cameras as described in Mixed Reality with Unreal.

You can check if Varjo Markers are supported using Is Varjo Markers Supported blueprint node.

Enable Varjo Marker tracking with Set Varjo Marker Tracking Enabled. Blueprint node Is Varjo Marker Tracking Enabled returns the current state.

Create a logic for this. Follow the instructions below. First, create a new blueprint as Actor and name it BP_MarkerControls.

Recreate the logic from the reference image

Compile and Save. Next, go to Project Settings > EngineInput > Action Mapping and create a new Input. Name it VarjoMarkerToggle and set it to key V.

Back in BP_MarkerControls > Event Graph and create InputActionEvent VarjoMarkerToggle.

Recreate the logic from the reference image

Compile and Save. Once Varjo Marker tracking is enabled, you can retrieve updates with events. New Varjo Marker Detected is triggered when a new marker comes visible to the video pass-through cameras. Varjo Marker Moved triggers every time an already known marker receives an updated pose. Varjo Marker Lost is triggered when a known marker has been out of sight for a given timeout.

All events provide a Marker ID, which matches the ID on the printed marker. In addition, New Varjo Marker Detected and Varjo Marker Lost events provide Position, Rotation and Size for the marker. The size of a marker never changes and it’s provided in Unreal units, taking World to Meters scale into account so the size always matches the physical marker.

In BP_MarkerControls > Components section, click Add and create VarjoMarkersEvent.

In VarjoMarkersEvent go to Details > Events and click + on NewVarjoMarkerDetected. Click + again and create VarjoMarkerMoved and VarjoMarkerLost.

You can set a timeout for each marker using the Set Marker Timeout node. This is how many seconds the marker can be out of sight before it’s considered lost and Varjo Marker Lost event is triggered. The default is 0, but it’s recommended to set a longer timeout.

Varjo Markers have two tracking modes; Stationary and Dynamic. The default tracking mode is Stationary, which means the pose is heavily filtered and it’s less responsive to marker’s movements. This is optimal, if you want to align fixed physical elements like a cockpit on a flight simulator with the virtual elements. When the tracking mode is Dynamic, the pose updates are more responsive to marker’s movements. This should be used, if the marker is expected to move. You can set the tracking mode with Set Marker Tracking Mode and check the currently selected mode with Get Marker Tracking Mode.

Create logic for this. Follow the instrutions below. Create a new variable type as Float and name it MarkerTimeout. Make it public by enabling InstanceEditable.

Compile. In Default Value > MarkerTimeout add value of 3 (sec).

Recreate the logic from the reference image

In this example we spawn an Actor for each detected marker. The markers are stored in a map, where they can be accessed using the Marker ID.

The size of the marker contains only width and height, so we reuse the width of the marker for the Z-axis of the scale. The scale is divided by 100, because the side length of the default cube used for visualization here is 100 Unreal units.

Create a logic for Spawning an actor. Follow the instructions below.

First you need to create the spawnable actor blueprint.

See the reference screenshot below.

Create a new blueprint class Actor and name it BP_Marker.

Create a static mesh object as shown in the screenshot.

Create a new function and name it UpdateMarkerTexts.

Compile and Save.

In Details > Inputs, create a new input argument as Integer and name it Marker ID.

Create a variable as Integer and name it ID.

Reference the logic on the Screenshot Image

Go to BP_MarkerControls and in Sequence drag and create IF Branch.

For True, drag and create SpawnActorFromClass and in Class set BP_Marker.

For False, drag and create UpdateMarkerTexts and enable Context Sensitive.

Create a variable and name it MarkerList and set it to be IntegerMapBP Marker.

In NewVarjoMarkerDetected, drag a pin from Size input and create BreakVector2D.

From its X float input drag and create Convert to Vector Float – drag from its input and create Divide – in it Convert B VectorConvert Pin to a Float (Double Precision) and set it to 100.

Recreate the logic from the reference image

Create a logic for Dynamic Marker Tracking Mode. Follow the instructions below.

Create a new function and name it SetEvenMarkerDynamic.

Compile and Save.

In Details, create new input as Integer and name it MarkerId.

Create a variable DynamicEvenMarkersEnabled and set it to Boolean.

Compile and Save.

In Default Value, enable Dynamic Even Markers Enabled. Enable also Instance Editable.

Recreate the logic from the reference image

Create a Toggle for this logic.

In Project Settings > EngineInput > Action Mappings, create a new Input and name it DynamicTrackingToggle. Set it to key C.

Recreate the logic from the reference image

On Varjo Marker Moved, update the position and rotation of the Actor and ensure it is visible. The size of a marker never changes, so it is not necessary to update the scale of the Actor after it is created.

To avoid the need to respawn Actors, we don’t destroy the Actor on Varjo Marker Lost. Instead, we just hide it.

When you hit Play, you should see the spawned Actors perfectly aligned with the Varjo Markers in the real world.

An example for using Varjo Markers can be found from Unreal Examples.