Added docs and Body level syncVerts property

Author: photonstorm

CHANGELOG.md

@@ -101,8 +101,8 @@
 * `Body.setCentre` is a new method added to Matter that allows you to set the center of mass of a Body (please note the English spelling of this function.)
 * Bumped Matter Plugin versions to avoid console logs from Common.info and Common.warn.
 * `Vertices.calcOffset` is a new function that calculates the vert body position offset, used for keeping data in sync.
-* `Engine.syncVerts` is a new Engine config property that allows you to run a vert re-sync at the end of the Engine step. This can help massively if you find you've got verts drifting out of alignment with the body position when using pointer contraints, or high velocity environments. Uses the new `Engine._bodiesSync` function.
-* `Body.syncVerts` is a new function that will re-sync the vert positions with the body position. Called if `Engine.syncVerts` is set (which is now the default)
+* `Engine.syncVerts` is a new Engine config property that allows you to re-sync all the vertices ofa Body with the bodies position at the end of the Engine step. This can help massively if you find you've got verts drifting out of alignment with the body position when using pointer contraints, or high velocity environments. Uses the new `Engine._bodiesSync` function.
+* `Body.syncVerts` is a new function that will re-sync the vert positions with the body position. Called if `Engine.syncVerts` is `true` and if the Body has its `syncVerts` property set to `true`.
 * `Body.scale` is a new vector that holds the most recent scale values as passed to `Body.scale`.
 * `Matter.Bodies.flagCoincidentParts` is a new function that will flags all internal edges (coincident parts) on an array of body parts. This was previously part of the `fromVertices` function, but has been made external for outside use.
 * `PhysicsEditorParser.parseVertices` now uses `Bodies.flagCoincidentParts` to avoid duplicating code.

src/physics/matter-js/lib/body/Body.js

@@ -41,6 +41,7 @@ var Axes = require('../geometry/Axes');
             type: 'body',
             label: 'Body',
             gameObject: null, // custom Phaser property
+            syncVerts: false, // custom Phaser property
             parts: [],
             plugin: {},
             angle: 0,
@@ -904,6 +905,18 @@ var Axes = require('../geometry/Axes');
      * @type vector[]
      */
 
+    /**
+     * If `Engine.syncVerts` has been enabled in the Matter config, then this Body will have its vertices
+     * resynced with its body position at the end of the `Engine.update` step. This is important if you are
+     * moving a Body around at high speed and colliding with static objects, or are using pointer constraints
+     * and allowing a Body to be dragged around, as Matter can often lose sync between the body position and
+     * its vertices under these situations.
+     *
+     * @property syncVerts
+     * @type boolean
+     * @default false
+     */
+
     /**
      * A `Vector` that specifies the current world-space position of the body.
      *

src/physics/matter-js/lib/core/Engine.js

@@ -49,7 +49,7 @@ var Body = require('../body/Body');
             velocityIterations: 4,
             constraintIterations: 2,
             enableSleeping: false,
-            syncVerts: true,
+            syncVerts: true, // custom Phaser property
             events: [],
             plugin: {},
             timing: {
@@ -338,7 +338,7 @@ var Body = require('../body/Body');
         {
             var body = bodies[i];
 
-            if (body.isStatic || body.isSleeping)
+            if (!body.syncVerts || body.isStatic || body.isSleeping)
             {
                 continue;
             }