release 0.18.0

CHANGELOG.md

@@ -1,3 +1,44 @@
+## 0.18.0 (2021-12-15)
+
+* added test capture sort to improve comparison ([ea3c11b](https://github.com/liabru/matter-js/commit/ea3c11b))
+* added triangles to mixed bodies example ([b116f64](https://github.com/liabru/matter-js/commit/b116f64))
+* added behaviour metric to tests and refactor tests ([8125966](https://github.com/liabru/matter-js/commit/8125966))
+* added benchmark test command ([7f34c45](https://github.com/liabru/matter-js/commit/7f34c45))
+* added broadphase to Matter.Detector ([a6b5e7d](https://github.com/liabru/matter-js/commit/a6b5e7d))
+* added cache checks to Matter.Composite ([32fd285](https://github.com/liabru/matter-js/commit/32fd285))
+* added example for Composite.remove ([bc07f56](https://github.com/liabru/matter-js/commit/bc07f56))
+* added example stress 3 ([d0ee246](https://github.com/liabru/matter-js/commit/d0ee246))
+* added filesize to test comparison report ([b3a8aa3](https://github.com/liabru/matter-js/commit/b3a8aa3))
+* added Matter.Collision ([9037f36](https://github.com/liabru/matter-js/commit/9037f36))
+* added memory comparison to tests ([bedf84c](https://github.com/liabru/matter-js/commit/bedf84c))
+* added note about webpack performance to readme ([80cf76b](https://github.com/liabru/matter-js/commit/80cf76b))
+* added stable sorting to test worker and refactor ([81dd2fb](https://github.com/liabru/matter-js/commit/81dd2fb))
+* added support for build metadata in Plugin.versionParse ([8bfaff0](https://github.com/liabru/matter-js/commit/8bfaff0))
+* changed raycasting example events to enable use in tests ([10afaea](https://github.com/liabru/matter-js/commit/10afaea))
+* changed build config to 'source-map' devtool ([e909b04](https://github.com/liabru/matter-js/commit/e909b04))
+* changed tests to use a production build rather than source ([55feb89](https://github.com/liabru/matter-js/commit/55feb89))
+* deprecated Matter.Grid ([e366d0e](https://github.com/liabru/matter-js/commit/e366d0e))
+* fixed sync issues on demo compare tool ([826ed46](https://github.com/liabru/matter-js/commit/826ed46))
+* improved performance measurement accuracy in tests ([cd289ec](https://github.com/liabru/matter-js/commit/cd289ec))
+* improved test comparison report ([de04c00](https://github.com/liabru/matter-js/commit/de04c00))
+* optimised Matter.Detector ([c7cec16](https://github.com/liabru/matter-js/commit/c7cec16)), ([fd1a70e](https://github.com/liabru/matter-js/commit/fd1a70e)), ([caeb07e](https://github.com/liabru/matter-js/commit/caeb07e)), ([efede6e](https://github.com/liabru/matter-js/commit/efede6e))
+* optimised Matter.Composite ([52e7977](https://github.com/liabru/matter-js/commit/52e7977))
+* optimised Matter.Pair ([d8a6380](https://github.com/liabru/matter-js/commit/d8a6380)), ([48673db](https://github.com/liabru/matter-js/commit/48673db)), ([1073dde](https://github.com/liabru/matter-js/commit/1073dde))
+* optimised Matter.Pairs ([a30707f](https://github.com/liabru/matter-js/commit/a30707f)), ([a882a74](https://github.com/liabru/matter-js/commit/a882a74))
+* optimised Matter.Resolver ([fceb0ca](https://github.com/liabru/matter-js/commit/fceb0ca)), ([49fbfba](https://github.com/liabru/matter-js/commit/49fbfba)), ([0b07a31](https://github.com/liabru/matter-js/commit/0b07a31)), ([f847f4c](https://github.com/liabru/matter-js/commit/f847f4c)), ([3cf65e8](https://github.com/liabru/matter-js/commit/3cf65e8)), ([30b899c](https://github.com/liabru/matter-js/commit/30b899c)), ([e4b35d3](https://github.com/liabru/matter-js/commit/e4b35d3))
+* optimised Matter.SAT ([0d90a17](https://github.com/liabru/matter-js/commit/0d90a17)), ([2096961](https://github.com/liabru/matter-js/commit/2096961)), ([0af144c](https://github.com/liabru/matter-js/commit/0af144c))
+* optimised Matter.Vertices ([c198878](https://github.com/liabru/matter-js/commit/c198878)), ([6883d0d](https://github.com/liabru/matter-js/commit/6883d0d)), ([792ae2e](https://github.com/liabru/matter-js/commit/792ae2e))
+* refactor test worker and prevent test cache ([ca2fe75](https://github.com/liabru/matter-js/commit/ca2fe75)), ([bcc3168](https://github.com/liabru/matter-js/commit/bcc3168))
+* replaced Matter.SAT with Matter.Collision ([b9e7d9d](https://github.com/liabru/matter-js/commit/b9e7d9d))
+* show debug stats in dev demo ([2f14ec5](https://github.com/liabru/matter-js/commit/2f14ec5))
+* updated dev dependencies ([c5028d5](https://github.com/liabru/matter-js/commit/c5028d5))
+* updated examples ([c80ed5c](https://github.com/liabru/matter-js/commit/c80ed5c))
+* updated test scripts ([afa467a](https://github.com/liabru/matter-js/commit/afa467a))
+* use force exit in tests ([8adf810](https://github.com/liabru/matter-js/commit/8adf810))
+* use Matter.Runner in test worker ([2581595](https://github.com/liabru/matter-js/commit/2581595))
+
+
+
 ## <small>0.17.1 (2021-04-14)</small>
 
 * deprecate Engine.run alias replaced by Runner.run ([5817046](https://github.com/liabru/matter-js/commit/5817046))

RELEASE.md

@@ -1,3 +1,61 @@
+## ▲.● matter.js `0.18.0`
+
+Release notes for `0.18.0`. See the release [readme](https://github.com/liabru/matter-js/blob/0.18.0/README.md) for further information.
+
+### Highlights ✺
+
+- **Up to ~40% performance improvement (on average measured over all examples, in Node on a Mac Air M1)**
+- Replaces `Matter.Grid` with a faster and more efficient broadphase in `Matter.Detector`
+- Reduced memory usage and garbage collection
+- Resolves issues in `Matter.SAT` related to collision reuse
+- Removes performance issues from `Matter.Grid`
+- Improved collision accuracy
+- Improved API and docs for collision modules
+- Improved [documentation](https://brm.io/matter-js/docs/) pages
+- Added note about avoiding Webpack [performance problems](https://github.com/liabru/matter-js/blob/master/README.md#install)
+
+### Changes ✲
+
+See the release [compare page](https://github.com/liabru/matter-js/compare/0.17.1...0.18.0) and the [changelog](https://github.com/liabru/matter-js/blob/0.18.0/CHANGELOG.md) for a detailed list of changes.
+
+### Migration ⌲
+
+- Behaviour and similarity is in practice the same (a fractional difference from improved accuracy)
+- API is the same other than:
+  - [Matter.Detector](https://brm.io/matter-js/docs/classes/Detector.html) replaces [Matter.Grid](https://brm.io/matter-js/docs/classes/Grid.html) (which is now deprecated but will remain for a short term)
+  - [render.options.showBroadphase](https://brm.io/matter-js/docs/classes/Render.html#property_options.showBroadphase) is deprecated (no longer implemented)
+  - [Matter.SAT](https://brm.io/matter-js/docs/classes/SAT.html) is renamed [Matter.Collision](https://brm.io/matter-js/docs/classes/Collision.html)
+  - [Matter.SAT.collides](https://brm.io/matter-js/docs/classes/SAT.html#method_collides) is now [Matter.Collision.collides](https://brm.io/matter-js/docs/classes/Collision.html#method_collides) with a slightly different set of arguments
+
+### Comparison ⎄
+
+Differences in behaviour, quality and performance against the previous release `0.17.1`. For more information see [comparison method](https://github.com/liabru/matter-js/pull/794).
+
+```ocaml
+Output comparison of 43 examples against previous release matter-js@0.17.1  
+
+Behaviour    99.99%   Similarity  99.98%   Overlap   -0.00%  
+Performance  +40.62%   Memory      -6.18%   Filesize  -0.16%  77.73 KB  
+
+airFriction · · avalanche ● · ballPool · · bridge · · car · · catapult · · 
+chains · · circleStack · · cloth · · collisionFiltering · · compositeManipulation ● · 
+compound · · compoundStack · · concave · · constraints ● · doublePendulum · · 
+events · · friction · · gravity · · gyro · · manipulation · ◆ 
+mixed · · newtonsCradle · · pyramid · · ragdoll · · raycasting · · 
+remove · · restitution · · rounded · · sensors · · sleeping · ◆ 
+slingshot · · softBody · · sprites · · stack · · staticFriction · · 
+stats · · stress · · stress2 · · stress3 · · timescale · · 
+views · · wreckingBall · ·   
+
+where  · no change  ● extrinsics changed  ◆ intrinsics changed
+```
+
+### Contributors ♥︎
+
+Many thanks to the [contributors](https://github.com/liabru/matter-js/compare/0.17.1...0.18.0) of this release, [past contributors](https://github.com/liabru/matter-js/graphs/contributors) as well those involved in the [community](https://github.com/liabru/matter-js/issues) for your input and support.
+
+---
+
 ## ▲.● matter.js `0.17.0`
 
 Release notes for `0.17.0`. See the release [readme](https://github.com/liabru/matter-js/blob/0.17.0/README.md) for further information.

demo/index.html

@@ -50,11 +50,11 @@
     </style>
   </head>
   <body>
-    <script src="./js/matter-demo.main.5a504f.min.js"></script>
-    <script src="./js/matter-demo.matter-tools.5e580e.min.js"></script>
-    <script src="./js/matter-demo.matter-wrap.b3a896.min.js"></script>
-    <script src="./js/matter-demo.pathseg.067c95.min.js"></script>
-    <script src="./js/matter-demo.poly-decomp.59954b.min.js"></script>
-    <script src="./js/matter-demo.e7da73.min.js"></script>
+    <script src="./js/matter-demo.main.5754e1.min.js"></script>
+    <script src="./js/matter-demo.matter-tools.97f38a.min.js"></script>
+    <script src="./js/matter-demo.matter-wrap.dbda1f.min.js"></script>
+    <script src="./js/matter-demo.pathseg.cf21c2.min.js"></script>
+    <script src="./js/matter-demo.poly-decomp.c3d015.min.js"></script>
+    <script src="./js/matter-demo.a280d3.min.js"></script>
   </body>
 </html>

demo/js/matter-demo.main.5754e1.min.js

@@ -1,5 +1,5 @@
 /*!
- * matter-demo bundle 0.17.1 by @liabru
+ * matter-demo bundle 0.18.0 by @liabru
  * http://brm.io/matter-js/
  * License MIT
  */!function(e){function t(t){for(var n,l,a=t[0],f=t[1],i=t[2],c=0,s=[];c<a.length;c++)l=a[c],Object.prototype.hasOwnProperty.call(o,l)&&o[l]&&s.push(o[l][0]),o[l]=0;for(n in f)Object.prototype.hasOwnProperty.call(f,n)&&(e[n]=f[n]);for(p&&p(t);s.length;)s.shift()();return u.push.apply(u,i||[]),r()}function r(){for(var e,t=0;t<u.length;t++){for(var r=u[t],n=!0,a=1;a<r.length;a++){var f=r[a];0!==o[f]&&(n=!1)}n&&(u.splice(t--,1),e=l(l.s=r[0]))}return e}var n={},o={1:0},u=[];function l(t){if(n[t])return n[t].exports;var r=n[t]={i:t,l:!1,exports:{}};return e[t].call(r.exports,r,r.exports,l),r.l=!0,r.exports}l.m=e,l.c=n,l.d=function(e,t,r){l.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},l.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},l.t=function(e,t){if(1&t&&(e=l(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(l.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var n in e)l.d(r,n,function(t){return e[t]}.bind(null,n));return r},l.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return l.d(t,"a",t),t},l.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},l.p="./js";var a=this.webpackJsonpMatterDemo=this.webpackJsonpMatterDemo||[],f=a.push.bind(a);a.push=t,a=a.slice();for(var i=0;i<a.length;i++)t(a[i]);var p=f;r()}([]);

demo/js/matter-demo.matter-tools.97f38a.min.js

@@ -1,5 +1,5 @@
 /*!
- * matter-demo bundle 0.17.1 by @liabru
+ * matter-demo bundle 0.18.0 by @liabru
  * http://brm.io/matter-js/
  * License MIT
  */

demo/js/matter-demo.matter-wrap.dbda1f.min.js

@@ -1,5 +1,5 @@
 /*!
- * matter-demo bundle 0.17.1 by @liabru
+ * matter-demo bundle 0.18.0 by @liabru
  * http://brm.io/matter-js/
  * License MIT
  */

demo/js/matter-demo.pathseg.cf21c2.min.js

@@ -1,5 +1,5 @@
 /*!
- * matter-demo bundle 0.17.1 by @liabru
+ * matter-demo bundle 0.18.0 by @liabru
  * http://brm.io/matter-js/
  * License MIT
  */

demo/js/matter-demo.poly-decomp.c3d015.min.js

@@ -1,5 +1,5 @@
 /*!
- * matter-demo bundle 0.17.1 by @liabru
+ * matter-demo bundle 0.18.0 by @liabru
  * http://brm.io/matter-js/
  * License MIT
  */

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "matter-js",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "matter-js",
-      "version": "0.17.1",
+      "version": "0.18.0",
       "license": "MIT",
       "devDependencies": {
         "conventional-changelog-cli": "^2.1.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "matter-js",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "license": "MIT",
   "homepage": "http://brm.io/matter-js/",
   "author": "Liam Brummitt <liam@brm.io> (http://brm.io/)",