Localization Simulation

Introduction

The SimulationDataManager is a Unity component designed to manage and retrieve localization simulation data from a server. It provides a user-friendly custom editor within the Unity Inspector, allowing developers to easily fetch a list of available simulations, download them, and process them for use in Unity Editor Localization.

This system is intended for use within the Unity Editor only, as indicated by the #if UNITY_EDITOR directive.

Before You Start

This page covers using simulation data inside Unity. You first need at least one capture recorded at the physical location you want to test:

• From the MultiSet app (recommended): Tap +, choose Simulation Data, record a few seconds at the location, then name and upload it. Captures are tied to your account and appear in the Unity Editor immediately. See Simulation Data Capture.

• From your own Unity build: Build the SimulationDataCapture scene shipped with the SDK. See Build a simulation data capture app below.

How to Use Simulation Data

To use simulation data, you need to add the Simulation Manager component to scenes where you want to simulate localization. This includes:

• Localization scene

• Single Frame Localization scene

• Object Tracking scene

• Or any other scene that requires VPS Localization

Once you have a SimulationDataManager component on a GameObject in your scene, you can access the custom inspector to manage your simulation data. The process is divided into two main steps:

Step 1: Fetch Available Simulations

1. Click the "Get Simulation Data List" button.

2. The manager will connect to the server to retrieve a list of all available simulations in your account.

3. While fetching, the button will be disabled and will display "Fetching Simulation Data..." with a progress indicator.

Step 2: Select & Download a Simulation

1. Once the list of simulations is successfully fetched, a new section will appear in the inspector.

2. An info box will show the number of simulations found.

3. An "Available Simulations" dropdown will be populated with the names of all retrieved simulations.

   • A "✓" symbol next to a simulation name indicates that it has already been downloaded to your local machine.

4. Select the desired simulation from the dropdown.

5. Click the "Download Selected Simulation" button.

Download Button States

The download button's appearance and behavior will change based on the current status:

• Download Selected Simulation (Green): The default state when a new, undownloaded simulation is selected.

• Re-download Simulation (Yellow-Orange): This appears if the selected simulation is already present on your local machine. Clicking it will overwrite the existing data.

• Downloading File... (Blue, Disabled): The button shows this state while the simulation's .zip file is being downloaded. A progress bar will be visible.

• Extracting & Processing... (Orange, Disabled): After the download is complete, this state indicates that the files are being extracted and processed.

• Select a Simulation First (Gray, Disabled): This is shown if no simulation has been selected from the dropdown.

Step 3: Run the Simulation

1. Play the scene in the Unity Editor.

2. Click the Localization button in the game UI.

3. The system will use the selected simulation data to perform localization.

4. Upon successful localization, the scene will automatically reposition to simulate what a user would see in the real world at that location.

File Storage

Downloaded and extracted simulation data is stored in the Application.persistentDataPath directory under a SimulationData subfolder. Each simulation's data is placed in a directory named after its unique simulationCode.

Build a Simulation data capture app

From the MultiSet Unity SDK Open the SimulationDataCapture scene and build it using your account credentials. When you run the application, it will launch an AR session to capture simulation data that will later be available in the Unity Editor.