data overlays

src/c3nav/mapdata/models/overlay.py

@@ -0,0 +1,84 @@
+from typing import Optional
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from django_pydantic_field import SchemaField
+
+from c3nav.mapdata.fields import GeometryField
+from c3nav.mapdata.models.base import TitledMixin
+from c3nav.mapdata.models.geometry.base import GeometryMixin
+from c3nav.mapdata.utils.geometry import smart_mapping
+from c3nav.mapdata.utils.json import format_geojson
+
+
+class DataOverlay(TitledMixin, models.Model):
+    description = models.TextField(blank=True, verbose_name=_('Description'))
+    stroke_color = models.TextField(blank=True, null=True, verbose_name=_('default stroke color'))
+    stroke_width = models.FloatField(blank=True, null=True, verbose_name=_('default stroke width'))
+    fill_color = models.TextField(blank=True, null=True, verbose_name=_('default fill color'))
+    pull_url = models.URLField(blank=True, null=True, verbose_name=_('pull URL'))
+    pull_headers: dict[str, str] = SchemaField(schema=dict[str, str], null=True,
+                                               verbose_name=_('headers for pull http request (JSON object)'))
+    pull_interval = models.DurationField(blank=True, null=True, verbose_name=_('pull interval'))
+
+
+    class Meta:
+        verbose_name = _('Data Overlay')
+        verbose_name_plural = _('Data Overlays')
+        default_related_name = 'data_overlays'
+
+class DataOverlayFeature(TitledMixin, GeometryMixin, models.Model):
+    overlay = models.ForeignKey('mapdata.DataOverlay', on_delete=models.CASCADE, verbose_name=_('Overlay'), related_name='features')
+    geometry = GeometryField()
+    level = models.ForeignKey('mapdata.Level', on_delete=models.CASCADE, verbose_name=_('level'), related_name='data_overlay_features')
+    external_url = models.URLField(blank=True, null=True, verbose_name=_('external URL'))
+    stroke_color = models.CharField(max_length=255, blank=True, null=True, verbose_name=_('stroke color'))
+    stroke_width = models.FloatField(blank=True, null=True, verbose_name=_('stroke width'))
+    fill_color = models.CharField(max_length=255, blank=True, null=True, verbose_name=_('fill color'))
+    show_label = models.BooleanField(default=False, verbose_name=_('show label'))
+    show_geometry = models.BooleanField(default=True, verbose_name=_('show geometry'))
+    interactive = models.BooleanField(default=True, verbose_name=_('interactive'),
+                                      help_text=_('disable to make this feature click-through'))
+    point_icon = models.CharField(max_length=255, blank=True, null=True, verbose_name=_('point icon'),
+                                  help_text=_(
+                                      'use this material icon to display points, instead of drawing a small circle (only makes sense if the geometry is a point)'))
+    extra_data: Optional[dict[str, str]] = SchemaField(schema=dict[str, str], blank=True, null=True, default=None,
+                                             verbose_name=_('extra data (JSON object)'))
+
+
+    def to_geojson(self, instance=None) -> dict:
+        result = {
+            'type': 'Feature',
+            'properties': {
+                'type': 'dataoverlayfeature',
+                'id': self.id,
+                'level': self.level_id,
+                'overlay': self.overlay_id,
+            },
+            'geometry': format_geojson(smart_mapping(self.geometry), rounded=False),
+        }
+        original_geometry = getattr(self, 'original_geometry', None)
+        if original_geometry:
+            result['original_geometry'] = format_geojson(smart_mapping(original_geometry), rounded=False)
+        return result
+
+    def get_geojson_key(self):
+        return 'dataoverlayfeature', self.id
+
+
+    def _serialize(self, **kwargs):
+        result = super()._serialize(**kwargs)
+        result.update({
+            'level_id': self.level_id,
+            'stroke_color': self.stroke_color,
+            'stroke_width': self.stroke_width,
+            'fill_color': self.fill_color,
+            'show_label': self.show_label,
+            'show_geometry': self.show_geometry,
+            'interactive': self.interactive,
+            'point_icon': self.point_icon,
+            'external_url': self.external_url,
+            'extra_data': self.extra_data,
+        })
+        result['level_id'] = self.level_id
+        return result