Added Vec2d.get_distance_squared, deprecated get_dist_sqrd #274

Author: viblo

CHANGELOG.rst

@@ -5,7 +5,7 @@ Changelog
    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()
-
+   Added Vec2d.get_distance_squared(), and deprecated Vec2d.get_dist_sqrd()
    
    New feature: ShapeFilter.rejects_collision()
    New feature: Added Vec2d.polar_tuple

pymunk/examples/planet.py

@@ -40,7 +40,7 @@ def planet_gravity(body, gravity, damping, dt):
     # distance, and directed toward the origin. The central planet is assumed
     # to be massive enough that it affects the satellites but not vice versa.
     p = body.position
-    sq_dist = p.get_dist_sqrd(center)
+    sq_dist = p.get_distance_squared(center)
     g = (p - center) * -gravityStrength / (sq_dist * math.sqrt(sq_dist))
 
     # body.velocity += g * dt # setting velocity directly like would be slower

pymunk/vec2d.py

@@ -484,18 +484,41 @@ def get_distance(self, other: Tuple[float, float]) -> float:
         assert len(other) == 2
         return math.sqrt((self.x - other[0]) ** 2 + (self.y - other[1]) ** 2)
 
+    def get_distance_squared(self, other: Tuple[float, float]) -> float:
+        """The squared distance between the vector and other vector.
+        It is more efficent to use this method than to call get_distance()
+        first and then do a square() on the result.
+
+        >>> Vec2d(1, 0).get_distance_squared((1, 10))
+        100
+        >>> Vec2d(1, 2).get_distance_squared((10, 11))
+        162
+        >>> Vec2d(1, 2).get_distance((10, 11))**2
+        162.0
+        """
+        assert len(other) == 2
+        return (self.x - other[0]) ** 2 + (self.y - other[1]) ** 2
+
     def get_dist_sqrd(self, other: Tuple[float, float]) -> float:
         """The squared distance between the vector and other vector.
         It is more efficent to use this method than to call get_distance()
         first and then do a square() on the result.
 
+        .. deprecated:: 7.0.0
+            Please use :py:func:`get_distance_squared` instead.
+
         >>> Vec2d(1, 0).get_dist_sqrd((1, 10))
         100
         >>> Vec2d(1, 2).get_dist_sqrd((10, 11))
         162
         >>> Vec2d(1, 2).get_distance((10, 11))**2
         162.0
         """
+        warnings.warn(
+            "get_dist_sqrd() is deprecated. Use get_distance_squared() instead.",
+            category=DeprecationWarning,
+            stacklevel=2,
+        )
         assert len(other) == 2
         return (self.x - other[0]) ** 2 + (self.y - other[1]) ** 2