Allow polygons with holes to be specified.

girder_annotation/docs/annotations.rst

@@ -126,6 +126,17 @@ When closed, this is a polygon. When open, this is a continuous line.
       [56,-45,6]
     ],
     "closed": true,                    # Boolean.  Default is false.  Optional
+    "holes": [                         # Only used if closed is true.  A list of a list of
+                                       # coordinates.  Each list of coordinates is a
+                                       # separate hole within the main polygon, and is expected
+                                       # to be contained within it and not cross the main
+                                       # polygon or other holes.
+      [
+        [10,10,0],
+        [20,30,0],
+        [10,30,0]
+      ]
+    ],
     "fillColor": "rgba(0, 255, 0, 1)"  # String.  See note about colors.  Optional
   }
 

girder_annotation/girder_large_image_annotation/models/annotation.py

@@ -225,6 +225,19 @@ class AnnotationSchema:
                 'description': 'polyline is open if closed flag is '
                                'not specified'
             },
+            'holes': {
+                'type': 'array',
+                'description':
+                    'If closed is true, this is a list of polylines that are '
+                    'treated as holes in the base polygon. These should not '
+                    'cross each other and should be contained within the base '
+                    'polygon.',
+                'items': {
+                    'type': 'array',
+                    'items': coordSchema,
+                    'minItems': 3,
+                },
+            },
         },
         'required': ['type', 'points'],
         'additionalProperties': False
@@ -976,6 +989,15 @@ def _similarElementStructure(self, a, b, parentKey=None):  # noqa
                     if not self._similarElementStructure(a[k], b[k], k):
                         return False
         elif isinstance(a, list):
+            if parentKey == 'holes':
+                for hidx in range(len(b)):
+                    for idx in range(len(b[hidx])):
+                        if (len(b[hidx][idx]) != 3 or
+                                not isinstance(b[hidx][idx][0], self.numberInstance) or
+                                not isinstance(b[hidx][idx][1], self.numberInstance) or
+                                not isinstance(b[hidx][idx][2], self.numberInstance)):
+                            return False
+                return True
             if len(a) != len(b):
                 if parentKey not in {'points', 'values'} or len(a) < 2 or len(b) < 2:
                     return False

girder_annotation/girder_large_image_annotation/web_client/annotations/geometry/polyline.js

@@ -7,9 +7,17 @@ export default function polyline(json) {
     var annotationType;
 
     if (json.closed) {
-        type = 'Polygon';
         points.push(points[0]);
         coordinates = [points];
+        if (json.holes) {
+            const holes = (json.holes || []).map((hole) => {
+                let result = hole.map((p) => _.first(p, 2));
+                result.push(result[0]);
+                return result;
+            });
+            coordinates = coordinates.concat(holes);
+        }
+        type = 'Polygon';
         annotationType = 'polygon';
     } else {
         type = 'LineString';