added PresentFeature to toggle graphic's presence in the scene

fastplotlib · kushalkolar · Dec 23, 2022 · Dec 19, 2022 · Dec 19, 2022 · Dec 19, 2022
commit 71037f0c00218a412e16e95ef34f9eecf19248c3
diff --git a/fastplotlib/graphics/_base.py b/fastplotlib/graphics/_base.py
@@ -4,7 +4,7 @@
 import pygfx

 from fastplotlib.utils import get_colors, map_labels_to_colors
-from ._graphic_attribute import GraphicFeature, ColorFeature
+from ._graphic_attribute import GraphicFeature, ColorFeature, PresentFeature


 class Graphic:
@@ -43,6 +43,10 @@ def __init__(
        if colors is not False:
            self.colors = ColorFeature(parent=self, colors=colors, n_colors=n_colors, alpha=alpha)

+        # different from visible, toggles the Graphic presence in the Scene
+        # useful for bbox calculations to ignore these Graphics
+        self.present = PresentFeature(parent=self)
+
        valid_features = ["visible"]
        for attr_name in self.__dict__.keys():
            attr = getattr(self, attr_name)

diff --git a/fastplotlib/graphics/_graphic_attribute.py b/fastplotlib/graphics/_graphic_attribute.py
@@ -236,3 +236,37 @@ def __getitem__(self, item):

    def __repr__(self):
        return repr(self._parent.world_object.geometry.colors.data)
+
+
+class PresentFeature(GraphicFeature):
+    """
+    Toggles if the object is present in the scene, different from visible \n
+    Useful for computing bounding boxes from the Scene to only include graphics
+    that are present
+    """
+    def __init__(self, parent, present: bool = True):
+        self._scene = None
+        super(PresentFeature, self).__init__(parent, present)
+
+    def _set(self, present: bool):
+        i = 0
+        while not isinstance(self._scene, Scene):
+            self._scene = self._parent.world_object.parent
+            i += 1
+
+            if i > 100:
+                raise RecursionError(
+                    "Exceded scene graph depth threshold, cannot find Scene associated with"
+                    "this graphic."
+                )
+
+        if present:
+            if self._parent.world_object not in self._scene.children:
+                self._scene.add(self._parent.world_object)
+
+        else:
+            if self._parent.world_object in self._scene.children:
+                self._scene.remove(self._parent.world_object)
+
+    def __repr__(self):
+        return repr(self.data)