Merge pull request #9 from AustinEast/dirty-and-sleep

Dirty flag + Quadtree improvements

Author: AustinEast

echo/Body.hx

@@ -11,13 +11,9 @@ using Lambda;
  */
 class Collisions {
   /**
-   * Queries a World's Listeners for Collisions
+   * Updates the World's dynamic QuadTree with any Bodies that have moved.
    */
-  public static function query(world:World, ?listeners:Listeners) {
-    // Populate the Quadtree
-    var quadtree = listeners == null ? world.quadtree : QuadTree.get();
-    quadtree.clear();
-    quadtree.set(world.x + (world.width * 0.5), world.y + (world.height * 0.5), world.width, world.height);
+  public static function update_quadtree(world:World) {
     world.for_each(b -> {
       b.collided = false;
       for (shape in b.shapes) {
@@ -27,13 +23,21 @@ class Collisions {
           if (r.transformed_rect != null) r.transformed_rect.collided = false;
         }
       }
-      if (b.active && b.is_dynamic()) {
-        if (b.cache.quadtree_data.bounds == null) b.cache.quadtree_data.bounds = b.bounds();
-        else b.bounds(b.cache.quadtree_data.bounds);
-        quadtree.insert(b.cache.quadtree_data);
+      if (b.active && b.is_dynamic() && b.dirty) {
+        if (b.quadtree_data.bounds == null) b.quadtree_data.bounds = b.bounds();
+        else b.bounds(b.quadtree_data.bounds);
+        world.quadtree.update(b.quadtree_data);
       }
+      b.dirty = false;
     });
-
+  }
+  /**
+   * Queries a World's Listeners for Collisions.
+   * @param world The World to query.
+   * @param listeners Optional collection of listeners to query. If this is set, the World's listeners will not be queried.
+   */
+  public static function query(world:World, ?listeners:Listeners) {
+    update_quadtree(world);
     // Process the Listeners
     var members = listeners == null ? world.listeners.members : listeners.members;
     for (listener in members) {
@@ -46,14 +50,14 @@ class Collisions {
               var col = body_and_body(ba, bb);
               if (col != null) listener.quadtree_results.push(col);
             case Right(ab):
-              body_and_bodies(ba, ab, world, listener.quadtree_results, quadtree);
+              body_and_bodies(ba, ab, world, listener.quadtree_results, world.quadtree);
           }
         case Right(aa):
           switch (listener.b) {
             case Left(bb):
-              body_and_bodies(bb, aa, world, listener.quadtree_results, quadtree);
+              body_and_bodies(bb, aa, world, listener.quadtree_results, world.quadtree);
             case Right(ab):
-              bodies_and_bodies(aa, ab, world, listener.quadtree_results, quadtree);
+              bodies_and_bodies(aa, ab, world, listener.quadtree_results, world.quadtree);
           }
       }
       // Narrow Phase
@@ -78,12 +82,10 @@ class Collisions {
           continue;
         }
         // Preform the full collision check
-        var use_a_cache = result.a.is_static();
-        var ssa = use_a_cache ? result.a.cache.shapes : result.a.shapes;
+        var ssa = result.a.shapes;
 
         for (sa in ssa) {
-          var use_b_cache = result.b.is_static();
-          var ssb = use_b_cache ? result.b.cache.shapes : result.b.shapes;
+          var ssb = result.b.shapes;
           for (sb in ssb) {
             var col = sa.collides(sb);
             if (col != null) result.data.push(col);
@@ -104,7 +106,6 @@ class Collisions {
         listener.collisions.push(result);
       }
     }
-    if (listeners != null) quadtree.put();
   }
   /**
    * Enacts the Callbacks defined in a World's Listeners

echo/Collisions.hx

@@ -16,6 +16,9 @@ import echo.util.BodyOrBodies;
  * Echo holds helpful utility methods to help streamline the creation and management of Physics Simulations.
  */
 class Echo {
+  /**
+   * Cache'd `Listeners` collection to help with memory management.
+   */
   static var listeners:Listeners = new Listeners();
   /**
    * Shortcut for creating a new `World`
@@ -50,20 +53,17 @@ class Echo {
    * @param b The second `Body` or Array of Bodies to collide against
    * @param options Options to define the Collision Check's behavior
    */
-  public static function check(world:World, ?a:BodyOrBodies, ?b:BodyOrBodies, ?options:ListenerOptions):Listener {
-    var listener:Listener;
-
+  public static function check(world:World, ?a:BodyOrBodies, ?b:BodyOrBodies, ?options:ListenerOptions) {
     listeners.clear();
 
-    if (a == null) listener = b == null ? listeners.add(world.members, world.members, options) : listeners.add(b, b, options);
-    else if (b == null) listener = listeners.add(a, a, options);
-    else listener = listeners.add(a, b, options);
+    if (a == null && b == null) listeners.add(world.members, world.members, options);
+    else if (a == null) listeners.add(b, b, options);
+    else if (b == null) listeners.add(a, a, options);
+    else listeners.add(a, b, options);
 
     Collisions.query(world, listeners);
     Physics.separate(world, listeners);
     Collisions.notify(world, listeners);
-
-    return listener;
   }
   /**
    * Steps a `World` forward.
@@ -252,7 +252,7 @@ class Echo {
             }
           }
         }
-        world.refresh();
+        world.reset_quadtrees();
       }
     }
     return world;
@@ -279,7 +279,7 @@ class Echo {
           }
         }
       }
-      world.refresh();
+      world.reset_quadtrees();
     }
     return world;
   }

echo/Echo.hx

@@ -12,6 +12,7 @@ import echo.util.BodyOrBodies;
  */
 @:structInit()
 class Listener {
+  public static var defaults(get, null):ListenerOptions;
   /**
    * The first Body or Array of Bodies the listener checks each step.
    */
@@ -62,29 +63,31 @@ class Listener {
    * Threshold determining how close two separating bodies must be before position correction occurs. Helps reduce jitter.
    */
   public var correction_threshold:Float;
+
+  static function get_defaults():ListenerOptions return {
+    separate: true,
+    percent_correction: 0.9,
+    correction_threshold: 0.013
+  }
 }
 /**
  * Container used to store Listeners
- *
- * TODO: Turn into an iterable
  */
 class Listeners implements IDisposable {
-  public static var listener_defaults(get, null):ListenerOptions;
-
   public var members:Array<Listener>;
 
   public function new(?members:Array<Listener>) {
     this.members = members == null ? [] : members;
   }
   /**
-   * Add a new Listener to listen for collisions
-   * @param a The first `Body` or Array of Bodies to collide against
-   * @param b The second `Body` or Array of Bodies to collide against
-   * @param options Options to define the Listener's behavior
-   * @return Listener
+   * Add a new Listener to the collection.
+   * @param a The first `Body` or Array of Bodies to collide against.
+   * @param b The second `Body` or Array of Bodies to collide against.
+   * @param options Options to define the Listener's behavior.
+   * @return The new Listener.
    */
   public function add(a:BodyOrBodies, b:BodyOrBodies, ?options:ListenerOptions):Listener {
-    options = echo.util.JSON.copy_fields(options, listener_defaults);
+    options = echo.util.JSON.copy_fields(options, Listener.defaults);
     var listener:Listener = {
       a: a,
       b: b,
@@ -103,26 +106,26 @@ class Listeners implements IDisposable {
     return listener;
   }
   /**
-   * Removes a Listener from the Container
-   * @param listener Listener to remove
-   * @return Listener
+   * Removes a Listener from the Container.
+   * @param listener Listener to remove.
+   * @return The removed Listener.
    */
   public function remove(listener:Listener):Listener {
     members.remove(listener);
     return listener;
   }
-
+  /**
+   * Clears the collection of all Listeners.
+   */
   public function clear() {
-    members = [];
+    members.resize(0);
   }
-
+  /**
+   * Disposes of the collection. Do not use once disposed.
+   */
   public function dispose() {
     members = null;
   }
 
-  static function get_listener_defaults():ListenerOptions return {
-    separate: true,
-    percent_correction: 0.9,
-    correction_threshold: 0.013
-  }
+  public inline function iterator():Iterator<Listener> return members.iterator();
 }

echo/Listener.hx

@@ -1,20 +1,20 @@
 package echo;
 
+#if macro
 import haxe.macro.Expr;
 import haxe.macro.Context;
 
 class Macros {
-  #if macro
-  static var dataFields:Array<Field> = []; // add fields here
+  static var dataFields:Array<Field> = [];
 
   static function build_body() {
-    if (dataFields.length == 0) return null; // No change, more optimal than returning array of fields.
+    if (dataFields.length == 0) return null;
     var fields = Context.getBuildFields();
     for (f in dataFields) fields.push(f);
     return fields;
   }
   /**
-   * Build Macro to add extra fields to the body class. Inspired by [@Yanrishatum](https://github.com/Yanrishatum).
+   * Build Macro to add extra fields to the Body class. Inspired by [@Yanrishatum](https://github.com/Yanrishatum).
    *
    * Example: in build.hxml - `--macro echo.Macros.add_data("entity", "some.package.Entity")
    * @param name
@@ -28,5 +28,5 @@ class Macros {
       pos: Context.currentPos()
     });
   }
-  #end
 }
+#end

echo/Macros.hx

@@ -0,0 +1,18 @@
+package echo;
+
+import hxmath.math.Vector2;
+/**
+ * TODO - A Structure that describes the physical properties of a `Body`.
+ */
+class Material {
+  /**
+   * Value to determine how much of a Body's `velocity` should be retained during collisions (or how much should the `Body` "bounce" in other words).
+   */
+  public var elasticity:Float;
+  /**
+   * A measure of how fast a Body will move its velocity towards 0 when there is no acceleration.
+   */
+  public var drag:Vector2;
+
+  public var friction:Float;
+}

echo/Material.hx

@@ -212,15 +212,15 @@ class Shape implements IProxy {
   inline function set_x(value:Float):Float {
     if (parent_frame == null) return local_x = value;
 
-    var pos = sync_pos.set(value, y);
+    var pos = new Vector2(value, y);
     set_local_position(parent_frame.transformTo(pos));
     return _x;
   }
 
   inline function set_y(value:Float):Float {
     if (parent_frame == null) return local_y = value;
 
-    var pos = sync_pos.set(x, value);
+    var pos = new Vector2(x, value);
     set_local_position(parent_frame.transformTo(pos));
     return _y;
   }