Added drag events to Pointer Constraint

Author: photonstorm

CHANGELOG.md

@@ -4,13 +4,21 @@
 
 A small point release to fix a couple of important issues that slipped into 3.16.
 
+### New
+
+* There is a new Matter Physics Event `DRAG_START` which is emitted by a Pointer Constraint when it starts dragging a body. Listen for this event fro the Matter World instance.
+* There is a new Matter Physics Event `DRAG` which is emitted by a Pointer Constraint as it drags a body. Listen for this event fro the Matter World instance.
+* There is a new Matter Physics Event `DRAG_END` which is emitted by a Pointer Constraint when it stops dragging a body. Listen for this event fro the Matter World instance.
+
 ### Updates
 
 * `TileSprite.setTileScale` has been updated so that the `y` argument is optional and set to match the `x` argument, like `setScale` elsewhere in the API.
 * `InputManager.time` is a new property that holds the most recent time it was updated from the Game step, which plugins can access.
 * `InputManager.preStep` is a new method that populates some internal properties every step.
 * `KeyboardPlugin.time` has moved from being a property to being a getter, which returns the time from the InputManager.
 * The `scale` property has been added to the `Scene` class (thanks @strangeweekend)
+* `Matter.World.remove` now uses the `Composite.remove` method internally. Previously, it used `Composite.removeBody` which only allowed it to remove bodies from the simulation. Now, it can remove any type of Matter object.
+* `Matter.PointerConstraint.camera` can no longer be set in the config object. Instead it is set every time the Pointer is pressed down on a Body, this resolves issues where you have a multi-camera Scene and want to drag a body in the non-main camera.
 
 ### Bug Fixes
 

src/physics/matter-js/PointerConstraint.js

@@ -73,24 +73,14 @@ var PointerConstraint = new Class({
         this.world = world;
 
         /**
-         * [description]
+         * The Camera the Pointer was interacting with when the input
+         * down event was processed.
          *
          * @name Phaser.Physics.Matter.PointerConstraint#camera
          * @type {Phaser.Cameras.Scene2D.Camera}
          * @since 3.0.0
          */
-        var camera = GetFastValue(options, 'camera', null);
-
-        if (!camera)
-        {
-            this.camera = scene.sys.cameras.main;
-        }
-        else
-        {
-            this.camera = camera;
-
-            delete options.camera;
-        }
+        this.camera = null;
 
         /**
          * [description]
@@ -147,6 +137,8 @@ var PointerConstraint = new Class({
     onDown: function (pointer)
     {
         this.pointer = pointer;
+
+        this.camera = pointer.camera;
     },
 
     /**
@@ -158,6 +150,8 @@ var PointerConstraint = new Class({
     onUp: function ()
     {
         this.pointer = null;
+
+        this.camera = pointer.camera;
     },
 
     /**
@@ -223,7 +217,8 @@ var PointerConstraint = new Class({
             //  Pointer is up / released
             if (constraint.bodyB)
             {
-                this.world.emit('enddrag', constraint.bodyB, constraint);
+                this.world.emit(Events.DRAG_END, constraint.bodyB, this);
+
                 constraint.bodyB = null;
             }
         }
@@ -241,7 +236,7 @@ var PointerConstraint = new Class({
                 constraint.pointA.x = pos.x;
                 constraint.pointA.y = pos.y;
 
-                this.world.emit('drag', constraint.bodyB, constraint);
+                this.world.emit(Events.DRAG, constraint.bodyB, this);
             }
             else
             {
@@ -257,7 +252,7 @@ var PointerConstraint = new Class({
                     {
                         if (this.getBodyPart(body, pos))
                         {
-                            this.world.emit('startdrag', body, constraint);
+                            this.world.emit(Events.DRAG_START, body, this);
                             break;
                         }
                     }

src/physics/matter-js/events/DRAG_END_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * The Matter Physics Drag End Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance when a Pointer Constraint
+ * stops dragging a body.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('dragend', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#DRAG_END
+ * 
+ * @param {MatterJS.Body} body - The Body that has stopped being dragged. This is a Matter Body, not a Phaser Game Object.
+ * @param {Phaser.Physics.Matter.PointerConstraint} constraint - The Pointer Constraint that was dragging the body.
+ */
+module.exports = 'dragend';

src/physics/matter-js/events/DRAG_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * The Matter Physics Drag Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance when a Pointer Constraint
+ * is actively dragging a body. It is emitted each time the pointer moves.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('drag', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#DRAG
+ * 
+ * @param {MatterJS.Body} body - The Body that is being dragged. This is a Matter Body, not a Phaser Game Object.
+ * @param {Phaser.Physics.Matter.PointerConstraint} constraint - The Pointer Constraint that is dragging the body.
+ */
+module.exports = 'drag';

src/physics/matter-js/events/DRAG_START_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * The Matter Physics Drag Start Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance when a Pointer Constraint
+ * starts dragging a body.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('dragstart', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#DRAG_START
+ * 
+ * @param {MatterJS.Body} body - The Body that has started being dragged. This is a Matter Body, not a Phaser Game Object.
+ * @param {Phaser.Physics.Matter.PointerConstraint} constraint - The Pointer Constraint that is dragging the body.
+ */
+module.exports = 'dragstart';

src/physics/matter-js/events/index.js

@@ -15,6 +15,9 @@ module.exports = {
     COLLISION_ACTIVE: require('./COLLISION_ACTIVE_EVENT'),
     COLLISION_END: require('./COLLISION_END_EVENT'),
     COLLISION_START: require('./COLLISION_START_EVENT'),
+    DRAG_END: require('./DRAG_END_EVENT'),
+    DRAG: require('./DRAG_EVENT'),
+    DRAG_START: require('./DRAG_START_EVENT'),
     PAUSE: require('./PAUSE_EVENT'),
     RESUME: require('./RESUME_EVENT'),
     SLEEP_END: require('./SLEEP_END_EVENT'),