@foxglove/schemas 1.6.2 → 1.6.3

package/schemas/flatbuffer/TextAnnotation.fbs

@@ -9,22 +9,23 @@ namespace foxglove;
 /// A text label on a 2D image
 table TextAnnotation {
   /// Timestamp of annotation
-  timestamp:Time;
+  timestamp:Time (id: 0);
 
-  /// Bottom-left origin of the text label in 2D image coordinates (pixels)
-  position:foxglove.Point2;
+  /// Bottom-left origin of the text label in 2D image coordinates (pixels).
+  /// The coordinate uses the top-left corner of the top-left pixel of the image as the origin.
+  position:foxglove.Point2 (id: 1);
 
   /// Text to display
-  text:string;
+  text:string (id: 2);
 
   /// Font size in pixels
-  font_size:double = 12.0;
+  font_size:double = 12.0 (id: 3);
 
   /// Text color
-  text_color:foxglove.Color;
+  text_color:foxglove.Color (id: 4);
 
   /// Background fill color
-  background_color:foxglove.Color;
+  background_color:foxglove.Color (id: 5);
 }
 
 root_type TextAnnotation;

package/schemas/flatbuffer/TextPrimitive.fbs

@@ -8,22 +8,22 @@ namespace foxglove;
 /// A primitive representing a text label
 table 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.
-  pose:foxglove.Pose;
+  pose:foxglove.Pose (id: 0);
 
   /// Whether the text should respect `pose.orientation` (false) or always face the camera (true)
-  billboard:bool;
+  billboard:bool (id: 1);
 
   /// Font size (height of one line of text)
-  font_size:double;
+  font_size:double (id: 2);
 
   /// 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)
-  scale_invariant:bool;
+  scale_invariant:bool (id: 3);
 
   /// Color of the text
-  color:foxglove.Color;
+  color:foxglove.Color (id: 4);
 
   /// Text
-  text:string;
+  text:string (id: 5);
 }
 
 root_type TextPrimitive;

package/schemas/flatbuffer/TriangleListPrimitive.fbs

@@ -9,21 +9,21 @@ namespace foxglove;
 /// A primitive representing a set of triangles or a surface tiled by triangles
 table TriangleListPrimitive {
   /// Origin of triangles relative to reference frame
-  pose:foxglove.Pose;
+  pose:foxglove.Pose (id: 0);
 
   /// Vertices to use for triangles, interpreted as a list of triples (0-1-2, 3-4-5, ...)
-  points:[foxglove.Point3];
+  points:[foxglove.Point3] (id: 1);
 
   /// Solid color to use for the whole shape. One of `color` or `colors` must be provided.
-  color:foxglove.Color;
+  color:foxglove.Color (id: 2);
 
   /// Per-vertex colors (if specified, must have the same length as `points`). One of `color` or `colors` must be provided.
-  colors:[foxglove.Color];
+  colors:[foxglove.Color] (id: 3);
 
   /// 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).
-  indices:[uint32];
+  indices:[uint32] (id: 4);
 }
 
 root_type TriangleListPrimitive;

package/schemas/flatbuffer/Vector2.fbs

@@ -5,10 +5,10 @@ namespace foxglove;
 /// A vector in 2D space that represents a direction only
 table Vector2 {
   /// x coordinate length
-  x:double = 1.0;
+  x:double = 1.0 (id: 0);
 
   /// y coordinate length
-  y:double = 1.0;
+  y:double = 1.0 (id: 1);
 }
 
 root_type Vector2;

package/schemas/flatbuffer/Vector3.fbs

@@ -5,13 +5,13 @@ namespace foxglove;
 /// A vector in 3D space that represents a direction only
 table Vector3 {
   /// x coordinate length
-  x:double = 1.0;
+  x:double = 1.0 (id: 0);
 
   /// y coordinate length
-  y:double = 1.0;
+  y:double = 1.0 (id: 1);
 
   /// z coordinate length
-  z:double = 1.0;
+  z:double = 1.0 (id: 2);
 }
 
 root_type Vector3;

package/schemas/jsonschema/CameraCalibration.json

@@ -36,7 +36,7 @@
     },
     "distortion_model": {
       "type": "string",
-      "description": "Name of distortion model\n\nSupported values: `plumb_bob` and `rational_polynomial`"
+      "description": "Name of distortion model\n\nSupported parameters: `plumb_bob` (k1, k2, p1, p2, k3) and `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6). Distortion models are based on [OpenCV's](https://docs.opencv.org/2.4/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). This is the same [implementation used by ROS](http://docs.ros.org/en/diamondback/api/image_geometry/html/c++/pinhole__camera__model_8cpp_source.html)"
     },
     "D": {
       "type": "array",

package/schemas/jsonschema/CircleAnnotation.json

@@ -22,7 +22,7 @@
     },
     "position": {
       "title": "foxglove.Point2",
-      "description": "Center of the circle in 2D image coordinates (pixels)",
+      "description": "Center of the circle in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
       "type": "object",
       "properties": {
         "x": {

package/schemas/jsonschema/CompressedVideo.json

@@ -27,7 +27,7 @@
     "data": {
       "type": "string",
       "contentEncoding": "base64",
-      "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead."
+      "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead."
     },
     "format": {
       "type": "string",

package/schemas/jsonschema/ImageAnnotations.json

@@ -29,7 +29,7 @@
           },
           "position": {
             "title": "foxglove.Point2",
-            "description": "Center of the circle in 2D image coordinates (pixels)",
+            "description": "Center of the circle in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
             "type": "object",
             "properties": {
               "x": {
@@ -170,7 +170,7 @@
                 }
               }
             },
-            "description": "Points in 2D image coordinates (pixels)"
+            "description": "Points in 2D image coordinates (pixels).\nThese coordinates use the top-left corner of the top-left pixel of the image as the origin."
           },
           "outline_color": {
             "title": "foxglove.Color",
@@ -278,7 +278,7 @@
           },
           "position": {
             "title": "foxglove.Point2",
-            "description": "Bottom-left origin of the text label in 2D image coordinates (pixels)",
+            "description": "Bottom-left origin of the text label in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
             "type": "object",
             "properties": {
               "x": {

package/schemas/jsonschema/PointsAnnotation.json

@@ -67,7 +67,7 @@
           }
         }
       },
-      "description": "Points in 2D image coordinates (pixels)"
+      "description": "Points in 2D image coordinates (pixels).\nThese coordinates use the top-left corner of the top-left pixel of the image as the origin."
     },
     "outline_color": {
       "title": "foxglove.Color",

package/schemas/jsonschema/TextAnnotation.json

@@ -22,7 +22,7 @@
     },
     "position": {
       "title": "foxglove.Point2",
-      "description": "Bottom-left origin of the text label in 2D image coordinates (pixels)",
+      "description": "Bottom-left origin of the text label in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
       "type": "object",
       "properties": {
         "x": {

package/schemas/jsonschema/index.js

@@ -136,7 +136,7 @@ exports.CameraCalibration = {
         },
         "distortion_model": {
             "type": "string",
-            "description": "Name of distortion model\n\nSupported values: `plumb_bob` and `rational_polynomial`"
+            "description": "Name of distortion model\n\nSupported parameters: `plumb_bob` (k1, k2, p1, p2, k3) and `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6). Distortion models are based on [OpenCV's](https://docs.opencv.org/2.4/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). This is the same [implementation used by ROS](http://docs.ros.org/en/diamondback/api/image_geometry/html/c++/pinhole__camera__model_8cpp_source.html)"
         },
         "D": {
             "type": "array",
@@ -198,7 +198,7 @@ exports.CircleAnnotation = {
         },
         "position": {
             "title": "foxglove.Point2",
-            "description": "Center of the circle in 2D image coordinates (pixels)",
+            "description": "Center of the circle in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
             "type": "object",
             "properties": {
                 "x": {
@@ -357,7 +357,7 @@ exports.CompressedVideo = {
         "data": {
             "type": "string",
             "contentEncoding": "base64",
-            "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead."
+            "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead."
         },
         "format": {
             "type": "string",
@@ -947,7 +947,7 @@ exports.ImageAnnotations = {
                     },
                     "position": {
                         "title": "foxglove.Point2",
-                        "description": "Center of the circle in 2D image coordinates (pixels)",
+                        "description": "Center of the circle in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
                         "type": "object",
                         "properties": {
                             "x": {
@@ -1088,7 +1088,7 @@ exports.ImageAnnotations = {
                                 }
                             }
                         },
-                        "description": "Points in 2D image coordinates (pixels)"
+                        "description": "Points in 2D image coordinates (pixels).\nThese coordinates use the top-left corner of the top-left pixel of the image as the origin."
                     },
                     "outline_color": {
                         "title": "foxglove.Color",
@@ -1196,7 +1196,7 @@ exports.ImageAnnotations = {
                     },
                     "position": {
                         "title": "foxglove.Point2",
-                        "description": "Bottom-left origin of the text label in 2D image coordinates (pixels)",
+                        "description": "Bottom-left origin of the text label in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
                         "type": "object",
                         "properties": {
                             "x": {
@@ -4248,7 +4248,7 @@ exports.PointsAnnotation = {
                     }
                 }
             },
-            "description": "Points in 2D image coordinates (pixels)"
+            "description": "Points in 2D image coordinates (pixels).\nThese coordinates use the top-left corner of the top-left pixel of the image as the origin."
         },
         "outline_color": {
             "title": "foxglove.Color",
@@ -4736,7 +4736,7 @@ exports.TextAnnotation = {
         },
         "position": {
             "title": "foxglove.Point2",
-            "description": "Bottom-left origin of the text label in 2D image coordinates (pixels)",
+            "description": "Bottom-left origin of the text label in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
             "type": "object",
             "properties": {
                 "x": {