@foxglove/schemas 0.3.0 → 0.6.0

package/schemas/jsonschema/ArrowPrimitive.json

@@ -0,0 +1,96 @@
+{
+  "title": "foxglove.ArrowPrimitive",
+  "description": "(Experimental, subject to change) A primitive representing an arrow",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
+  "type": "object",
+  "properties": {
+    "pose": {
+      "title": "foxglove.Pose",
+      "description": "Position of the arrow's tail and orientation of the arrow. Identity orientation means the arrow points in the +x direction.",
+      "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"
+            }
+          }
+        }
+      }
+    },
+    "shaft_length": {
+      "type": "number",
+      "description": "Length of the arrow shaft"
+    },
+    "shaft_diameter": {
+      "type": "number",
+      "description": "Diameter of the arrow shaft"
+    },
+    "head_length": {
+      "type": "number",
+      "description": "Length of the arrow head"
+    },
+    "head_diameter": {
+      "type": "number",
+      "description": "Diameter of the arrow head"
+    },
+    "color": {
+      "title": "foxglove.Color",
+      "description": "Color of the arrow",
+      "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"
+        }
+      }
+    }
+  }
+}

package/schemas/jsonschema/CameraCalibration.json

@@ -20,6 +20,10 @@
       },
       "description": "Timestamp of calibration data"
     },
+    "frame_id": {
+      "type": "string",
+      "description": "Frame of reference for the camera. The origin of the frame is the optical center of the camera. +x points to the right in the image, +y points down, and +z points into the plane of the image."
+    },
     "width": {
       "type": "integer",
       "minimum": 0,

package/schemas/jsonschema/CompressedImage.json

@@ -20,6 +20,10 @@
       },
       "description": "Timestamp of image"
     },
+    "frame_id": {
+      "type": "string",
+      "description": "Frame of reference for the image. The origin of the frame is the optical center of the camera. +x points to the right in the image, +y points down, and +z points into the plane of the image."
+    },
     "data": {
       "type": "string",
       "contentEncoding": "base64",

package/schemas/jsonschema/CubePrimitive.json

@@ -0,0 +1,99 @@
+{
+  "title": "foxglove.CubePrimitive",
+  "description": "(Experimental, subject to change) A primitive representing a cube or rectangular prism",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
+  "type": "object",
+  "properties": {
+    "pose": {
+      "title": "foxglove.Pose",
+      "description": "Position of the center of the cube and orientation of the cube",
+      "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"
+            }
+          }
+        }
+      }
+    },
+    "size": {
+      "title": "foxglove.Vector3",
+      "description": "Size of the cube 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": "Color of the arrow",
+      "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"
+        }
+      }
+    }
+  }
+}

package/schemas/jsonschema/CylinderPrimitive.json

@@ -0,0 +1,107 @@
+{
+  "title": "foxglove.CylinderPrimitive",
+  "description": "(Experimental, subject to change) A primitive representing a cylinder, elliptic cylinder, or truncated cone",
+  "$comment": "Generated by https://github.com/foxglove/schemas",
+  "type": "object",
+  "properties": {
+    "pose": {
+      "title": "foxglove.Pose",
+      "description": "Position of the center of the cylinder and orientation of the cylinder. The flat face(s) are perpendicular to the z-axis.",
+      "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"
+            }
+          }
+        }
+      }
+    },
+    "size": {
+      "title": "foxglove.Vector3",
+      "description": "Size of the cylinder's bounding box",
+      "type": "object",
+      "properties": {
+        "x": {
+          "type": "number",
+          "description": "x coordinate length"
+        },
+        "y": {
+          "type": "number",
+          "description": "y coordinate length"
+        },
+        "z": {
+          "type": "number",
+          "description": "z coordinate length"
+        }
+      }
+    },
+    "bottom_scale": {
+      "type": "number",
+      "description": "0-1, ratio of the diameter of the cylinder's bottom face (min z) to the bottom of the bounding box"
+    },
+    "top_scale": {
+      "type": "number",
+      "description": "0-1, ratio of the diameter of the cylinder's top face (max z) to the top of the bounding box"
+    },
+    "color": {
+      "title": "foxglove.Color",
+      "description": "Color of the cylinder",
+      "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"
+        }
+      }
+    }
+  }
+}

package/schemas/jsonschema/ImageAnnotations.json

@@ -168,6 +168,29 @@
             },
             "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": {
@@ -193,7 +216,7 @@
                 }
               }
             },
-            "description": "Outline colors"
+            "description": "Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`."
           },
           "fill_color": {
             "title": "foxglove.Color",
@@ -217,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/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/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."
+    }
+  }
+}