@foxglove/schemas 0.8.1 → 1.0.0

package/schemas/jsonschema/index.ts

@@ -937,19 +937,23 @@ export const ImageAnnotations = {
               },
               {
                 "title": "POINTS",
-                "const": 1
+                "const": 1,
+                "description": "Individual points: 0, 1, 2, ..."
               },
               {
                 "title": "LINE_LOOP",
-                "const": 2
+                "const": 2,
+                "description": "Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0"
               },
               {
                 "title": "LINE_STRIP",
-                "const": 3
+                "const": 3,
+                "description": "Connected line segments: 0-1, 1-2, ..., (n-1)-n"
               },
               {
                 "title": "LINE_LIST",
-                "const": 4
+                "const": 4,
+                "description": "Individual line segments: 0-1, 2-3, 4-5, ..."
               }
             ]
           },
@@ -1186,17 +1190,17 @@ export const LinePrimitive = {
         {
           "title": "LINE_STRIP",
           "const": 0,
-          "description": "0-1, 1-2, ..., (n-1)-n"
+          "description": "Connected line segments: 0-1, 1-2, ..., (n-1)-n"
         },
         {
           "title": "LINE_LOOP",
           "const": 1,
-          "description": "0-1, 1-2, ..., (n-1)-n, n-0"
+          "description": "Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0"
         },
         {
           "title": "LINE_LIST",
           "const": 2,
-          "description": "0-1, 2-3, 4-5, ..."
+          "description": "Individual line segments: 0-1, 2-3, 4-5, ..."
         }
       ]
     },
@@ -2005,17 +2009,17 @@ export const SceneEntity = {
               {
                 "title": "LINE_STRIP",
                 "const": 0,
-                "description": "0-1, 1-2, ..., (n-1)-n"
+                "description": "Connected line segments: 0-1, 1-2, ..., (n-1)-n"
               },
               {
                 "title": "LINE_LOOP",
                 "const": 1,
-                "description": "0-1, 1-2, ..., (n-1)-n, n-0"
+                "description": "Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0"
               },
               {
                 "title": "LINE_LIST",
                 "const": 2,
-                "description": "0-1, 2-3, 4-5, ..."
+                "description": "Individual line segments: 0-1, 2-3, 4-5, ..."
               }
             ]
           },
@@ -3072,17 +3076,17 @@ export const SceneUpdate = {
                     {
                       "title": "LINE_STRIP",
                       "const": 0,
-                      "description": "0-1, 1-2, ..., (n-1)-n"
+                      "description": "Connected line segments: 0-1, 1-2, ..., (n-1)-n"
                     },
                     {
                       "title": "LINE_LOOP",
                       "const": 1,
-                      "description": "0-1, 1-2, ..., (n-1)-n, n-0"
+                      "description": "Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0"
                     },
                     {
                       "title": "LINE_LIST",
                       "const": 2,
-                      "description": "0-1, 2-3, 4-5, ..."
+                      "description": "Individual line segments: 0-1, 2-3, 4-5, ..."
                     }
                   ]
                 },
@@ -3991,19 +3995,23 @@ export const PointsAnnotation = {
         },
         {
           "title": "POINTS",
-          "const": 1
+          "const": 1,
+          "description": "Individual points: 0, 1, 2, ..."
         },
         {
           "title": "LINE_LOOP",
-          "const": 2
+          "const": 2,
+          "description": "Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0"
         },
         {
           "title": "LINE_STRIP",
-          "const": 3
+          "const": 3,
+          "description": "Connected line segments: 0-1, 1-2, ..., (n-1)-n"
         },
         {
           "title": "LINE_LIST",
-          "const": 4
+          "const": 4,
+          "description": "Individual line segments: 0-1, 2-3, 4-5, ..."
         }
       ]
     },

package/schemas/proto/foxglove/LinePrimitive.proto

@@ -12,13 +12,13 @@ package foxglove;
 message LinePrimitive {
   // An enumeration indicating how input points should be interpreted to create lines
   enum Type {
-    // 0-1, 1-2, ..., (n-1)-n
+    // Connected line segments: 0-1, 1-2, ..., (n-1)-n
     LINE_STRIP = 0;
 
-    // 0-1, 1-2, ..., (n-1)-n, n-0
+    // Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0
     LINE_LOOP = 1;
 
-    // 0-1, 2-3, 4-5, ...
+    // Individual line segments: 0-1, 2-3, 4-5, ...
     LINE_LIST = 2;
   }
   // Drawing primitive to use for lines

package/schemas/proto/foxglove/PointsAnnotation.proto

@@ -14,12 +14,16 @@ message PointsAnnotation {
   enum Type {
     UNKNOWN = 0;
 
+    // Individual points: 0, 1, 2, ...
     POINTS = 1;
 
+    // Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0
     LINE_LOOP = 2;
 
+    // Connected line segments: 0-1, 1-2, ..., (n-1)-n
     LINE_STRIP = 3;
 
+    // Individual line segments: 0-1, 2-3, 4-5, ...
     LINE_LIST = 4;
   }
   // Timestamp of annotation

package/schemas/ros1/LinePrimitive.msg

@@ -3,13 +3,13 @@
 
 # Generated by https://github.com/foxglove/schemas
 
-# 0-1, 1-2, ..., (n-1)-n
+# Connected line segments: 0-1, 1-2, ..., (n-1)-n
 uint8 LINE_STRIP=0
 
-# 0-1, 1-2, ..., (n-1)-n, n-0
+# Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0
 uint8 LINE_LOOP=1
 
-# 0-1, 2-3, 4-5, ...
+# Individual line segments: 0-1, 2-3, 4-5, ...
 uint8 LINE_LIST=2
 
 # Drawing primitive to use for lines

package/schemas/ros1/PointsAnnotation.msg

@@ -7,9 +7,17 @@
 time timestamp
 
 uint8 UNKNOWN=0
+
+# Individual points: 0, 1, 2, ...
 uint8 POINTS=1
+
+# Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0
 uint8 LINE_LOOP=2
+
+# Connected line segments: 0-1, 1-2, ..., (n-1)-n
 uint8 LINE_STRIP=3
+
+# Individual line segments: 0-1, 2-3, 4-5, ...
 uint8 LINE_LIST=4
 
 # Type of points annotation to draw

package/schemas/ros2/LinePrimitive.msg

@@ -3,13 +3,13 @@
 
 # Generated by https://github.com/foxglove/schemas
 
-# 0-1, 1-2, ..., (n-1)-n
+# Connected line segments: 0-1, 1-2, ..., (n-1)-n
 uint8 LINE_STRIP=0
 
-# 0-1, 1-2, ..., (n-1)-n, n-0
+# Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0
 uint8 LINE_LOOP=1
 
-# 0-1, 2-3, 4-5, ...
+# Individual line segments: 0-1, 2-3, 4-5, ...
 uint8 LINE_LIST=2
 
 # Drawing primitive to use for lines

package/schemas/ros2/PointsAnnotation.msg

@@ -7,9 +7,17 @@
 builtin_interfaces/Time timestamp
 
 uint8 UNKNOWN=0
+
+# Individual points: 0, 1, 2, ...
 uint8 POINTS=1
+
+# Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0
 uint8 LINE_LOOP=2
+
+# Connected line segments: 0-1, 1-2, ..., (n-1)-n
 uint8 LINE_STRIP=3
+
+# Individual line segments: 0-1, 2-3, 4-5, ...
 uint8 LINE_LIST=4
 
 # Type of points annotation to draw

package/schemas/typescript/LineType.d.ts

@@ -1,10 +1,10 @@
 /** An enumeration indicating how input points should be interpreted to create lines */
 export declare enum LineType {
-    /** 0-1, 1-2, ..., (n-1)-n */
+    /** Connected line segments: 0-1, 1-2, ..., (n-1)-n */
     LINE_STRIP = 0,
-    /** 0-1, 1-2, ..., (n-1)-n, n-0 */
+    /** Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0 */
     LINE_LOOP = 1,
-    /** 0-1, 2-3, 4-5, ... */
+    /** Individual line segments: 0-1, 2-3, 4-5, ... */
     LINE_LIST = 2
 }
 //# sourceMappingURL=LineType.d.ts.map

package/schemas/typescript/LineType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LineType.d.ts","sourceRoot":"","sources":["LineType.ts"],"names":[],"mappings":"AAEA,uFAAuF;AACvF,oBAAY,QAAQ;IAClB,6BAA6B;IAC7B,UAAU,IAAI;IAEd,kCAAkC;IAClC,SAAS,IAAI;IAEb,yBAAyB;IACzB,SAAS,IAAI;CACd"}
+{"version":3,"file":"LineType.d.ts","sourceRoot":"","sources":["LineType.ts"],"names":[],"mappings":"AAEA,uFAAuF;AACvF,oBAAY,QAAQ;IAClB,sDAAsD;IACtD,UAAU,IAAI;IAEd,kDAAkD;IAClD,SAAS,IAAI;IAEb,mDAAmD;IACnD,SAAS,IAAI;CACd"}

package/schemas/typescript/LineType.js

@@ -5,11 +5,11 @@ exports.LineType = void 0;
 /** An enumeration indicating how input points should be interpreted to create lines */
 var LineType;
 (function (LineType) {
-    /** 0-1, 1-2, ..., (n-1)-n */
+    /** Connected line segments: 0-1, 1-2, ..., (n-1)-n */
     LineType[LineType["LINE_STRIP"] = 0] = "LINE_STRIP";
-    /** 0-1, 1-2, ..., (n-1)-n, n-0 */
+    /** Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0 */
     LineType[LineType["LINE_LOOP"] = 1] = "LINE_LOOP";
-    /** 0-1, 2-3, 4-5, ... */
+    /** Individual line segments: 0-1, 2-3, 4-5, ... */
     LineType[LineType["LINE_LIST"] = 2] = "LINE_LIST";
 })(LineType = exports.LineType || (exports.LineType = {}));
 //# sourceMappingURL=LineType.js.map

package/schemas/typescript/LineType.js.map

@@ -1 +1 @@
-{"version":3,"file":"LineType.js","sourceRoot":"","sources":["LineType.ts"],"names":[],"mappings":";AAAA,mDAAmD;;;AAEnD,uFAAuF;AACvF,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,6BAA6B;IAC7B,mDAAc,CAAA;IAEd,kCAAkC;IAClC,iDAAa,CAAA;IAEb,yBAAyB;IACzB,iDAAa,CAAA;AACf,CAAC,EATW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QASnB"}
+{"version":3,"file":"LineType.js","sourceRoot":"","sources":["LineType.ts"],"names":[],"mappings":";AAAA,mDAAmD;;;AAEnD,uFAAuF;AACvF,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,sDAAsD;IACtD,mDAAc,CAAA;IAEd,kDAAkD;IAClD,iDAAa,CAAA;IAEb,mDAAmD;IACnD,iDAAa,CAAA;AACf,CAAC,EATW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QASnB"}

package/schemas/typescript/LineType.ts

@@ -2,12 +2,12 @@
 
 /** An enumeration indicating how input points should be interpreted to create lines */
 export enum LineType {
-  /** 0-1, 1-2, ..., (n-1)-n */
+  /** Connected line segments: 0-1, 1-2, ..., (n-1)-n */
   LINE_STRIP = 0,
 
-  /** 0-1, 1-2, ..., (n-1)-n, n-0 */
+  /** Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0 */
   LINE_LOOP = 1,
 
-  /** 0-1, 2-3, 4-5, ... */
+  /** Individual line segments: 0-1, 2-3, 4-5, ... */
   LINE_LIST = 2,
 }

package/schemas/typescript/PointsAnnotationType.d.ts

@@ -1,9 +1,13 @@
 /** Type of points annotation */
 export declare enum PointsAnnotationType {
     UNKNOWN = 0,
+    /** Individual points: 0, 1, 2, ... */
     POINTS = 1,
+    /** Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0 */
     LINE_LOOP = 2,
+    /** Connected line segments: 0-1, 1-2, ..., (n-1)-n */
     LINE_STRIP = 3,
+    /** Individual line segments: 0-1, 2-3, 4-5, ... */
     LINE_LIST = 4
 }
 //# sourceMappingURL=PointsAnnotationType.d.ts.map

package/schemas/typescript/PointsAnnotationType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PointsAnnotationType.d.ts","sourceRoot":"","sources":["PointsAnnotationType.ts"],"names":[],"mappings":"AAEA,gCAAgC;AAChC,oBAAY,oBAAoB;IAC9B,OAAO,IAAI;IAEX,MAAM,IAAI;IAEV,SAAS,IAAI;IAEb,UAAU,IAAI;IAEd,SAAS,IAAI;CACd"}
+{"version":3,"file":"PointsAnnotationType.d.ts","sourceRoot":"","sources":["PointsAnnotationType.ts"],"names":[],"mappings":"AAEA,gCAAgC;AAChC,oBAAY,oBAAoB;IAC9B,OAAO,IAAI;IAEX,sCAAsC;IACtC,MAAM,IAAI;IAEV,kDAAkD;IAClD,SAAS,IAAI;IAEb,sDAAsD;IACtD,UAAU,IAAI;IAEd,mDAAmD;IACnD,SAAS,IAAI;CACd"}

package/schemas/typescript/PointsAnnotationType.js

@@ -6,9 +6,13 @@ exports.PointsAnnotationType = void 0;
 var PointsAnnotationType;
 (function (PointsAnnotationType) {
     PointsAnnotationType[PointsAnnotationType["UNKNOWN"] = 0] = "UNKNOWN";
+    /** Individual points: 0, 1, 2, ... */
     PointsAnnotationType[PointsAnnotationType["POINTS"] = 1] = "POINTS";
+    /** Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0 */
     PointsAnnotationType[PointsAnnotationType["LINE_LOOP"] = 2] = "LINE_LOOP";
+    /** Connected line segments: 0-1, 1-2, ..., (n-1)-n */
     PointsAnnotationType[PointsAnnotationType["LINE_STRIP"] = 3] = "LINE_STRIP";
+    /** Individual line segments: 0-1, 2-3, 4-5, ... */
     PointsAnnotationType[PointsAnnotationType["LINE_LIST"] = 4] = "LINE_LIST";
 })(PointsAnnotationType = exports.PointsAnnotationType || (exports.PointsAnnotationType = {}));
 //# sourceMappingURL=PointsAnnotationType.js.map

package/schemas/typescript/PointsAnnotationType.js.map

@@ -1 +1 @@
-{"version":3,"file":"PointsAnnotationType.js","sourceRoot":"","sources":["PointsAnnotationType.ts"],"names":[],"mappings":";AAAA,mDAAmD;;;AAEnD,gCAAgC;AAChC,IAAY,oBAUX;AAVD,WAAY,oBAAoB;IAC9B,qEAAW,CAAA;IAEX,mEAAU,CAAA;IAEV,yEAAa,CAAA;IAEb,2EAAc,CAAA;IAEd,yEAAa,CAAA;AACf,CAAC,EAVW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAU/B"}
+{"version":3,"file":"PointsAnnotationType.js","sourceRoot":"","sources":["PointsAnnotationType.ts"],"names":[],"mappings":";AAAA,mDAAmD;;;AAEnD,gCAAgC;AAChC,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC9B,qEAAW,CAAA;IAEX,sCAAsC;IACtC,mEAAU,CAAA;IAEV,kDAAkD;IAClD,yEAAa,CAAA;IAEb,sDAAsD;IACtD,2EAAc,CAAA;IAEd,mDAAmD;IACnD,yEAAa,CAAA;AACf,CAAC,EAdW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAc/B"}

package/schemas/typescript/PointsAnnotationType.ts

@@ -4,11 +4,15 @@
 export enum PointsAnnotationType {
   UNKNOWN = 0,
 
+  /** Individual points: 0, 1, 2, ... */
   POINTS = 1,
 
+  /** Closed polygon: 0-1, 1-2, ..., (n-1)-n, n-0 */
   LINE_LOOP = 2,
 
+  /** Connected line segments: 0-1, 1-2, ..., (n-1)-n */
   LINE_STRIP = 3,
 
+  /** Individual line segments: 0-1, 2-3, 4-5, ... */
   LINE_LIST = 4,
 }