Scale/scaled

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Fixed `RuntimeError` when using `compas_rhino.unload_modules` in CPython`. 
 * Fixed `scaled` in `Box`.
+* Changed argument names of `Box.scale()` to `x`, `y`, `z`, instead of `factor` and made `y` and `z` optional to keep positional arguments backwards compatible.
 
 ### Removed
 

src/compas/geometry/shapes/box.py

@@ -558,22 +558,29 @@ def to_brep(self):
     #     self.ysize *= scaley
     #     self.zsize *= scalez
 
-    def scale(self, factor):
+    def scale(self, x, y=None, z=None):
         """Scale the box.
 
         Parameters
         ----------
-        factor : float
-            The scaling factor.
+        x : float
+            The scaling factor in x-direction. If no other factor is specified,
+            this factor will be used for all directions.
+        y : float, optional
+            The scaling factor in the y-direction.
+            Defaults to ``x``.
+        z : float, optional
+            The scaling factor in the z-direction.
+            Defaults to ``x``.
 
         Returns
         -------
         None
 
         """
-        self.xsize *= factor
-        self.ysize *= factor
-        self.zsize *= factor
+        self.xsize *= x
+        self.ysize *= y if y is not None else x
+        self.zsize *= z if z is not None else x
 
     def scaled(self, x, y=None, z=None):
         """Returns a scaled copy of the box.
@@ -591,10 +598,7 @@ def scaled(self, x, y=None, z=None):
 
         """
         box = self.copy()
-        box.xsize *= x
-        box.ysize *= y if y is not None else x
-        box.zsize *= z if z is not None else x
-
+        box.scale(x, y, z)
         return box
 
     # ==========================================================================

tests/compas/geometry/test_box.py

@@ -105,6 +105,9 @@ def test_box_scale(default_box):
 
 def test_box_scaled(default_box):
     new_box = default_box.scaled(2.0, 4.0, 2.0)
+    assert default_box.xsize == 1.0
+    assert default_box.ysize == 2.0
+    assert default_box.zsize == 3.0
     assert new_box.xsize == 2.0
     assert new_box.ysize == 8.0
     assert new_box.zsize == 6.0