Skip to content

Quick Start

Track your first object in under 5 minutes — no camera or physical object required. This guide uses a pre-recorded sample sequence so you can evaluate XRTracker immediately after installation.

Try the Sample Scene

1. Download the Sample Package

Download the sample .unitypackage containing a 3D model and a recorded image sequence:

Download Sample Package

Import it via Assets > Import Package > Custom Package. The package extracts to:

  • Assets/XRTracker/Samples/SampleObject.fbx — the 3D model
  • Assets/StreamingAssets/SampleSequence/ — the recorded image sequence with sequence.json

2. Create the Tracker Manager

  1. Create an empty GameObject and name it Tracker
  2. Add the XRTrackerManager component
  3. Set Image Source to Sequence
  4. Set Sequence Directory to SampleSequence (the folder name inside StreamingAssets)
  5. Assign your Main Camera to the Camera field

XRTrackerManager Inspector

3. Add the Sample Object

  1. Drag SampleObject.fbx into the scene
  2. Add the TrackedBody component to the GameObject
  3. The Mesh Filters field auto-populates from the GameObject and its children

TrackedBody Inspector

4. Generate the Tracking Model

  1. In the TrackedBody inspector, find the Model section
  2. Click Generate Silhouette Model
  3. Wait for generation to complete (typically 5–30 seconds)

A green checkmark indicates the model is ready.

Model Generation

Tip

If you switch to edge tracking, you can skip model generation — edge tracking works directly from the mesh geometry.

5. Position the Object

Place the 3D model in the scene at roughly the position it appears in the recorded sequence. This gives the tracker an initial pose estimate.

Tip

The initial position doesn't need to be exact — the tracker will refine it during detection. But closer is better for faster lock-on.

6. Press Play

Enter Play Mode. The recorded sequence plays back automatically and the tracker detects and tracks the object through the frames.

The GameObject's transform updates in real-time to match the object's pose. Any child objects (augmentations) follow automatically.

Track with Your Own Camera

Once you've seen tracking work on the sample, try it with a live camera and your own object:

  1. Set Image Source to Native on the XRTrackerManager
  2. Import a 3D model of your real object (correct scale in meters is critical)
  3. Add a TrackedBody component, generate the silhouette model
  4. Position the model in front of the camera to match the real object's approximate location
  5. Press Play and point the camera at the object

See Camera Sources for details on camera setup and calibration.

What's Happening

  1. Detection — XRTracker renders the model from the initial viewpoint and looks for a match in the camera image
  2. Starting — Once detected, the tracker refines the pose over several frames to confirm a good lock
  3. Tracking — Continuous frame-by-frame pose optimization keeps the model aligned with the real object

The Tracking Quality indicator in the inspector shows how well the tracker is locked on (0.0 = lost, 1.0 = perfect).

Next Steps