# Sample Scenes

Documentation for our official Unity sample scenes.

# Where to get them?

Our official sample project can be downloaded from Package Manager.
You can find all sample scenes under "Assets/Samples/Immersal SDK Core/2.0.0/Core Samples/Scenes/"

# Scene

There are few common things in all the scenes

# AR Session, AR Session Origin and AR Camera

Game objects provided by AR Foundation and you can find more about their functionalities from Unity's documentation.
They provide the basic functionalities for the AR session.

# ImmersalSDK

Basic settings for our SDK

• Default Server you can choose the server.
• Developer Token is where you would insert your token found in our Developer Portal.
• Session See "Immersal Session"
• Platform Platform Support takes care of configuring a device as well as providing camera data from that device
• Localizer Localizer takes in data from the platform and uses the core Immersal methods to produce a pose describing the alignment of spatial maps.
• Scene Updater Scene Updated responsible for taking in the pose data from Localizer, adjusting it if necessary, and updating the scene by passing it to the relevant ISpaceUpdateables.
• Tracking Analyzer Tracking Analyzer is responsible for interpreting incoming platform status and localization results and constructing a tracking status to describe the current quality of positioning.
• Target Frame Rate for the app. iOS can manage 60fps, but most Android devices are locked to 30fps.
• Downsample downsamples image to HD resolution.
• Download Directory is the name of the folder where you want to download the maps

# XR Space and XR Maps

These game objects are used by our SDK to transform the AR content to match the real-world.
When a pose is found, the XR Space is transformed in a way that the AR content visually matches the real-world. The AR Camera in the scene is not transformed, but the XR Space is brought to the camera.
Map files in XR Maps are used to move the parent XR Space object. Every XR Map needs to have a parent XR Space object. If one does not exist, it will be created at runtime.

Technically the content can be placed under the XR Maps themselves if that makes organizing the scene easier.
Map files in XR Maps are used to move the parent XR Space object. Every XR Map needs to have a parent XR Space object. If one does not exist, it will be created at runtime.

You should download map with the "XRMap" that is under the "XR Space"

• Copy your map ID from Dashboard
• Paste it in the "Map id"
• Select both Mapfile and Visualization as download options
• Click "Download"

• Localization Method you can choose from "Device" or "Server"
• On Device Behaviour You can choose "Embed" or "Download"
• Map Metadata the metadata tied to the specific map.
  There are other option at the bottom to "Load" "Save" and "Reset" Alignment.

When a map is downloaded you can see these setting on the pointcloud file

• Render Mode sets the visibility of the preview point cloud. Set Render Mode to "Editor And Runtime".
• Point Color changes the color of the preview point cloud.
• Point Size let's you change the point cloud size in the scene.
• Render as 3D Points renders points as 3D.