3D Scene configuration

Maps

Maps are the foundation for your robot visualization. You will add layers on top of the map.

Ground plane

Basic 3D visualization of the area around your robot in Cartesian coordinates.

Robot URDF with the Ground Plane layer active.

Robot URDF with the Ground Plane layer active.

Property NameInputUsage
X offsetX-axis offset from origin (meters)Set an x-axis offset of the center of your scene from the origin of the ground plane.
Y offsetY-axis offset from origin (meters)Set a y-axis offset of the center of your scene from the origin of the ground plane.
Z offsetZ-axis offset from origin (meters)Set a z-axis offset of the center of your scene from the origin of the ground plane.

GPS

GPS map visualization of the area around your robot.

Robot URDF over a GPS map showing its position

Robot URDF on a GPS map showing its real-world position.

Property nameInputUsage
World map typeSatellite, Street, Satellite streetChoose the type of map you want to use.
Map edge lengthMap boundary size (meters)Select the size of your map. Larger map boundaries take longer to render and update.
Default latitudeLatitude (decimal format)Manual entry of the default latitude of your GPS map. N and E are positive values, S and W are negative values.

If you specify a default latitude and default longitude, that location will become the origin of your scene and override the telemetry stream.
Default longitudeLongitude (decimal format)Manual entry of the default longitude of your GPS map. N and E are positive values, S and W are negative values.

If you specify a default latitude and default longitude, that location will become the origin of your scene and override the telemetry stream.
Telemetry streamGPS stream nameProvide a GPS telemetry stream.

If you specify a default latitude and default longitude, that location will become the origin of your scene and override the telemetry stream.
X offsetX-axis offset from origin (meters)Set an x-axis offset of the center of your scene from the origin of the map.
Y offsetY-axis offset from origin (meters)Set a y-axis offset of the center of your scene from the origin of the map.
Z offsetZ-axis offset from origin (meters)Set a z-axis offset of the center of your scene from the origin of the map.

Occupancy

Use localization data to populate an occupancy grid map.

Robot URDF on an occupancy grid map.

Robot URDF on an occupancy grid map.

Property NameInputUsage
Telemetry streamLocalization stream nameProvide a localization stream to feed the occupancy map visualization.
Use historical dataBooleanEnable if a live data stream is not available. Formant will use the most recent historical data available.

Layers

Layers provide 3D renderings of data streams from your robot. Layers are projected over your map and are stacked on top of each other. For information on building custom layers, see Develop custom 3D Scene maps and layers.

Each layer can be positioned by various transforms. This section describes the unique properties of each layer, and the transform properties are described in the following section.

Position indicator

Shows the current position of your robot on the map.

Property NameInputUsage
Use URDFBooleanUse the URDF file set for your Device. To add a URDF file, in the top-right corner of Formant, click on the three dots (meatball menu) and go to Configure device >> Add URDF.

For more information, see URDF.

Marker array

Add a layer of geometric shapes by providing a Marker Array.

Position indicator with a marker array

Position indicator with a Marker Array.

Property NameInputUsage
Telemetry streamMarker Array stream nameProvide a Marker Array stream to feed the geometry layer visualization.
Use historical dataBooleanEnable if a live data stream is not available. Formant will use the most recent historical data available.

πŸ“˜

For more detail on marker arrays, see Marker arrays in the Scene module.

Point cloud

Add a point cloud layer by providing a localization stream.

Robot URDF with point cloud layer.

Robot URDF with point cloud layer.

Property NameInputUsage
Decay timePoint cloud decay time (s)Set how long data points will stay in the point cloud visualization before disappearing.
Full color?BooleanIf enabled, Formant will display the color provided by the sensor. If disabled, Formant will auto-fill with a default color.
Telemetry stream namePoint cloud stream nameProvide a point cloud stream to feed the point cloud visualization.
Use historical dataBooleanEnable if a live data stream is not available. Formant will use the most recent historical data available.

Path

Show the path your robot has taken to arrive at its present position by providing a path stream.

Property NameInputUsage
Telemetry stream namePath stream nameProvide a Path stream to feed the path layer visualization.
Use historical dataBooleanEnable if a live data stream is not available. Formant will use the most recent historical data available.

Transforms

Use transforms to set the position of a layer relative to the origin of your 3D scene.

Cartesian

Sets the origin of a layer to the (x,y,z) coordinates relative to the origin of the map.

Property NameInputUsage
X offsetLayer's offset along the x-axis from the origin (meters)Set the layer's x-axis offset from the scene's origin.
Y offsetLayer's offset along the y-axis from the origin (meters)Set the layer's y-axis offset from the scene's origin.
Z offsetLayer's offset along the z-axis from the origin (meters)Set the layer's z-axis offset from the scene's origin.

GPS

Sets the origin for a layer to (relative latitude, relative longitude). Layered object is placed according to the GPS stream. Distances in meters are then calculated between the GPS stream and the origin of the layer.

Property NameInputUsage
Relative latitudeLayer's origin latitudeSet layer's origin latitude. N and E are positive values, S and W are negative values.
Relative longitudeLayer's origin longitudeSet layer's origin longitude. N and E are positive values, S and W are negative values.
GPS streamName of GPS stream for layerProvide a GPS stream to perform a GPS transformation on your layer. Position and distances for this layer will be calculated relative to the the Relative latitude and Relative longitude.

For example, if the layer is a waypoint placed at (45, 105), and the GPS stream reports a robot location of (46,104), a distance measurement between the GPS stream and the layer's origin would report the distance in meters that is subtended by a (lat, long) difference of (1,-1).

Odometry

Move an object in your scene based on odometry data, via either telemetry stream or realtime stream. When both streams are present, telemetry is prioritized. For more information on telemetry vs. realtime streams, see Ingestion, Streams, Datapoints, and Assets.

Property NameInputUsage
Localization streamName of localization telemetry streamProvide a localization stream to perform an odometry transformation on your layer.
Localization world to localBooleanEnable to perform a world-to-local transformation on your odometry data.
Localization realtime streamName of localization realtime streamProvide a localization realtime stream to perform an odometry transformation on your layer.

Transform tree

Move an object in your scene based on transform tree data.

Property NameInputUsage
Transform tree streamName of transform tree streamProvide a transform tree stream to perform a transform tree transformation on your layer.
Transform tree end pointName of end pointProvide the name of the end point of interest in your transform tree.

πŸ‘‹

If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].