Developer Portal

Overview of our Developer Portal

Creating an Account

You can create a new account by registering at our Developer Portal After registering, you can log in to the portal.

Developer Portal landing page.

Portal Features

The main use for the Developer Portal is to manage and download your maps.

You can also find useful links and the latest Immersal SDK Core package and Demo App from the Developer Portal

Overview

After logging in, you should see something similar to the above screenshot

The Developer Portal has

  • Options to reset your account password or private Developer Token

  • Button to copy your Developer Token (required by most REST API call)

  • Download link to the Immersal SDK Core .unitypackage and Demo App

  • Useful links to the Unity Sample Project, this documentation, and our Discord support channel

  • A Jobs List that shows either all your maps or public maps

  • Various functions to Align, Stitch, Rename, and Delete Maps

  • Output files for the constructed maps and other jobs

  • A 3D viewer for various output files

The Jobs list

By default, the Jobs List shows you your own maps. Each map in the list has several properties:

  • Map id does not change and you can use it throughout the SDK to refer to a specific map

  • Map name is specified for new map construction and stitching jobs. Can be changed later

  • Status - Pending, Processing, Sparse (for partially completed map constructions), Failed or Done.

  • Number of Images captured in the map data

  • Sharing - A map can be either private and accessed with your token only, or public and accessible for anyone

  • Latitude and Longitude are shown if GPS coordinates were captured for the map

  • SDK version used for the job

  • Creator is the account email for the original map creator

  • Created date and time of map creation

  • Downloadable files for all the different output files. You can also view the 3D files in your browser by clicking the eye icon

You can rename maps by clicking on their name

Downloadable files

There are three outputs for constructed maps and one output for map alignment or stitching jobs.

For constructed maps, you have

  • The .bytes map file. This is the map file used by the Cloud Service and Immersal SDK localizers.

  • A .ply file for the sparse point cloud representation of the map

  • A .ply vertex-colored mesh representation of the map

  • A .glb textured mesh representation of the map

Point cloud representation of a map
vertex-colored mesh representation of the same map

Map Preview

There's an eye icon next to the point cloud and mesh downloads. Clicking the icon opens a 3D model viewer to a new tab. You can easily review maps this way.

Point cloud representation of a map in the viewer
Mesh representation of the same map in the viewer

If the map is public, you can even share the viewer link.

https://developers.immersal.com/view.html?1&5555&0

Viewing Public Maps

In addition to viewing and managing your own maps, you can also view all the public maps.

There are two different modes

  • View Public Maps Near Location

  • View Public Maps Created By

Selecting between the Jobs list modes.

Filter by GPS coordinates

You can search for public maps near a location by specifying latitude and longitude coordinates and a radius in meters.

By leaving the fields empty (showing just placeholder values) you can view all public maps.

Filter by creator

You can also search for any user's public maps. Just input a user account name to search.

Managing maps

Renaming maps

Click on the map name to rename it

Send Maps, Sharing Mode, Align Maps, Stitch Maps, and Delete Maps buttons

Deleting maps

You can select a map or multiple maps and delete them.

There is no way to undo deleting maps!

Any of your public maps may have been downloaded previously by other users and they can still retain a copy of the map.

Aligning and Stitching maps

You can select two or more maps for automatic alignment or stitching.

  • Alignment updates the input maps alignment metadata

  • Stitching creates a new map that is the combination of the input maps.

For more information, see Using Multiple Maps

Sharing Mode / Map privacy

You can select one or more maps and set them to either private or public.

  • Private maps can be modified and downloaded only by you with your private Developer Token or through the Developer Portal

  • Public maps are searchable and downloadable by anyone.

Sending Maps

You can select one or more maps and send a copy of them to another user. This is an easy way to quickly share maps between accounts when you don't want to make them public.

  • Select one or more maps from the list

  • Click on the Send Maps button and type in the recipient's user ID

Remember that you can not delete the other user's copy of the map.