New Vec2d.polar_tuple property #274

Author: viblo

CHANGELOG.rst

@@ -8,9 +8,11 @@ Changelog
 
    
    New feature: ShapeFilter.rejects_collision()
+   New feature: Added Vec2d.polar_tuple
    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/vec2d.py

@@ -564,6 +564,22 @@ def int_tuple(self) -> Tuple[int, int]:
         """
         return round(self.x), round(self.y)
 
+    @property
+    def polar_tuple(self) -> Tuple[float, float]:
+        """Return this vector as polar coordinates (length, angle)
+
+        See Vec2d.from_polar() for the inverse.
+
+        >>> Vec2d(2, 0).polar_tuple
+        (2.0, 0.0)
+        >>> Vec2d(2, 0).rotated(0.5).polar_tuple
+        (2.0, 0.5)
+        >>> Vec2d.from_polar(2, 0.5).polar_tuple
+        (2.0, 0.5)
+
+        """
+        return self.length, self.angle
+
     @staticmethod
     def zero() -> "Vec2d":
         """A vector of zero length.
@@ -595,6 +611,8 @@ def ones() -> "Vec2d":
     def from_polar(length: float, angle: float) -> "Vec2d":
         """Create a new Vec2d from a length and an angle (in radians).
 
+        See Vec2d.polar_tuple for the inverse.
+
         >>> Vec2d.from_polar(2, 0)
         Vec2d(2.0, 0.0)
         >>> Vec2d(2, 0).rotated(0.5) == Vec2d.from_polar(2, 0.5)