@foxglove/schemas 0.2.0 → 0.5.0

package/schemas/jsonschema/ImageAnnotations.json

@@ -1,14 +1,13 @@
 {
-  "$comment": "Generated from ImageAnnotations by @foxglove/schemas",
-  "title": "ImageAnnotations",
+  "title": "foxglove.ImageAnnotations",
   "description": "Array of annotations for a 2D image",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "circles": {
       "type": "array",
       "items": {
-        "$comment": "Generated from CircleAnnotation by @foxglove/schemas",
-        "title": "CircleAnnotation",
+        "title": "foxglove.CircleAnnotation",
         "description": "A circle annotation on a 2D image",
         "type": "object",
         "properties": {
@@ -29,8 +28,7 @@
             "description": "Timestamp of circle"
           },
           "position": {
-            "$comment": "Generated from Point2 by @foxglove/schemas",
-            "title": "Point2",
+            "title": "foxglove.Point2",
             "description": "Center of the circle in 2D image coordinates",
             "type": "object",
             "properties": {
@@ -53,8 +51,7 @@
             "description": "Line thickness"
           },
           "fill_color": {
-            "$comment": "Generated from Color by @foxglove/schemas",
-            "title": "Color",
+            "title": "foxglove.Color",
             "description": "Fill color",
             "type": "object",
             "properties": {
@@ -77,8 +74,7 @@
             }
           },
           "outline_color": {
-            "$comment": "Generated from Color by @foxglove/schemas",
-            "title": "Color",
+            "title": "foxglove.Color",
             "description": "Outline color",
             "type": "object",
             "properties": {
@@ -107,8 +103,7 @@
     "points": {
       "type": "array",
       "items": {
-        "$comment": "Generated from PointsAnnotation by @foxglove/schemas",
-        "title": "PointsAnnotation",
+        "title": "foxglove.PointsAnnotation",
         "description": "An array of points on a 2D image",
         "type": "object",
         "properties": {
@@ -129,7 +124,7 @@
             "description": "Timestamp of annotation"
           },
           "type": {
-            "title": "PointsAnnotationType: Type of points annotation",
+            "title": "foxglove.PointsAnnotationType",
             "description": "Type of points annotation to draw",
             "oneOf": [
               {
@@ -157,8 +152,7 @@
           "points": {
             "type": "array",
             "items": {
-              "$comment": "Generated from Point2 by @foxglove/schemas",
-              "title": "Point2",
+              "title": "foxglove.Point2",
               "description": "A point representing a position in 2D space",
               "type": "object",
               "properties": {
@@ -174,11 +168,33 @@
             },
             "description": "Points in 2D image coordinates"
           },
+          "outline_color": {
+            "title": "foxglove.Color",
+            "description": "Outline color",
+            "type": "object",
+            "properties": {
+              "r": {
+                "type": "number",
+                "description": "Red value between 0 and 1"
+              },
+              "g": {
+                "type": "number",
+                "description": "Green value between 0 and 1"
+              },
+              "b": {
+                "type": "number",
+                "description": "Blue value between 0 and 1"
+              },
+              "a": {
+                "type": "number",
+                "description": "Alpha value between 0 and 1"
+              }
+            }
+          },
           "outline_colors": {
             "type": "array",
             "items": {
-              "$comment": "Generated from Color by @foxglove/schemas",
-              "title": "Color",
+              "title": "foxglove.Color",
               "description": "A color in RGBA format",
               "type": "object",
               "properties": {
@@ -200,11 +216,10 @@
                 }
               }
             },
-            "description": "Outline colors"
+            "description": "Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`."
           },
           "fill_color": {
-            "$comment": "Generated from Color by @foxglove/schemas",
-            "title": "Color",
+            "title": "foxglove.Color",
             "description": "Fill color",
             "type": "object",
             "properties": {
@@ -225,6 +240,10 @@
                 "description": "Alpha value between 0 and 1"
               }
             }
+          },
+          "thickness": {
+            "type": "number",
+            "description": "Stroke thickness"
           }
         }
       },

package/schemas/jsonschema/KeyValuePair.json

@@ -0,0 +1,16 @@
+{
+  "title": "foxglove.KeyValuePair",
+  "description": "(Experimental, subject to change) A key with its associated value",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
+  "type": "object",
+  "properties": {
+    "key": {
+      "type": "string",
+      "description": "Key"
+    },
+    "value": {
+      "type": "string",
+      "description": "Value"
+    }
+  }
+}

package/schemas/jsonschema/LaserScan.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from LaserScan by @foxglove/schemas",
-  "title": "LaserScan",
+  "title": "foxglove.LaserScan",
   "description": "A single scan from a planar laser range-finder",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "timestamp": {
@@ -25,14 +25,12 @@
       "description": "Frame of reference"
     },
     "pose": {
-      "$comment": "Generated from Pose by @foxglove/schemas",
-      "title": "Pose",
+      "title": "foxglove.Pose",
       "description": "Origin of scan relative to frame of reference; points are positioned in the x-y plane relative to this origin; angles are interpreted as counterclockwise rotations around the z axis with 0 rad being in the +x direction",
       "type": "object",
       "properties": {
         "position": {
-          "$comment": "Generated from Vector3 by @foxglove/schemas",
-          "title": "Vector3",
+          "title": "foxglove.Vector3",
           "description": "Point denoting position in 3D space",
           "type": "object",
           "properties": {
@@ -51,8 +49,7 @@
           }
         },
         "orientation": {
-          "$comment": "Generated from Quaternion by @foxglove/schemas",
-          "title": "Quaternion",
+          "title": "foxglove.Quaternion",
           "description": "Quaternion denoting orientation in 3D space",
           "type": "object",
           "properties": {

package/schemas/jsonschema/LinePrimitive.json

@@ -0,0 +1,167 @@
+{
+  "title": "foxglove.LinePrimitive",
+  "description": "(Experimental, subject to change) A primitive representing a series of points connected by lines",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
+  "type": "object",
+  "properties": {
+    "type": {
+      "title": "foxglove.LineType",
+      "description": "Drawing primitive to use for lines",
+      "oneOf": [
+        {
+          "title": "LINE_STRIP",
+          "const": 0,
+          "description": "0-1, 1-2, ..., (n-1)-n"
+        },
+        {
+          "title": "LINE_LOOP",
+          "const": 1,
+          "description": "0-1, 1-2, ..., (n-1)-n, n-0"
+        },
+        {
+          "title": "LINE_LIST",
+          "const": 2,
+          "description": "0-1, 2-3, 4-5, ..."
+        }
+      ]
+    },
+    "pose": {
+      "title": "foxglove.Pose",
+      "description": "Origin of lines relative to reference frame",
+      "type": "object",
+      "properties": {
+        "position": {
+          "title": "foxglove.Vector3",
+          "description": "Point denoting position in 3D space",
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number",
+              "description": "x coordinate length"
+            },
+            "y": {
+              "type": "number",
+              "description": "y coordinate length"
+            },
+            "z": {
+              "type": "number",
+              "description": "z coordinate length"
+            }
+          }
+        },
+        "orientation": {
+          "title": "foxglove.Quaternion",
+          "description": "Quaternion denoting orientation in 3D space",
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number",
+              "description": "x value"
+            },
+            "y": {
+              "type": "number",
+              "description": "y value"
+            },
+            "z": {
+              "type": "number",
+              "description": "z value"
+            },
+            "w": {
+              "type": "number",
+              "description": "w value"
+            }
+          }
+        }
+      }
+    },
+    "thickness": {
+      "type": "number",
+      "description": "Line thickness"
+    },
+    "scale_invariant": {
+      "type": "boolean",
+      "description": "Indicates whether `thickness` is a fixed size in screen pixels (true), or specified in world coordinates and scales with distance from the camera (false)"
+    },
+    "points": {
+      "type": "array",
+      "items": {
+        "title": "foxglove.Point3",
+        "description": "A point representing a position in 3D space",
+        "type": "object",
+        "properties": {
+          "x": {
+            "type": "number",
+            "description": "x coordinate position"
+          },
+          "y": {
+            "type": "number",
+            "description": "y coordinate position"
+          },
+          "z": {
+            "type": "number",
+            "description": "z coordinate position"
+          }
+        }
+      },
+      "description": "Points along the line"
+    },
+    "color": {
+      "title": "foxglove.Color",
+      "description": "Solid color to use for the whole line. One of `color` or `colors` must be provided.",
+      "type": "object",
+      "properties": {
+        "r": {
+          "type": "number",
+          "description": "Red value between 0 and 1"
+        },
+        "g": {
+          "type": "number",
+          "description": "Green value between 0 and 1"
+        },
+        "b": {
+          "type": "number",
+          "description": "Blue value between 0 and 1"
+        },
+        "a": {
+          "type": "number",
+          "description": "Alpha value between 0 and 1"
+        }
+      }
+    },
+    "colors": {
+      "type": "array",
+      "items": {
+        "title": "foxglove.Color",
+        "description": "A color in RGBA format",
+        "type": "object",
+        "properties": {
+          "r": {
+            "type": "number",
+            "description": "Red value between 0 and 1"
+          },
+          "g": {
+            "type": "number",
+            "description": "Green value between 0 and 1"
+          },
+          "b": {
+            "type": "number",
+            "description": "Blue value between 0 and 1"
+          },
+          "a": {
+            "type": "number",
+            "description": "Alpha value between 0 and 1"
+          }
+        }
+      },
+      "description": "Per-point colors (if specified, must have the same length as `points`). One of `color` or `colors` must be provided."
+    },
+    "indices": {
+      "type": "array",
+      "items": {
+        "type": "integer",
+        "minimum": 0
+      },
+      "description": "Indices into the `points` and `colors` attribute arrays, which can be used to avoid duplicating attribute data.\n\nIf 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)."
+    }
+  }
+}

package/schemas/jsonschema/LocationFix.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from LocationFix by @foxglove/schemas",
-  "title": "LocationFix",
+  "title": "foxglove.LocationFix",
   "description": "A navigation satellite fix for any Global Navigation Satellite System",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "latitude": {
@@ -26,7 +26,7 @@
       "description": "Position covariance (m^2) defined relative to a tangential plane through the reported position. The components are East, North, and Up (ENU), in row-major order."
     },
     "position_covariance_type": {
-      "title": "PositionCovarianceType: Type of position covariance",
+      "title": "foxglove.PositionCovarianceType",
       "description": "If `position_covariance` is available, `position_covariance_type` must be set to indicate the type of covariance.",
       "oneOf": [
         {

package/schemas/jsonschema/Log.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from Log by @foxglove/schemas",
-  "title": "Log",
+  "title": "foxglove.Log",
   "description": "A log message",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "timestamp": {
@@ -21,7 +21,7 @@
       "description": "Timestamp of log message"
     },
     "level": {
-      "title": "LogLevel: Log level",
+      "title": "foxglove.LogLevel",
       "description": "Log level",
       "oneOf": [
         {

package/schemas/jsonschema/ModelPrimitive.json

@@ -0,0 +1,116 @@
+{
+  "title": "foxglove.ModelPrimitive",
+  "description": "(Experimental, subject to change) A primitive representing a 3D model file loaded from an external URL or embedded data",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
+  "type": "object",
+  "properties": {
+    "pose": {
+      "title": "foxglove.Pose",
+      "description": "Origin of model relative to reference frame",
+      "type": "object",
+      "properties": {
+        "position": {
+          "title": "foxglove.Vector3",
+          "description": "Point denoting position in 3D space",
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number",
+              "description": "x coordinate length"
+            },
+            "y": {
+              "type": "number",
+              "description": "y coordinate length"
+            },
+            "z": {
+              "type": "number",
+              "description": "z coordinate length"
+            }
+          }
+        },
+        "orientation": {
+          "title": "foxglove.Quaternion",
+          "description": "Quaternion denoting orientation in 3D space",
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number",
+              "description": "x value"
+            },
+            "y": {
+              "type": "number",
+              "description": "y value"
+            },
+            "z": {
+              "type": "number",
+              "description": "z value"
+            },
+            "w": {
+              "type": "number",
+              "description": "w value"
+            }
+          }
+        }
+      }
+    },
+    "scale": {
+      "title": "foxglove.Vector3",
+      "description": "Scale factor to apply to the model along each axis",
+      "type": "object",
+      "properties": {
+        "x": {
+          "type": "number",
+          "description": "x coordinate length"
+        },
+        "y": {
+          "type": "number",
+          "description": "y coordinate length"
+        },
+        "z": {
+          "type": "number",
+          "description": "z coordinate length"
+        }
+      }
+    },
+    "color": {
+      "title": "foxglove.Color",
+      "description": "Solid color to use for the whole model if `override_color` is true.",
+      "type": "object",
+      "properties": {
+        "r": {
+          "type": "number",
+          "description": "Red value between 0 and 1"
+        },
+        "g": {
+          "type": "number",
+          "description": "Green value between 0 and 1"
+        },
+        "b": {
+          "type": "number",
+          "description": "Blue value between 0 and 1"
+        },
+        "a": {
+          "type": "number",
+          "description": "Alpha value between 0 and 1"
+        }
+      }
+    },
+    "override_color": {
+      "type": "boolean",
+      "description": "Whether to use the color specified in `color` instead of any materials embedded in the original model."
+    },
+    "url": {
+      "type": "string",
+      "description": "URL pointing to model file. One of `url` or `data` should be provided."
+    },
+    "media_type": {
+      "type": "string",
+      "description": "[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."
+    },
+    "data": {
+      "type": "string",
+      "contentEncoding": "base64",
+      "description": "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."
+    }
+  }
+}

package/schemas/jsonschema/PackedElementField.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from PackedElementField by @foxglove/schemas",
-  "title": "PackedElementField",
+  "title": "foxglove.PackedElementField",
   "description": "A field present within each element in a byte array of packed elements.",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "name": {
@@ -14,7 +14,7 @@
       "description": "Byte offset from start of data buffer"
     },
     "type": {
-      "title": "NumericType: Numeric type",
+      "title": "foxglove.NumericType",
       "description": "Type of data in the field. Integers are stored using little-endian byte order.",
       "oneOf": [
         {

package/schemas/jsonschema/Point2.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from Point2 by @foxglove/schemas",
-  "title": "Point2",
+  "title": "foxglove.Point2",
   "description": "A point representing a position in 2D space",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "x": {

package/schemas/jsonschema/Point3.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from Point3 by @foxglove/schemas",
-  "title": "Point3",
+  "title": "foxglove.Point3",
   "description": "A point representing a position in 3D space",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "x": {

package/schemas/jsonschema/PointCloud.json

@@ -1,7 +1,7 @@
 {
-  "$comment": "Generated from PointCloud by @foxglove/schemas",
-  "title": "PointCloud",
+  "title": "foxglove.PointCloud",
   "description": "A collection of N-dimensional points, which may contain additional fields with information like normals, intensity, etc.",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
   "type": "object",
   "properties": {
     "timestamp": {
@@ -25,14 +25,12 @@
       "description": "Frame of reference"
     },
     "pose": {
-      "$comment": "Generated from Pose by @foxglove/schemas",
-      "title": "Pose",
+      "title": "foxglove.Pose",
       "description": "The origin of the point cloud relative to the frame of reference",
       "type": "object",
       "properties": {
         "position": {
-          "$comment": "Generated from Vector3 by @foxglove/schemas",
-          "title": "Vector3",
+          "title": "foxglove.Vector3",
           "description": "Point denoting position in 3D space",
           "type": "object",
           "properties": {
@@ -51,8 +49,7 @@
           }
         },
         "orientation": {
-          "$comment": "Generated from Quaternion by @foxglove/schemas",
-          "title": "Quaternion",
+          "title": "foxglove.Quaternion",
           "description": "Quaternion denoting orientation in 3D space",
           "type": "object",
           "properties": {
@@ -84,8 +81,7 @@
     "fields": {
       "type": "array",
       "items": {
-        "$comment": "Generated from PackedElementField by @foxglove/schemas",
-        "title": "PackedElementField",
+        "title": "foxglove.PackedElementField",
         "description": "A field present within each element in a byte array of packed elements.",
         "type": "object",
         "properties": {
@@ -99,7 +95,7 @@
             "description": "Byte offset from start of data buffer"
           },
           "type": {
-            "title": "NumericType: Numeric type",
+            "title": "foxglove.NumericType",
             "description": "Type of data in the field. Integers are stored using little-endian byte order.",
             "oneOf": [
               {