Add Vec2d.length_squared, deprecated Vec2d.get_length_sqrd #274

Author: viblo

CHANGELOG.rst

@@ -3,12 +3,15 @@ Changelog
 =========
 .. Pymunk 7.0.0
    Breaking: At least one of the two bodies attached to constraint/joint must be dynamic. 
+   New feature: Vec2d supports bool to test if zero. (bool(Vec2d(2,3) == True) Note this is a breaking change.
+   Added Vec2d.length_squared, and depreacted Vec2d.get_length_sqrd()
 
-   Extra thanks for aetle for a number of suggestions for improvements:
+   
    New feature: ShapeFilter.rejects_collision()
-   New feature: Vec2d supports bool to test if zero. (bool(Vec2d(2,3) == True) 
    Optimized Vec2d.angle and Vec2d.angle_degrees
    Improved vec2d documentation 
+   
+   Extra thanks for aetle for a number of suggestions for improvements in this pymunk release
 
 
 Pymunk 6.11.1 (2025-02-09)

pymunk/examples/tank.py

@@ -23,7 +23,7 @@ def update(space, dt, surface):
     tank_control_body.angle = tank_body.angle - turn
 
     # drive the tank towards the mouse
-    if (mouse_pos - tank_body.position).get_length_sqrd() < 30 ** 2:
+    if (mouse_pos - tank_body.position).length_squared < 30**2:
         tank_control_body.velocity = 0, 0
     else:
         if mouse_delta.dot(tank_body.rotation_vector) > 0.0:

pymunk/vec2d.py

@@ -108,6 +108,7 @@
 import math
 import numbers
 import operator
+import warnings
 from typing import NamedTuple, Tuple
 
 __all__ = ["Vec2d"]
@@ -256,19 +257,41 @@ def __bool__(self) -> bool:
         """
         return self.x != 0 or self.y != 0
 
+    @property
+    def length_squared(self) -> float:
+        """Get the squared length of the vector.
+        If the squared length is enough, it is more efficient to use this method
+        instead of first access .length and then do a x**2.
+
+        >>> v = Vec2d(3, 4)
+        >>> v.length_squared == v.length**2
+        True
+        >>> Vec2d(0, 0).length_squared
+        0
+        """
+        return self.x**2 + self.y**2
+
     # vectory functions
+
     def get_length_sqrd(self) -> float:
         """Get the squared length of the vector.
         If the squared length is enough, it is more efficient to use this method
-        instead of first calling get_length() or access .length and then do a
-        x**2.
+        instead of first accessing .length and then do a x**2.
+
+        .. deprecated:: 7.0.0
+            Please use :py:attr:`length_squared` instead.
 
         >>> v = Vec2d(3, 4)
         >>> v.get_length_sqrd() == v.length**2
         True
         >>> Vec2d(0, 0).get_length_sqrd()
         0
         """
+        warnings.warn(
+            "Vec2d.get_length_sqrd() is deprecated. Use Vec2d.length_squared instead.",
+            category=DeprecationWarning,
+            stacklevel=2,
+        )
         return self.x**2 + self.y**2
 
     @property
@@ -527,14 +550,14 @@ def convert_to_basis(
         """
         assert len(x_vector) == 2
         assert len(y_vector) == 2
-        x = self.dot(x_vector) / Vec2d(*x_vector).get_length_sqrd()
-        y = self.dot(y_vector) / Vec2d(*y_vector).get_length_sqrd()
+        x = self.dot(x_vector) / Vec2d(*x_vector).length_squared
+        y = self.dot(y_vector) / Vec2d(*y_vector).length_squared
         return Vec2d(x, y)
 
     @property
     def int_tuple(self) -> Tuple[int, int]:
         """The x and y values of this vector as a tuple of ints.
-        Use `round()` to round to closest int.
+        Uses `round()` to round to closest int.
 
         >>> Vec2d(0.9, 2.4).int_tuple
         (1, 2)