Skip to main content

3D

Display markers, entities, camera images, meshes, URDF models, and more in a 3D scene.

3d panel

Supported messages

The 3D panel can visualize an assortment of different messages.

To visualize a topic, the messages on that topic must conform to one of the known message schemas listed below.

Camera field-of-view

Calibration parameters for your scene's camera.

frameworkschema
ROS 1sensor_msgs/CameraInfo
ROS 2sensor_msgs/msg/CameraInfo
Customfoxglove.CameraCalibration

Grid

2D colored grids.

grid

frameworkschema
ROS 1nav_msgs/OccupancyGrid
ROS 2nav_msgs/msg/OccupancyGrid
Customfoxglove.Grid

foxglove.Grid settings

fielddescription
Color modeOne of:
Flat: solid color
Color map: pre-defined color palette
Gradient: smooth transition between two custom colors
RGBA (separate fields): use embedded color from each cell's red, green, blue, and alpha fields (see below)
Flat colorOnly shown if "Color mode" is set to "Flat"; hex code for color of each cell
Color byOnly shown if "Color mode" is set to any value but "Flat"; numeric field in message used for coloring logic
Color mapOnly shown if "Color mode" is set to "Color map"; "Turbo" (Google) or "Rainbow" (RViz); for mapping "Color by" field values to colors
OpacityOnly shown if "Color mode" is set to "Color map" or "BGR (packed)"; sets alpha value for all cells
Value minOnly shown if "Color mode" is set to any value but "Flat"; minimum value used to normalize incoming grid's "Color by" field values
Value maxOnly shown if "Color mode" is set to any value but "Flat"; maximum value used to normalize incoming grid's "Color by" field values
Frame lock"On" means the grid is locked to the frame specified by its frame_id, and will move as that frame's transforms change. "Off" means the grid is relative to the fixed frame and will not move after it is first displayed.
RGBA (separate fields) color mode

Each cell can contain color information in four separate fields, named red, green, blue, and alpha, of any numeric type:

  • Floating-point values — 0–1 range
  • Unsigned integer values — Maximum possible range (e.g. 0–255 for a UINT8 field)
  • Signed integer values-max to max (e.g. 127 to 127 for an INT8 field; a value of 128 is treated as identical to 127)
fielddescription
Color modeOne of:
Costmap: pre-defined RViz color palette. Cannot customize settings further.
Custom: custom color palette using settings below
Min colorColor corresponding to minimum cell value (0)
Max colorColor corresponding to maximum cell value (100). Note that cells with value exactly 100 are displayed as fully transparent.
Unknown colorColor corresponding to unknown cell value (1)
Fallback colorColor corresponding to cell values that fall outside the range from 1 to 100
Frame lock"On" means the grid is locked to the frame specified by its frame_id, and will move as that frame's transforms change. "Off" means the grid is relative to the fixed frame and will not move after it is first displayed.

Image

Images displayed in the 3D scene, using the corresponding Camera field-of-view messages.

frameworkschema
ROS 1sensor_msgs/Image
ROS 2sensor_msgs/msg/Image
ROS 1sensor_msgs/CompressedImage
ROS 2sensor_msgs/msg/CompressedImage
Customfoxglove.RawImage
Customfoxglove.CompressedImage

Laser scan

A single scan from a planar laser range-finder.

frameworkschema
ROS 1sensor_msgs/LaserScan
ROS 2sensor_msgs/msg/LaserScan
Customfoxglove.LaserScan

ROS polygons

Timestamped polygons made up of a series of connected points.

frameworkschema
ROS 1geometry_msgs/PolygonStamped
ROS 2geometry_msgs/msg/PolygonStamped

ROS markers

Similar to scene entities, these Marker messages describe primitive shapes or meshes.

frameworkschema
ROS 1visualization_msgs/Marker
ROS 2visualization_msgs/msg/Marker
ROS 1visualization_msgs/MarkerArray
ROS 2visualization_msgs/msg/MarkerArray

Mesh markers

Markers with a mesh_resource field support the following URL schemes:

  • http(s)://
  • package:// (Desktop app only)
  • file:// (Desktop app only)

And file formats:

glTF (.glb)

This is the preferred format, as it enjoys the best performance of all supported file types.

Binary glTF files bundle all required assets into a single file, with support for embedded meshes, compression, and the same physically-based material system used in Foxglove. As a result, your model should appear in Foxglove similarly to how it appears in other 3D programs.

STL (.stl)

STL files are well supported in Foxglove, but lack some of glTF's visualization features. The main advantage to STL is the ability to share the same files between your hardware manufacturing process and robot visualization tooling.

STL was designed for 3D printing and CAD applications, and does not include materials or hierarchies of meshes. While they can be represented in a binary encoding, STL files are commonly represented with ASCII characters, which leads to larger files.

COLLADA (.dae)

As a predecessor to glTF, COLLADA has a similar feature set. With that said, it does have larger XML-based files, no compression, and additional processing overhead.

There is a bug in RViz where the up-axis metadata is ignored, resulting in incorrect orientations for many .dae files in ROS environments. To work around this, the 3D panel has a Ignore COLLADA <up_axis> setting to toggle between observing the <up-axis> tag or ignoring it like RViz.

Wavefront OBJ (.obj)

OBJ is a simple ASCII format predating all other supported formats. It has large file sizes, no material support, no mesh hierarchies, no compression, and additional processing overhead.

Material support was added to the OBJ format as separate .mtl files, which Foxglove does not read.

Path

An array of timestamped poses in a named coordinate frame, denoting an object's path through space.

frameworkschema
ROS 1nav_msgs/Path
ROS 2nav_msgs/msg/Path
Customfoxglove.PosesInFrame

Point cloud

A collection of N-dimensional points, which may contain additional fields with information like normals, intensity, etc.

pointcloud

frameworkschema
ROS 1sensor_msgs/PointCloud2
ROS 2sensor_msgs/msg/PointCloud2
Customfoxglove.PointCloud

Settings

fielddescription
Point sizeSize of each rendered point
Point shapeShape of each rendered point
Stixel viewVisualize points as stixels that extend from the point's z location to 0
Decay timeDuration of time (in sec) that each point stays rendered
Color modeOne of:
Flat: solid color
Color map: pre-defined color palette
Gradient: smooth transition between two custom colors
BGR (packed): sensor_msgs/PointCloud2 only; use embedded color from each point's rgb field (see below)
BGRA (packed): sensor_msgs/PointCloud2 only; use embedded color from each point's rgba field (see below)
RGBA (separate fields): foxglove.PointCloud only; use embedded color from each point's red, green, blue, and alpha fields (see below)
Flat colorOnly shown if "Color mode" is set to "Flat"; hex code for color of each point
Color byOnly shown if "Color mode" is set to any value but "Flat"; numeric field in message used for coloring logic
Color mapOnly shown if "Color mode" is set to "Color map"; "Turbo" (Google) or "Rainbow" (RViz); for mapping "Color by" field values to colors
OpacityOnly shown if "Color mode" is set to "Color map" or "BGR (packed)"; sets alpha value for all points
Value minOnly shown if "Color mode" is set to any value but "Flat"; minimum value used to normalize incoming points' "Color by" field values
Value maxOnly shown if "Color mode" is set to any value but "Flat"; maximum value used to normalize incoming points' "Color by" field values

RGBA color modes

When using the "BGR (packed)", "BGRA (packed)", and "RGBA (separate fields)" color modes, your point cloud message must contain certain fields to display color information for each point.

RGBA (separate fields)

For foxglove.PointCloud messages, each point can contain color information in four separate fields, named red, green, blue, and alpha, of any numeric type:

  • Floating-point values — 0–1 range
  • Unsigned integer values — Maximum possible range (e.g. 0–255 for a UINT8 field)
  • Signed integer values-max to max (e.g. 127 to 127 for an INT8 field; a value of 128 is treated as identical to 127)
BGR (packed) and BGRA (packed)

For sensor_msgs/PointCloud2 messages, each point can contain color information in a single field named rgb or rgba:

  • Must use a 4-byte type from sensor_msgs/PointField (UINT32, value 6, is recommended)
  • Each red, green, blue, and alpha value is represented by one byte in the 0–255 range
  • Bytes must be packed in [0xBB, 0xGG, 0xRR, 0xAA] order (i.e. (0xAA << 24) | (0xRR << 16) | (0xGG << 8) | 0xBB in little-endian order). This order is compatible with RViz.

If using the "BGR" mode, the alpha value must still be present, but is ignored.

Pose

Poses in a named coordinate frame.

frameworkschema
ROS 1geometry_msgs/PoseArray
ROS 2geometry_msgs/msg/PoseArray
ROS 1geometry_msgs/PoseStamped
ROS 2geometry_msgs/msg/PoseStamped
Customfoxglove.PosesInFrame

Scene entity

A collection of primitive shapes (cubes, spheres, text, meshes, lines, etc) used to display anything from a basic bounding box to a complex 3D decision tree or road network.

Scene entities must be wrapped in a SceneUpdate message.

frameworkschema
Customfoxglove.SceneEntity
Customfoxglove.SceneUpdate

Transforms

A transform (translation and rotation) between two reference frames in 3D space.

frameworkschema
ROS 1tf/tfMessage
ROS 1tf2_msgs/TFMessage
ROS 2tf2_msgs/msg/TFMessage
Customfoxglove.FrameTransform

Velodyne scan

Velodyne Lidar scan packets from the Velodyne ROS driver or the Foxglove desktop app's Velodyne connection.

frameworkschema
ROS 1velodyne_msgs/VelodyneScan
ROS 2velodyne_msgs/msg/VelodyneScan

Video

Compressed videos displayed in the 3D scene, using the corresponding Camera field-of-view messages.

frameworkschema
Customfoxglove.CompressedVideo

Settings

Frame

Select your 3D scene's display frame and follow mode.

fielddescription
Display frameConfigures the coordinate frame for rendering the scene.

To render a scene element, you need a transform from its frame to the selected display frame. If its frame is the display frame, no additional transform is needed.
Follow modeConfigures the viewport following behavior.
  • "Pose" - Follows the display frame's position and orientation
  • "Position" - Follows the display frame's position only
  • "Fixed" - Does not update viewport

Scene

Configure generic rendering properties and viewport properties.

fielddescription
Render statsDisplay rendering performance statistics in panel corner
BackgroundScene's background color
Label scaleScale of rendered labels
Ignore COLLADA <up_axis>Ignore the <up_axis> tag in COLLADA files
Mesh up axisDirection of “up” when loading meshes (STL, OBJ) without orientation info ("Y-up", "Z-up")
Sync cameraSync the camera states of multiple 3D panels

View

Configure the camera settings.

fielddescription
DistanceDistance of camera from viewport center (i.e. zoom level)
PerspectiveToggles between 3D ("on") and 2D ("off") view of the scene. The 2D view orients the camera towards z-down.
Target Xx-coordinate of viewport center
Yy-coordinate of viewport center
Zz-coordinate of viewport center
ThetaCamera's theta
PhiCamera's phi
Y-Axis FOVCamera's field of vision on y-axis
NearCamera frustum near plane
FarCamera frustum far plane

Transforms

A robotics system produces many messages describing its observations of the world around it. These messages may exist in one or more coordinate frames, or on different parts of the robot.

Transforms define the spacial relationships between two coordinate frames at a given time. To render objects into the scene, there must exist a transform path from the object's coordinate frame to the display frame.

Visualize transform frames to debug why elements may not be rendering where expected.

transforms

History

The panel stores coordinate frame relationships over time in a transform history store. Each coordinate frame stores up to 50,000 transform messages before it begins to remove the oldest messages as new messages arrive.

Preloading

Transform preloading in the 3D panel ensures an accurate scene by loading transform messages into memory. Transform preloading may impact 3D panel performance during preloading and seeking. You can disable preloading in the 3D panel settings. However, when disabled, the 3D panel may not properly render your scene in certain circumstances where infrequent coordinate frames are involved.

Troubleshooting

When working with live sources where time synchronicity cannot be achieved, it is recommended to have the server publish it's Time according to the Foxglove Websocket Protocol. Otherwise if the server time is ahead of the visualization app, certain messages in the 3D panel will display immediately but coordinate frame state can lag behind as the app uses its wall time instead of the server time.

Settings

fielddescription
EditableToggles in-app editing of transform frames. When "on", you can update the Translation and Rotation values to tweak transform frames, see the impact on the scene, and debug how you may want to adjust the frames on your robot. When turned "Off", will revert to original translation and rotation values.
LabelsToggle the display of transform labels.
Axis scaleScale of transform axis (displayed as an arrow marker)
Line widthWidth of transform (displayed as a line marker)
Line colorColor of transform (displayed as a line marker)
Enable preloadingPreload transform messages from the data source.

Topics

Lists topics containing supported message types that can be displayed in the scene. Toggle individual topics.

Each topic provides settings to configure how the visualization appears in the scene.

Any topic with messages matching the supported schemas will show up in the topics list. Each supported format has format specific visualization settings. These settings will show up under the topic.

Use the top-level menu to toggle all topics. You can toggle any individual topic by click the eye icon next to the topic name.

Custom layers

Custom layers allow you to add visual elements not from your data source.

Use the top-level menu to add custom layers.

Add Grid

A grid is 2D square with a fixed size and number of divisions. You can create any numbers of grids. Grids can be rendered relative to the display frame or any other transform frame.

grid

Use the grid layer settings to change the frame, size, color, divisions, and other properties of the grid.

Add URDF

URDF robot models are loaded automatically if your data source supports parameters (i.e. a native ROS 1 or ROS 2 connection) and the /robot_description parameter is set to valid URDF XML.

You can add URDF models with a custom layer. Use each layer's menu to duplicate or delete the custom layer.

fielddescription
SourceSource for URDF file ("URL", "File path (desktop only)", "Parameter", or "Topic")
URLURL to the source URDF file in one of the following schemes:
  • http(s):// – Over an HTTP(S) connection
  • package:// – Local package path (desktop app only)
  • file:// – Local file path (desktop app only)
File pathFile path to the source URDF file
ParameterParameter containing the source URDF file
TopicTopic containing the source URDF file
Label(Optional) Label with which the custom layer will appear in the sidebar.
Frame prefix(Optional) Prefix for robot's transforms. Also commonly known as a TF prefix.
Display modeRobot link geometries to display
  • Auto – Defaults to visual geometries, but falls back to collision geometries if there are no visuals
  • Visual – Visual geometries
  • Collision – Collision geometries
ColorFallback color for the URDF model, if the source doesn't contain colors

Publish

Configure click-to-publish behavior for the 3D panel.

fielddescription
TypeType of message to publish.
TopicTopic to publish message to – only possible with a ROS data source with publish support.

User interactions

Click any object in the scene to display its relevant details in the selected object popup.

3d panel clicked marker

Selecting an object will set a $selected_id variable to the clicked object's id value, if it has one. For ROS markers and scene entities, you can also set another variable on click.

The panel controls on the right can be used to do the following:

  • Select toggle object select mode
  • 3D Toggle between 3D and 2D views of the scene
  • Measure measure the distance between two points

Shortcuts

To move the camera:

  • w – Move camera forward
  • s – Move camera backward
  • a – Move camera to the left
  • d – Move camera to the right
  • Scroll – Zoom in and out
  • Drag – Move camera parallel to the ground
  • Right-click + Drag horizontally – Rotate the camera around the world's z-axis
  • Right-click + Drag vertically – Pan the camera around the world's x- and y- axes