docs + Rect.to_polygon()

Author: AustinEast

echo/shape/Circle.hx

@@ -16,7 +16,14 @@ class Circle extends Shape implements IPooled {
   public var radius:Float;
   public var diameter(get, set):Float;
   public var pooled:Bool;
-
+  /**
+   * Gets a Cirlce from the pool, or creates a new one if none are available. Call `put()` on the Cirlce to place it back in the pool.
+   * @param x
+   * @param y
+   * @param radius
+   * @param rotation
+   * @return Circle
+   */
   public static inline function get(x:Float = 0, y:Float = 0, radius:Float = 1, rotation:Float = 0):Circle {
     var circle = _pool.get();
     circle.set(x, y, radius, rotation);

echo/shape/Polygon.hx

@@ -38,7 +38,15 @@ class Polygon extends Shape implements IPooled {
   var local_frame:Frame2;
 
   var local_vertices:Array<Vector2>;
-
+  /**
+   * Gets a Polygon from the pool, or creates a new one if none are available. Call `put()` on the Polygon to place it back in the pool.
+   * @param x
+   * @param y
+   * @param sides
+   * @param radius
+   * @param rotation
+   * @return Polygon
+   */
   public static inline function get(x:Float = 0, y:Float = 0, sides:Int = 3, radius:Float = 1, rotation:Float = 0):Polygon {
     if (sides < 3) throw 'Polygons require 3 sides as a minimum';
 
@@ -58,14 +66,25 @@ class Polygon extends Shape implements IPooled {
     polygon.pooled = false;
     return polygon;
   }
-
+  /**
+   * Gets a Polygon from the pool, or creates a new one if none are available. Call `put()` on the Polygon to place it back in the pool.
+   * @param x
+   * @param y
+   * @param rotation
+   * @param vertices
+   * @return Polygon
+   */
   public static inline function get_from_vertices(x:Float = 0, y:Float = 0, rotation:Float = 0, ?vertices:Array<Vector2>):Polygon {
     var polygon = _pool.get();
     polygon.set(x, y, vertices);
     polygon.pooled = false;
     return polygon;
   }
-
+  /**
+   * Gets a Polygon from the pool, or creates a new one if none are available. Call `put()` on the Polygon to place it back in the pool.
+   * @param rect
+   * @return Polygon return _pool.get().set_from_rect(rect)
+   */
   public static inline function get_from_rect(rect:Rect):Polygon return _pool.get().set_from_rect(rect);
 
   // TODO

echo/shape/Rect.hx

@@ -42,14 +42,31 @@ class Rect extends Shape implements IPooled {
   public var pooled:Bool;
 
   public var transformed_rect(default, null):Null<Polygon>;
-
+  /**
+   * Gets a Rect from the pool, or creates a new one if none are available. Call `put()` on the Rect to place it back in the pool.
+   *
+   * Note - The X and Y positions represent the center of the Rect. To set the Rect from its Top-Left origin, `Rect.get_from_min_max()` is available.
+   * @param x The centered X position of the Rect.
+   * @param y The centered Y position of the Rect.
+   * @param width The width of the Rect.
+   * @param height The height of the Rect.
+   * @param rotation The rotation of the Rect.
+   * @return Rect
+   */
   public static inline function get(x:Float = 0, y:Float = 0, width:Float = 1, height:Float = 0, rotation:Float = 0):Rect {
     var rect = _pool.get();
     rect.set(x, y, width, height, rotation);
     rect.pooled = false;
     return rect;
   }
-
+  /**
+   * Gets a Rect from the pool, or creates a new one if none are available. Call `put()` on the Rect to place it back in the pool.
+   * @param min_x
+   * @param min_y
+   * @param max_x
+   * @param max_y
+   * @return Rect
+   */
   public static inline function get_from_min_max(min_x:Float, min_y:Float, max_x:Float, max_y:Float):Rect {
     var rect = _pool.get();
     rect.set_from_min_max(min_x, min_y, max_x, max_y);
@@ -107,6 +124,15 @@ class Rect extends Shape implements IPooled {
     return bounds();
   }
 
+  public function to_polygon(put_self:Bool = false):Polygon {
+    if (put_self) {
+      var polygon = Polygon.get_from_rect(this);
+      put();
+      return polygon;
+    }
+    return Polygon.get_from_rect(this);
+  }
+
   override inline function bounds(?aabb:AABB):AABB {
     if (transformed_rect != null) return transformed_rect.bounds(aabb);
     return (aabb == null) ? AABB.get(x, y, width, height) : aabb.set(x, y, width, height);

echo/util/AABB.hx

@@ -16,19 +16,36 @@ class AABB implements IPooled {
   public var height(get, never):Float;
 
   public var pooled:Bool;
-
+  /**
+   * Gets an AABB from the pool, or creates a new one if none are available. Call `put()` on the AABB to place it back in the pool.
+   *
+   * Note - The X and Y positions represent the center of the AABB. To set the AABB from its Top-Left origin, `AABB.get_from_min_max()` is available.
+   * @param x The centered X position of the AABB.
+   * @param y The centered Y position of the AABB.
+   * @param width The width of the AABB.
+   * @param height The height of the AABB.
+   * @param rotation The rotation of the AABB.
+   * @return AABB
+   */
   public static inline function get(x:Float = 0, y:Float = 0, width:Float = 1, height:Float = 0):AABB {
-    var rect = _pool.get();
-    rect.set(x, y, width, height);
-    rect.pooled = false;
-    return rect;
+    var aabb = _pool.get();
+    aabb.set(x, y, width, height);
+    aabb.pooled = false;
+    return aabb;
   }
-
+  /**
+   * Gets an AABB from the pool, or creates a new one if none are available. Call `put()` on the AABB to place it back in the pool.
+   * @param min_x
+   * @param min_y
+   * @param max_x
+   * @param max_y
+   * @return AABB
+   */
   public static inline function get_from_min_max(min_x:Float, min_y:Float, max_x:Float, max_y:Float):AABB {
-    var rect = _pool.get();
-    rect.set_from_min_max(min_x, min_y, max_x, max_y);
-    rect.pooled = false;
-    return rect;
+    var aabb = _pool.get();
+    aabb.set_from_min_max(min_x, min_y, max_x, max_y);
+    aabb.pooled = false;
+    return aabb;
   }
 
   inline function new() {
@@ -65,11 +82,11 @@ class AABB implements IPooled {
     return this.min_x < other.max_x && this.max_x >= other.min_x && this.min_y < other.max_y && this.max_y >= other.min_y;
   }
 
-  public inline function load(rect:AABB) {
-    this.min_x = rect.min_x;
-    this.max_x = rect.max_x;
-    this.min_y = rect.min_y;
-    this.max_y = rect.max_y;
+  public inline function load(aabb:AABB) {
+    this.min_x = aabb.min_x;
+    this.max_x = aabb.max_x;
+    this.min_y = aabb.min_y;
+    this.max_y = aabb.max_y;
   }
 
   public function put() {