Plot.auto_scale() shouldn't change the camera aspect unless desired (#364)

kushalkolar · web-flow · commit 7350b81e66c0 · 2023-11-15T23:19:00.000-05:00
* now auto_scale() by default does not change camera aspect

* center_scene() and maintain_aspect() take only kwargs

* update screenshot images after auto_scale() fix
diff --git a/examples/desktop/screenshots/gridplot.png b/examples/desktop/screenshots/gridplot.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:a83704df89be660a6797e27ae4031ab48eb21f061a94cfdeb007a022b745de06
-size 350327
+oid sha256:e416fc968edd3788513e369f4d265b0abd7216a7ef19ec8b84659c30ca7c8ca1
+size 307384
diff --git a/examples/desktop/screenshots/gridplot_non_square.png b/examples/desktop/screenshots/gridplot_non_square.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:abf936904d1b5e2018a72311c510108925f2972dfdf59166580ad27876f9e2be
-size 220140
+oid sha256:ab5598b67b80efce0d2559e400e77098e734c91608a3f49b691ddaa030d47edb
+size 203434
diff --git a/examples/desktop/screenshots/heatmap.png b/examples/desktop/screenshots/heatmap.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6c19d6454e79d92074bac01175dfbb8506e882ea55b626c0b2357960ed6e294f
-size 163655
+oid sha256:6872c3cc3e35ec918b054fb2d76525bbd3d82d8b49916aca1046aa1be65ff923
+size 111825
diff --git a/examples/desktop/screenshots/heatmap_cmap.png b/examples/desktop/screenshots/heatmap_cmap.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:0328eec32f13042e3e2f243793317e180bba1353fe961604ecad3f38463b8809
-size 156419
+oid sha256:f2eba96c2bfb1d07365810a69e99c79b068741f5dcf74fc745c13d5ff21f16f2
+size 106671
diff --git a/examples/desktop/screenshots/heatmap_data.png b/examples/desktop/screenshots/heatmap_data.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:4a376c24fa123088be69f807ec5212cb5ed5680b146ce9d62df584790c632845
-size 20838
+oid sha256:f0576063658e05e19b7723b4c88dc4d55a8178b090b4a88e33251fc92408b4a1
+size 18051
diff --git a/examples/desktop/screenshots/heatmap_vmin_vmax.png b/examples/desktop/screenshots/heatmap_vmin_vmax.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3eb12ad590aa8260f2cf722abadf5b51bcb7d5a8d8d1cb05b7711b50331da07a
-size 165937
+oid sha256:639d50f2f5fb07dba461e7a38de3886092f8754277eadbb5e305e32023289abd
+size 124403
diff --git a/examples/desktop/screenshots/image_cmap.png b/examples/desktop/screenshots/image_cmap.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:8cc6aa770845f05bdc8914d3c983504f7a75b316a24e8e2b182c05145187b3e2
-size 274798
+oid sha256:e1d78cc0681079a5c43d9fdb4142f5fee75d477d9f9a1469fca8bc8933c244fc
+size 216210
diff --git a/examples/desktop/screenshots/image_rgb.png b/examples/desktop/screenshots/image_rgb.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3372487a5ae0fd47095ffbfc90915b94ff1a54c463ae887474f6eadd04801d6b
-size 319514
+oid sha256:820a73b9b2e5bbaed84fb11438e2c5672b76c8b57a33823f4840a71be03d7dd1
+size 251438
diff --git a/examples/desktop/screenshots/image_rgbvminvmax.png b/examples/desktop/screenshots/image_rgbvminvmax.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:026ea433786e50aa3d9e0fa8eb1d921617e52aca97eb6ffd5c8b297f1cd69c79
-size 44787
+oid sha256:5f2f562573f8104342ae01b5852f71c960341bdd70ae0bc7967df663166edbd3
+size 39604
diff --git a/examples/desktop/screenshots/image_simple.png b/examples/desktop/screenshots/image_simple.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:64803f58bd07e87d171e66eb9437d4fcc2ec1781e4da150a7229f6deef0835ad
-size 272599
+oid sha256:a4ed42d042d8bb7e35f31b5ad0a3e3a495cf9c3164516eb457d8b41d7fae6bab
+size 213075
diff --git a/examples/desktop/screenshots/image_vminvmax.png b/examples/desktop/screenshots/image_vminvmax.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:026ea433786e50aa3d9e0fa8eb1d921617e52aca97eb6ffd5c8b297f1cd69c79
-size 44787
+oid sha256:5f2f562573f8104342ae01b5852f71c960341bdd70ae0bc7967df663166edbd3
+size 39604
diff --git a/examples/desktop/screenshots/line.png b/examples/desktop/screenshots/line.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:164e5c36d57707da3ab928fe79312b4362de083c8422fc126ebc6cbc895eb022
-size 49783
+oid sha256:018f4a36c60b3de2f1406aa2823b751de5fae2c2340f9d49368d007ba7379637
+size 44422
diff --git a/examples/desktop/screenshots/line_colorslice.png b/examples/desktop/screenshots/line_colorslice.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3f708da0a80ec8776da28052835e19132bee8e1a1e301021bf4bc5f44e6a8825
-size 57105
+oid sha256:5bd80cee80f491da6ab64c868a3c70254a68072e0bc0caad80c7999cadcb2df9
+size 50497
diff --git a/examples/desktop/screenshots/line_dataslice.png b/examples/desktop/screenshots/line_dataslice.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:91a3995675530ed2132149e2c2f1dad6731b5d9ec7b503d78da133db1e06cae0
-size 75481
+oid sha256:823651905a775b5cbcc2ce0f79d25d69b29f17b4c060c244d80ae87019f05d5b
+size 69332
diff --git a/examples/desktop/screenshots/line_present_scaling.png b/examples/desktop/screenshots/line_present_scaling.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:b7b8d50cbbd9b1dafbf9a6559ef974c53e14e2a8106fa0c5c3c065fc532c76e5
-size 43413
+oid sha256:3d18669d5e75cee3326d0380ae5dd26cab71ea97725ff99bc5228d2555d51454
+size 30373
diff --git a/examples/desktop/screenshots/scatter.png b/examples/desktop/screenshots/scatter.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:8d806d252ee03ade60cffcc651ebe041560bcc095f5aaeacf43f3ffb4d29f660
+oid sha256:bd38399b77e09d915c5bb1e7ee022f936ae90682f598357bc774a95c372dc78f
 size 25231
diff --git a/examples/desktop/screenshots/scatter_cmap.png b/examples/desktop/screenshots/scatter_cmap.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:e1c0c2b899fdb0e5456ec7305ba20a5fc04b715f88c834715fcb867d456d58b3
-size 59401
+oid sha256:e712693b403166909dcaa65256131eacba0a15892cd144ad97fdecb6b9835e93
+size 57273
diff --git a/examples/desktop/screenshots/scatter_colorslice.png b/examples/desktop/screenshots/scatter_colorslice.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3d271bf913c196559ae0f5e323326dc9f68b015ce0d2078d775371ff57bef309
-size 23746
+oid sha256:c620cad9976f390e44a5b037f3ff61fb80e6487e17f4be8118be5df55f276a35
+size 23664
diff --git a/examples/desktop/screenshots/scatter_dataslice.png b/examples/desktop/screenshots/scatter_dataslice.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:ef00ef6e6babf9fbfd18b7c1b91cc80c6c1dd0253d7f5fbb2a7b9a900dad4e41
-size 25996
+oid sha256:69d2f0999b0bb334e48320702095fc76444f4d89d43a51ac6c5c8f49e1df96ac
+size 25999
diff --git a/examples/desktop/screenshots/scatter_present.png b/examples/desktop/screenshots/scatter_present.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:cf630459458da82853919717908d433ab1fe846f2158a30b7ef7ddbd53ae418d
-size 24617
+oid sha256:e45c1a936771e569e562ed3496421e498e725325093e84243ab494c0718ead3a
+size 23639
diff --git a/examples/notebooks/screenshots/nb-lines-underlay.png b/examples/notebooks/screenshots/nb-lines-underlay.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:fd21151b5af0065b25e20b7e382d310afebb3ee36ab12acadc6188b6adf4b128
-size 55961
+oid sha256:70800d1739bb5ba7d5d9d2399335ebc1ce8a0874042ed4b6256b6d041014eb18
+size 55884
diff --git a/fastplotlib/layouts/_plot_area.py b/fastplotlib/layouts/_plot_area.py
@@ -459,7 +459,7 @@ def center_graphic(self, graphic: Graphic, zoom: float = 1.35):
         # probably because camera.show_object uses bounding sphere
         self.camera.zoom = zoom
 
-    def center_scene(self, zoom: float = 1.35):
+    def center_scene(self, *, zoom: float = 1.35):
         """
         Auto-center the scene, does not scale.
 
@@ -481,15 +481,20 @@ def center_scene(self, zoom: float = 1.35):
             # probably because camera.show_object uses bounding sphere
             camera.zoom = zoom
 
-    def auto_scale(self, maintain_aspect: bool = False, zoom: float = 0.8):
+    def auto_scale(
+            self,
+            *,  # since this is often used as an event handler, don't want to coerce maintain_aspect = True
+            maintain_aspect: Union[None, bool] = None,
+            zoom: float = 0.8
+    ):
         """
         Auto-scale the camera w.r.t to the scene
 
         Parameters
         ----------
-        maintain_aspect: bool, default ``False``
-            maintain the camera aspect ratio for all dimensions, if ``False`` the camera
-            is scaled according to the bounds in each dimension.
+        maintain_aspect: ``None`` or bool, default ``None``
+            Maintain the camera aspect ratio for all dimensions. If ``None``, the aspect is left unchanged.
+            if ``False`` the camera is scaled to the bounding box of the current scene.
 
         zoom: float, default 0.8
             zoom value for the camera after auto-scaling, if zoom = 1.0 then the graphics
@@ -503,8 +508,9 @@ def auto_scale(self, maintain_aspect: bool = False, zoom: float = 0.8):
             self.scene.remove(selector.world_object)
 
         self.center_scene()
-        if not isinstance(maintain_aspect, bool):
-            maintain_aspect = False  # assume False
+
+        if maintain_aspect is None:  # if not provided keep current setting
+            maintain_aspect = self.camera.maintain_aspect
 
         # scale all cameras associated with this controller else it looks wonky
         for camera in self.controller.cameras:
