variable zstack options

tomvanmele · tomvanmele · commit 072f2006ccdd · 2021-10-12T08:10:18.000+02:00
diff --git a/src/compas/artists/primitiveartist.py b/src/compas/artists/primitiveartist.py
@@ -33,7 +33,7 @@ class PrimitiveArtist(Artist):
     default_color = (0, 0, 0)
 
     def __init__(self, primitive, color=None, **kwargs):
-        super(PrimitiveArtist, self).__init__(**kwargs)
+        super(PrimitiveArtist, self).__init__()
         self._primitive = None
         self._color = None
         self.primitive = primitive
diff --git a/src/compas_plotters/artists/circleartist.py b/src/compas_plotters/artists/circleartist.py
@@ -15,8 +15,6 @@
 class CircleArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS circles."""
 
-    zorder: int = 1000
-
     def __init__(self,
                  circle: Circle,
                  linewidth: float = 1.0,
@@ -25,6 +23,7 @@ def __init__(self,
                  edgecolor: Color = (0, 0, 0),
                  fill: bool = True,
                  alpha: float = 1.0,
+                 zorder: int = 1000,
                  **kwargs: Any):
 
         super().__init__(primitive=circle, **kwargs)
@@ -36,6 +35,7 @@ def __init__(self,
         self.edgecolor = edgecolor
         self.fill = fill
         self.alpha = alpha
+        self.zorder = zorder
 
     @property
     def circle(self):
diff --git a/src/compas_plotters/artists/ellipseartist.py b/src/compas_plotters/artists/ellipseartist.py
@@ -15,8 +15,6 @@
 class EllipseArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS ellipses."""
 
-    zorder: int = 1000
-
     def __init__(self,
                  ellipse: Ellipse,
                  linewidth: float = 1.0,
@@ -25,6 +23,7 @@ def __init__(self,
                  edgecolor: Color = (0, 0, 0),
                  fill: bool = True,
                  alpha: float = 1.0,
+                 zorder: int = 1000,
                  **kwargs: Any):
 
         super().__init__(primitive=ellipse, **kwargs)
@@ -36,6 +35,7 @@ def __init__(self,
         self.edgecolor = edgecolor
         self.fill = fill
         self.alpha = alpha
+        self.zorder = zorder
 
     @property
     def ellipse(self):
diff --git a/src/compas_plotters/artists/lineartist.py b/src/compas_plotters/artists/lineartist.py
@@ -16,15 +16,14 @@
 class LineArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS lines."""
 
-    zorder: int = 1000
-
     def __init__(self,
                  line: Line,
                  draw_points: bool = False,
                  draw_as_segment: bool = False,
                  linewidth: float = 1.0,
                  linestyle: Literal['solid', 'dotted', 'dashed', 'dashdot'] = 'solid',
                  color: Color = (0, 0, 0),
+                 zorder: int = 1000,
                  **kwargs: Any):
 
         super().__init__(primitive=line, **kwargs)
@@ -38,6 +37,7 @@ def __init__(self,
         self.linewidth = linewidth
         self.linestyle = linestyle
         self.color = color
+        self.zorder = zorder
 
     @property
     def line(self):
diff --git a/src/compas_plotters/artists/meshartist.py b/src/compas_plotters/artists/meshartist.py
@@ -59,10 +59,6 @@ class MeshArtist(PlotterArtist, MeshArtist):
     zorder_faces : int
     """
 
-    zorder_faces: int = 1000
-    zorder_edges: int = 2000
-    zorder_vertices: int = 3000
-
     def __init__(self,
                  mesh: Mesh,
                  vertices: Optional[List[int]] = None,
@@ -77,6 +73,7 @@ def __init__(self,
                  show_faces: bool = True,
                  vertexsize: int = 5,
                  sizepolicy: Literal['relative', 'absolute'] = 'relative',
+                 zorder: int = 1000,
                  **kwargs: Any):
 
         super().__init__(mesh=mesh, **kwargs)
@@ -94,6 +91,7 @@ def __init__(self,
         self.show_vertices = show_vertices
         self.show_edges = show_edges
         self.show_faces = show_faces
+        self.zorder = zorder
 
     @property
     def vertex_size(self):
@@ -111,6 +109,18 @@ def vertex_size(self, vertexsize):
         elif isinstance(vertexsize, (int, float)):
             self._vertex_size = {vertex: vertexsize / factor for vertex in self.mesh.vertices()}
 
+    @property
+    def zorder_faces(self):
+        return self.zorder + 10
+
+    @property
+    def zorder_edges(self):
+        return self.zorder + 20
+
+    @property
+    def zorder_vertices(self):
+        return self.zorder + 30
+
     @property
     def item(self):
         """Mesh: Alias for ``~MeshArtist.mesh``"""
diff --git a/src/compas_plotters/artists/networkartist.py b/src/compas_plotters/artists/networkartist.py
@@ -53,9 +53,6 @@ class NetworkArtist(PlotterArtist):
     zorder_edges : int
     """
 
-    zorder_edges: int = 2000
-    zorder_nodes: int = 3000
-
     def __init__(self,
                  network: Network,
                  nodes: Optional[List[int]] = None,
@@ -67,6 +64,7 @@ def __init__(self,
                  show_edges: bool = True,
                  nodesize: int = 5,
                  sizepolicy: Literal['relative', 'absolute'] = 'relative',
+                 zorder: int = 2000,
                  **kwargs):
 
         super().__init__(network=network, **kwargs)
@@ -79,8 +77,16 @@ def __init__(self,
         self.edge_width = edgewidth
         self.show_nodes = show_nodes
         self.show_edges = show_edges
-
         self.sizepolicy = sizepolicy
+        self.zorder = zorder
+
+    @property
+    def zorder_edges(self):
+        return self.zorder
+
+    @property
+    def zorder_nodes(self):
+        return self.zorder + 10
 
     @property
     def item(self):
diff --git a/src/compas_plotters/artists/pointartist.py b/src/compas_plotters/artists/pointartist.py
@@ -15,13 +15,12 @@
 class PointArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS points."""
 
-    zorder: int = 9000
-
     def __init__(self,
                  point: Point,
                  size: int = 5,
                  facecolor: Color = (1.0, 1.0, 1.0),
                  edgecolor: Color = (0, 0, 0),
+                 zorder: int = 9000,
                  **kwargs: Any):
 
         super().__init__(primitive=point, **kwargs)
@@ -31,6 +30,7 @@ def __init__(self,
         self.size = size
         self.facecolor = facecolor
         self.edgecolor = edgecolor
+        self.zorder = zorder
 
     @property
     def point(self):
diff --git a/src/compas_plotters/artists/polygonartist.py b/src/compas_plotters/artists/polygonartist.py
@@ -15,8 +15,6 @@
 class PolygonArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS polygons."""
 
-    zorder: int = 1000
-
     def __init__(self,
                  polygon: Polygon,
                  linewidth: float = 1.0,
@@ -25,6 +23,7 @@ def __init__(self,
                  edgecolor: Color = (0, 0, 0),
                  fill: bool = True,
                  alpha: float = 1.0,
+                 zorder: int = 1000,
                  **kwargs: Any):
 
         super().__init__(primitive=polygon, **kwargs)
@@ -36,6 +35,7 @@ def __init__(self,
         self.edgecolor = edgecolor
         self.fill = fill
         self.alpha = alpha
+        self.zorder = zorder
 
     @property
     def polygon(self):
diff --git a/src/compas_plotters/artists/polylineartist.py b/src/compas_plotters/artists/polylineartist.py
@@ -15,14 +15,13 @@
 class PolylineArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS polylines."""
 
-    zorder: int = 1000
-
     def __init__(self,
                  polyline: Polyline,
                  draw_points: bool = True,
                  linewidth: float = 1.0,
                  linestyle: Literal['solid', 'dotted', 'dashed', 'dashdot'] = 'solid',
                  color: Color = (0, 0, 0),
+                 zorder: int = 1000,
                  **kwargs: Any):
 
         super().__init__(primitive=polyline, **kwargs)
@@ -33,6 +32,7 @@ def __init__(self,
         self.linewidth = linewidth
         self.linestyle = linestyle
         self.color = color
+        self.zorder = zorder
 
     @property
     def polyline(self):
diff --git a/src/compas_plotters/artists/segmentartist.py b/src/compas_plotters/artists/segmentartist.py
@@ -15,14 +15,13 @@
 class SegmentArtist(PlotterArtist, PrimitiveArtist):
     """Artist for drawing COMPAS lines as segments."""
 
-    zorder: int = 2000
-
     def __init__(self,
                  line: Line,
                  draw_points: bool = False,
                  linewidth: float = 2.0,
                  linestyle: Literal['solid', 'dotted', 'dashed', 'dashdot'] = 'solid',
                  color: Color = (0.0, 0.0, 0.0),
+                 zorder: int = 2000,
                  **kwargs: Any):
 
         super().__init__(primitive=line, **kwargs)
@@ -34,6 +33,7 @@ def __init__(self,
         self.linestyle = linestyle
         self.linewidth = linewidth
         self.color = color
+        self.zorder = zorder
 
     @property
     def line(self):
diff --git a/src/compas_plotters/artists/vectorartist.py b/src/compas_plotters/artists/vectorartist.py
@@ -16,13 +16,12 @@
 class VectorArtist(PlotterArtist, PrimitiveArtist):
     """Artist for COMPAS vectors."""
 
-    zorder: int = 3000
-
     def __init__(self,
                  vector: Vector,
                  point: Optional[Point] = None,
                  draw_point: bool = False,
                  color: Color = (0, 0, 0),
+                 zorder: int = 3000,
                  **kwargs: Any):
 
         super().__init__(primitive=vector, **kwargs)
@@ -32,6 +31,7 @@ def __init__(self,
         self.draw_point = draw_point
         self.point = point or Point(0.0, 0.0, 0.0)
         self.color = color
+        self.zorder = zorder
 
     @property
     def vector(self):
@@ -46,7 +46,7 @@ def data(self) -> List[List[float]]:
         return [self.point[:2], (self.point + self.vector)[:2]]
 
     def draw(self) -> None:
-        style = ArrowStyle("Simple, head_length=.1, head_width=.1, tail_width=.02")
+        style = ArrowStyle("Simple, head_length=0.1, head_width=0.1, tail_width=0.02")
         arrow = FancyArrowPatch(self.point[:2], (self.point + self.vector)[:2],
                                 arrowstyle=style,
                                 edgecolor=self.color,
diff --git a/src/compas_plotters/plotter.py b/src/compas_plotters/plotter.py
@@ -1,5 +1,6 @@
 import os
 from typing import Callable, Optional, Tuple, List, Union
+from typing_extensions import Literal
 import matplotlib
 import matplotlib.pyplot as plt
 import tempfile
@@ -37,7 +38,8 @@ def __init__(self,
                  figsize: Tuple[float, float] = (8.0, 5.0),
                  dpi: float = 100,
                  bgcolor: Tuple[float, float, float] = (1.0, 1.0, 1.0),
-                 show_axes: bool = False):
+                 show_axes: bool = False,
+                 zstack: Literal['natural', 'zorder'] = 'zorder'):
         self._show_axes = show_axes
         self._bgcolor = None
         self._viewbox = None
@@ -47,6 +49,7 @@ def __init__(self,
         self.figsize = figsize
         self.dpi = dpi
         self.bgcolor = bgcolor
+        self.zstack = zstack
 
     @property
     def viewbox(self) -> Tuple[Tuple[float, float], Tuple[float, float]]:
@@ -259,7 +262,11 @@ def add(self,
         """Add a COMPAS geometry object or data structure to the plot.
         """
         if not artist:
-            artist = PlotterArtist(item, **kwargs)
+            if self.zstack == 'natural':
+                zorder = 1000 + len(self._artists) * 100
+                artist = PlotterArtist(item, zorder=zorder, **kwargs)
+            else:
+                artist = PlotterArtist(item, **kwargs)
         artist.draw()
         self._artists.append(artist)
         return artist
