@foxglove/schemas 0.2.0 → 0.5.0

package/schemas/proto/foxglove/PointsAnnotation.proto

@@ -1,4 +1,4 @@
-// Generated from PointsAnnotation by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 
@@ -31,9 +31,15 @@ message PointsAnnotation {
   // Points in 2D image coordinates
   repeated foxglove.Point2 points = 3;
 
-  // Outline colors
-  repeated foxglove.Color outline_colors = 4;
+  // Outline color
+  foxglove.Color outline_color = 4;
+
+  // Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`.
+  repeated foxglove.Color outline_colors = 5;
 
   // Fill color
-  foxglove.Color fill_color = 5;
+  foxglove.Color fill_color = 6;
+
+  // Stroke thickness
+  double thickness = 7;
 }

package/schemas/proto/foxglove/Pose.proto

@@ -1,4 +1,4 @@
-// Generated from Pose by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/proto/foxglove/PoseInFrame.proto

@@ -1,4 +1,4 @@
-// Generated from PoseInFrame by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/proto/foxglove/PosesInFrame.proto

@@ -1,4 +1,4 @@
-// Generated from PosesInFrame by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/proto/foxglove/Quaternion.proto

@@ -1,4 +1,4 @@
-// Generated from Quaternion by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/proto/foxglove/RawImage.proto

@@ -1,4 +1,4 @@
-// Generated from RawImage by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/proto/foxglove/SceneEntity.proto

@@ -0,0 +1,62 @@
+// Generated by https://github.com/foxglove/schemas
+
+syntax = "proto3";
+
+import "foxglove/ArrowPrimitive.proto";
+import "foxglove/CubePrimitive.proto";
+import "foxglove/CylinderPrimitive.proto";
+import "foxglove/KeyValuePair.proto";
+import "foxglove/LinePrimitive.proto";
+import "foxglove/ModelPrimitive.proto";
+import "foxglove/SpherePrimitive.proto";
+import "foxglove/TextPrimitive.proto";
+import "foxglove/TriangleListPrimitive.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+package foxglove;
+
+// (Experimental, subject to change) A visual element in a 3D scene. An entity may be composed of multiple primitives which all share the same frame of reference.
+message SceneEntity {
+  // Timestamp of the entity
+  google.protobuf.Timestamp timestamp = 1;
+
+  // Frame of reference
+  string frame_id = 2;
+
+  // Identifier for the entity. A entity will replace any prior entity on the same topic with the same `id`.
+  string id = 3;
+
+  // Length of time (relative to `timestamp`) after which the entity should be automatically removed. Zero value indicates the entity should remain visible until it is replaced or deleted.
+  google.protobuf.Duration lifetime = 4;
+
+  // Whether the entity should keep its location in the fixed frame (false) or follow the frame specified in `frame_id` as it moves relative to the fixed frame (true)
+  bool frame_locked = 5;
+
+  // Additional user-provided metadata associated with the entity. Keys must be unique.
+  repeated foxglove.KeyValuePair metadata = 6;
+
+  // Arrow primitives
+  repeated foxglove.ArrowPrimitive arrows = 7;
+
+  // Cube primitives
+  repeated foxglove.CubePrimitive cubes = 8;
+
+  // Sphere primitives
+  repeated foxglove.SpherePrimitive spheres = 9;
+
+  // Cylinder primitives
+  repeated foxglove.CylinderPrimitive cylinders = 10;
+
+  // Line primitives
+  repeated foxglove.LinePrimitive lines = 11;
+
+  // Triangle list primitives
+  repeated foxglove.TriangleListPrimitive triangles = 12;
+
+  // Text primitives
+  repeated foxglove.TextPrimitive texts = 13;
+
+  // Model primitives
+  repeated foxglove.ModelPrimitive models = 14;
+}

package/schemas/proto/foxglove/SceneEntityDeletion.proto

@@ -0,0 +1,27 @@
+// Generated by https://github.com/foxglove/schemas
+
+syntax = "proto3";
+
+import "google/protobuf/timestamp.proto";
+
+package foxglove;
+
+// (Experimental, subject to change) Command to remove previously published entities
+message SceneEntityDeletion {
+  // (Experimental, subject to change) An enumeration indicating which entities should match a SceneEntityDeletion command
+  enum Type {
+    // Delete the existing entity on the same topic that has the provided `id`
+    MATCHING_ID = 0;
+
+    // Delete all existing entities on the same topic
+    ALL = 1;
+  }
+  // Timestamp of the deletion. Only matching entities earlier than this timestamp will be deleted.
+  google.protobuf.Timestamp timestamp = 1;
+
+  // Type of deletion action to perform
+  Type type = 2;
+
+  // Identifier which must match if `type` is `MATCHING_ID`.
+  string id = 3;
+}

package/schemas/proto/foxglove/SceneUpdate.proto

@@ -0,0 +1,17 @@
+// Generated by https://github.com/foxglove/schemas
+
+syntax = "proto3";
+
+import "foxglove/SceneEntity.proto";
+import "foxglove/SceneEntityDeletion.proto";
+
+package foxglove;
+
+// (Experimental, subject to change) An update to the entities displayed in a 3D scene
+message SceneUpdate {
+  // Scene entities to delete
+  repeated foxglove.SceneEntityDeletion deletions = 1;
+
+  // Scene entities to add or replace
+  repeated foxglove.SceneEntity entities = 2;
+}

package/schemas/proto/foxglove/SpherePrimitive.proto

@@ -0,0 +1,21 @@
+// Generated by https://github.com/foxglove/schemas
+
+syntax = "proto3";
+
+import "foxglove/Color.proto";
+import "foxglove/Pose.proto";
+import "foxglove/Vector3.proto";
+
+package foxglove;
+
+// (Experimental, subject to change) A primitive representing a sphere or ellipsoid
+message SpherePrimitive {
+  // Position of the center of the sphere and orientation of the sphere
+  foxglove.Pose pose = 1;
+
+  // Size (diameter) of the sphere along each axis
+  foxglove.Vector3 size = 2;
+
+  // Color of the sphere
+  foxglove.Color color = 3;
+}

package/schemas/proto/foxglove/TextPrimitive.proto

@@ -0,0 +1,29 @@
+// Generated by https://github.com/foxglove/schemas
+
+syntax = "proto3";
+
+import "foxglove/Color.proto";
+import "foxglove/Pose.proto";
+
+package foxglove;
+
+// (Experimental, subject to change) A primitive representing a text label
+message TextPrimitive {
+  // Position of the center of the text box and orientation of the text. Identity orientation means the text is oriented in the xy-plane and flows from -x to +x.
+  foxglove.Pose pose = 1;
+
+  // Whether the text should respect `pose.orientation` (false) or always face the camera (true)
+  bool billboard = 2;
+
+  // Font size (height of one line of text)
+  double font_size = 3;
+
+  // Indicates whether `font_size` is a fixed size in screen pixels (true), or specified in world coordinates and scales with distance from the camera (false)
+  bool scale_invariant = 4;
+
+  // Color of the text
+  foxglove.Color color = 5;
+
+  // Text
+  string text = 6;
+}

package/schemas/proto/foxglove/TriangleListPrimitive.proto

@@ -0,0 +1,29 @@
+// Generated by https://github.com/foxglove/schemas
+
+syntax = "proto3";
+
+import "foxglove/Color.proto";
+import "foxglove/Point3.proto";
+import "foxglove/Pose.proto";
+
+package foxglove;
+
+// (Experimental, subject to change) A primitive representing a set of triangles or a surface tiled by triangles
+message TriangleListPrimitive {
+  // Origin of triangles relative to reference frame
+  foxglove.Pose pose = 1;
+
+  // Vertices to use for triangles, interpreted as a list of triples (0-1-2, 3-4-5, ...)
+  repeated foxglove.Point3 points = 2;
+
+  // Solid color to use for the whole shape. One of `color` or `colors` must be provided.
+  foxglove.Color color = 3;
+
+  // Per-vertex colors (if specified, must have the same length as `points`). One of `color` or `colors` must be provided.
+  repeated foxglove.Color colors = 4;
+
+  // Indices into the `points` and `colors` attribute arrays, which can be used to avoid duplicating attribute data.
+  // 
+  // If omitted or empty, indexing will not be used. This default behavior is equivalent to specifying [0, 1, ..., N-1] for the indices (where N is the number of `points` provided).
+  repeated fixed32 indices = 5;
+}

package/schemas/proto/foxglove/Vector2.proto

@@ -1,4 +1,4 @@
-// Generated from Vector2 by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/proto/foxglove/Vector3.proto

@@ -1,4 +1,4 @@
-// Generated from Vector3 by @foxglove/schemas
+// Generated by https://github.com/foxglove/schemas
 
 syntax = "proto3";
 

package/schemas/ros1/ArrowPrimitive.msg

@@ -0,0 +1,22 @@
+# foxglove_msgs/ArrowPrimitive
+# (Experimental, subject to change) A primitive representing an arrow
+
+# Generated by https://github.com/foxglove/schemas
+
+# Position of the arrow's tail and orientation of the arrow. Identity orientation means the arrow points in the +x direction.
+geometry_msgs/Pose pose
+
+# Length of the arrow shaft
+float64 shaft_length
+
+# Diameter of the arrow shaft
+float64 shaft_diameter
+
+# Length of the arrow head
+float64 head_length
+
+# Diameter of the arrow head
+float64 head_diameter
+
+# Color of the arrow
+foxglove_msgs/Color color

package/schemas/ros1/CameraCalibration.msg

@@ -1,4 +1,7 @@
-# Generated from CameraCalibration by @foxglove/schemas
+# foxglove_msgs/CameraCalibration
+# Camera calibration parameters
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of calibration data
 time timestamp

package/schemas/ros1/CircleAnnotation.msg

@@ -1,4 +1,7 @@
-# Generated from CircleAnnotation by @foxglove/schemas
+# foxglove_msgs/CircleAnnotation
+# A circle annotation on a 2D image
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of circle
 time timestamp

package/schemas/ros1/Color.msg

@@ -1,4 +1,7 @@
-# Generated from Color by @foxglove/schemas
+# foxglove_msgs/Color
+# A color in RGBA format
+
+# Generated by https://github.com/foxglove/schemas
 
 # Red value between 0 and 1
 float64 r

package/schemas/ros1/CompressedImage.msg

@@ -1,4 +1,7 @@
-# Generated from CompressedImage by @foxglove/schemas
+# foxglove_msgs/CompressedImage
+# A compressed image
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of image
 time timestamp

package/schemas/ros1/CubePrimitive.msg

@@ -0,0 +1,13 @@
+# foxglove_msgs/CubePrimitive
+# (Experimental, subject to change) A primitive representing a cube or rectangular prism
+
+# Generated by https://github.com/foxglove/schemas
+
+# Position of the center of the cube and orientation of the cube
+geometry_msgs/Pose pose
+
+# Size of the cube along each axis
+geometry_msgs/Vector3 size
+
+# Color of the arrow
+foxglove_msgs/Color color

package/schemas/ros1/CylinderPrimitive.msg

@@ -0,0 +1,19 @@
+# foxglove_msgs/CylinderPrimitive
+# (Experimental, subject to change) A primitive representing a cylinder, elliptic cylinder, or truncated cone
+
+# Generated by https://github.com/foxglove/schemas
+
+# Position of the center of the cylinder and orientation of the cylinder. The flat face(s) are perpendicular to the z-axis.
+geometry_msgs/Pose pose
+
+# Size of the cylinder's bounding box
+geometry_msgs/Vector3 size
+
+# 0-1, ratio of the diameter of the cylinder's bottom face (min z) to the bottom of the bounding box
+float64 bottom_scale
+
+# 0-1, ratio of the diameter of the cylinder's top face (max z) to the top of the bounding box
+float64 top_scale
+
+# Color of the cylinder
+foxglove_msgs/Color color

package/schemas/ros1/FrameTransform.msg

@@ -1,4 +1,7 @@
-# Generated from FrameTransform by @foxglove/schemas
+# foxglove_msgs/FrameTransform
+# A transform between two reference frames in 3D space
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of transform
 time timestamp
@@ -9,5 +12,8 @@ string parent_frame_id
 # Name of the child frame
 string child_frame_id
 
-# Transform from parent frame to child frame
-foxglove_msgs/Transform transform
+# Translation component of the transform
+geometry_msgs/Vector3 translation
+
+# Rotation component of the transform
+geometry_msgs/Quaternion rotation

package/schemas/ros1/GeoJSON.msg

@@ -1,4 +1,7 @@
-# Generated from GeoJSON by @foxglove/schemas
+# foxglove_msgs/GeoJSON
+# GeoJSON data for annotating maps
+
+# Generated by https://github.com/foxglove/schemas
 
 # GeoJSON data encoded as a UTF-8 string
 string geojson

package/schemas/ros1/Grid.msg

@@ -1,4 +1,7 @@
-# Generated from Grid by @foxglove/schemas
+# foxglove_msgs/Grid
+# A 2D grid of data
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of grid
 time timestamp

package/schemas/ros1/ImageAnnotations.msg

@@ -1,4 +1,7 @@
-# Generated from ImageAnnotations by @foxglove/schemas
+# foxglove_msgs/ImageAnnotations
+# Array of annotations for a 2D image
+
+# Generated by https://github.com/foxglove/schemas
 
 # Circle annotations
 foxglove_msgs/CircleAnnotation[] circles

package/schemas/ros1/KeyValuePair.msg

@@ -0,0 +1,10 @@
+# foxglove_msgs/KeyValuePair
+# (Experimental, subject to change) A key with its associated value
+
+# Generated by https://github.com/foxglove/schemas
+
+# Key
+string key
+
+# Value
+string value

package/schemas/ros1/LaserScan.msg

@@ -1,4 +1,7 @@
-# Generated from LaserScan by @foxglove/schemas
+# foxglove_msgs/LaserScan
+# A single scan from a planar laser range-finder
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of scan
 time timestamp

package/schemas/ros1/LinePrimitive.msg

@@ -0,0 +1,39 @@
+# foxglove_msgs/LinePrimitive
+# (Experimental, subject to change) A primitive representing a series of points connected by lines
+
+# Generated by https://github.com/foxglove/schemas
+
+# 0-1, 1-2, ..., (n-1)-n
+uint8 LINE_STRIP=0
+
+# 0-1, 1-2, ..., (n-1)-n, n-0
+uint8 LINE_LOOP=1
+
+# 0-1, 2-3, 4-5, ...
+uint8 LINE_LIST=2
+
+# Drawing primitive to use for lines
+uint8 type
+
+# Origin of lines relative to reference frame
+geometry_msgs/Pose pose
+
+# Line thickness
+float64 thickness
+
+# Indicates whether `thickness` is a fixed size in screen pixels (true), or specified in world coordinates and scales with distance from the camera (false)
+bool scale_invariant
+
+# Points along the line
+geometry_msgs/Point[] points
+
+# Solid color to use for the whole line. One of `color` or `colors` must be provided.
+foxglove_msgs/Color color
+
+# Per-point colors (if specified, must have the same length as `points`). One of `color` or `colors` must be provided.
+foxglove_msgs/Color[] colors
+
+# Indices into the `points` and `colors` attribute arrays, which can be used to avoid duplicating attribute data.
+# 
+# If omitted or empty, indexing will not be used. This default behavior is equivalent to specifying [0, 1, ..., N-1] for the indices (where N is the number of `points` provided).
+uint32[] indices

package/schemas/ros1/LocationFix.msg

@@ -1,4 +1,7 @@
-# Generated from LocationFix by @foxglove/schemas
+# foxglove_msgs/LocationFix
+# A navigation satellite fix for any Global Navigation Satellite System
+
+# Generated by https://github.com/foxglove/schemas
 
 # Latitude in degrees
 float64 latitude

package/schemas/ros1/Log.msg

@@ -1,4 +1,7 @@
-# Generated from Log by @foxglove/schemas
+# foxglove_msgs/Log
+# A log message
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of log message
 time timestamp

package/schemas/ros1/ModelPrimitive.msg

@@ -0,0 +1,25 @@
+# foxglove_msgs/ModelPrimitive
+# (Experimental, subject to change) A primitive representing a 3D model file loaded from an external URL or embedded data
+
+# Generated by https://github.com/foxglove/schemas
+
+# Origin of model relative to reference frame
+geometry_msgs/Pose pose
+
+# Scale factor to apply to the model along each axis
+geometry_msgs/Vector3 scale
+
+# Solid color to use for the whole model if `override_color` is true.
+foxglove_msgs/Color color
+
+# Whether to use the color specified in `color` instead of any materials embedded in the original model.
+bool override_color
+
+# URL pointing to model file. One of `url` or `data` should be provided.
+string url
+
+# [Media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of embedded model (e.g. `model/gltf-binary`). Required if `data` is provided instead of `url`. Overrides the inferred media type if `url` is provided.
+string media_type
+
+# Embedded model. One of `url` or `data` should be provided. If `data` is provided, `media_type` must be set to indicate the type of the data.
+uint8[] data

package/schemas/ros1/PackedElementField.msg

@@ -1,4 +1,7 @@
-# Generated from PackedElementField by @foxglove/schemas
+# foxglove_msgs/PackedElementField
+# A field present within each element in a byte array of packed elements.
+
+# Generated by https://github.com/foxglove/schemas
 
 # Name of the field
 string name

package/schemas/ros1/Point2.msg

@@ -1,4 +1,7 @@
-# Generated from Point2 by @foxglove/schemas
+# foxglove_msgs/Point2
+# A point representing a position in 2D space
+
+# Generated by https://github.com/foxglove/schemas
 
 # x coordinate position
 float64 x

package/schemas/ros1/PointCloud.msg

@@ -1,4 +1,7 @@
-# Generated from PointCloud by @foxglove/schemas
+# foxglove_msgs/PointCloud
+# A collection of N-dimensional points, which may contain additional fields with information like normals, intensity, etc.
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of point cloud
 time timestamp

package/schemas/ros1/PointsAnnotation.msg

@@ -1,4 +1,7 @@
-# Generated from PointsAnnotation by @foxglove/schemas
+# foxglove_msgs/PointsAnnotation
+# An array of points on a 2D image
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of annotation
 time timestamp
@@ -15,8 +18,14 @@ uint8 type
 # Points in 2D image coordinates
 foxglove_msgs/Point2[] points
 
-# Outline colors
+# Outline color
+foxglove_msgs/Color outline_color
+
+# Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`.
 foxglove_msgs/Color[] outline_colors
 
 # Fill color
 foxglove_msgs/Color fill_color
+
+# Stroke thickness
+float64 thickness

package/schemas/ros1/PoseInFrame.msg

@@ -1,4 +1,7 @@
-# Generated from PoseInFrame by @foxglove/schemas
+# foxglove_msgs/PoseInFrame
+# A timestamped pose for an object or reference frame in 3D space
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of pose
 time timestamp

package/schemas/ros1/PosesInFrame.msg

@@ -1,4 +1,7 @@
-# Generated from PosesInFrame by @foxglove/schemas
+# foxglove_msgs/PosesInFrame
+# An array of timestamped poses for an object or reference frame in 3D space
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of pose
 time timestamp

package/schemas/ros1/RawImage.msg

@@ -1,4 +1,7 @@
-# Generated from RawImage by @foxglove/schemas
+# foxglove_msgs/RawImage
+# A raw image
+
+# Generated by https://github.com/foxglove/schemas
 
 # Timestamp of image
 time timestamp

package/schemas/ros1/SceneEntity.msg

@@ -0,0 +1,46 @@
+# foxglove_msgs/SceneEntity
+# (Experimental, subject to change) A visual element in a 3D scene. An entity may be composed of multiple primitives which all share the same frame of reference.
+
+# Generated by https://github.com/foxglove/schemas
+
+# Timestamp of the entity
+time timestamp
+
+# Frame of reference
+string frame_id
+
+# Identifier for the entity. A entity will replace any prior entity on the same topic with the same `id`.
+string id
+
+# Length of time (relative to `timestamp`) after which the entity should be automatically removed. Zero value indicates the entity should remain visible until it is replaced or deleted.
+duration lifetime
+
+# Whether the entity should keep its location in the fixed frame (false) or follow the frame specified in `frame_id` as it moves relative to the fixed frame (true)
+bool frame_locked
+
+# Additional user-provided metadata associated with the entity. Keys must be unique.
+foxglove_msgs/KeyValuePair[] metadata
+
+# Arrow primitives
+foxglove_msgs/ArrowPrimitive[] arrows
+
+# Cube primitives
+foxglove_msgs/CubePrimitive[] cubes
+
+# Sphere primitives
+foxglove_msgs/SpherePrimitive[] spheres
+
+# Cylinder primitives
+foxglove_msgs/CylinderPrimitive[] cylinders
+
+# Line primitives
+foxglove_msgs/LinePrimitive[] lines
+
+# Triangle list primitives
+foxglove_msgs/TriangleListPrimitive[] triangles
+
+# Text primitives
+foxglove_msgs/TextPrimitive[] texts
+
+# Model primitives
+foxglove_msgs/ModelPrimitive[] models