Skip to content

Commit

Permalink
improve docs for Bodies.fromVertices
Browse files Browse the repository at this point in the history
  • Loading branch information
liabru committed Jan 31, 2021
1 parent e87f64a commit 2ade78f
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions src/factory/Bodies.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,31 @@ var Vector = require('../geometry/Vector');
};

/**
* Creates a body using the supplied vertices (or an array containing multiple sets of vertices).
* If the vertices are convex, they will pass through as supplied.
* Otherwise if the vertices are concave, they will be decomposed if [poly-decomp.js](https://github.com/schteppe/poly-decomp.js) is available.
* Note that this process is not guaranteed to support complex sets of vertices (e.g. those with holes may fail).
* By default the decomposition will discard collinear edges (to improve performance).
* It can also optionally discard any parts that have an area less than `minimumArea`.
* If the vertices can not be decomposed, the result will fall back to using the convex hull.
* The options parameter is an object that specifies any `Matter.Body` properties you wish to override the defaults.
* Creates a body based on set(s) of vertices.
*
* This utility builds on top of `Body.create` to automatically handle concave inputs.
*
* To use this decomposition feature the [poly-decomp](https://github.com/schteppe/poly-decomp.js)
* package should be additionally installed via npm or as a global.
*
* The resulting vertices are reorientated about their centre of mass,
* and offset such that `body.position` corresponds to this point.
*
* If needed the resulting offset may be found by subtracting `body.bounds` from the original input bounds.
* To later move the centre of mass see `Body.setCentre`.
*
* Note that decomposition results are not always perfect.
*
* For best results, simplify the input vertices as much as possible first.
* By default this function applies some addtional simplification to help.
*
* Some outputs may also require further manual processing afterwards to be robust.
*
* In particular some parts may need to be overlapped to avoid collision gaps.
* Thin parts and sharp points should be avoided or removed where possible.
*
* The options parameter object specifies any `Matter.Body` properties you wish to override the defaults.
*
* See the properties section of the `Matter.Body` module for detailed information on what you can pass via the `options` object.
* @method fromVertices
* @param {number} x
Expand Down Expand Up @@ -345,6 +362,8 @@ var Vector = require('../geometry/Vector');
if (parts.length > 1) {
// create the parent body to be returned, that contains generated compound parts
body = Body.create(Common.extend({ parts: parts.slice(0) }, options));

// offset such that body.position is at the centre off mass
Body.setPosition(body, { x: x, y: y });

return body;
Expand Down

0 comments on commit 2ade78f

Please sign in to comment.