foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-11-30 10:20:52 -05:00
Code Issues Wiki Activity

added note in docs about vertices order

Browse source
This commit is contained in:
liabru 2016-06-25 18:02:06 +01:00
parent 1340159451
commit ad033f5255
2 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/body/Body.js
View file

@ -30,6 +30,7 @@ var Axes = require('../geometry/Axes');
/** /**
* Creates a new rigid body model. The options parameter is an object that specifies any properties you wish to override the defaults. * Creates a new rigid body model. The options parameter is an object that specifies any properties you wish to override the defaults.
* All properties have default values, and many are pre-calculated automatically based on other properties. * All properties have default values, and many are pre-calculated automatically based on other properties.
* Vertices must be specified in clockwise order.
* See the properties section below for detailed information on what you can pass via the `options` object. * See the properties section below for detailed information on what you can pass via the `options` object.
* @method create * @method create
* @param {} options * @param {} options

2
src/geometry/Vertices.js
View file

@ -26,6 +26,8 @@ var Common = require('../core/Common');
* The `Vertices.create` method returns a new array of vertices, which are similar to Matter.Vector objects, * The `Vertices.create` method returns a new array of vertices, which are similar to Matter.Vector objects,
* but with some additional references required for efficient collision detection routines. * but with some additional references required for efficient collision detection routines.
* *
* Vertices must be specified in clockwise order.
*
* Note that the `body` argument is not optional, a `Matter.Body` reference must be provided. * Note that the `body` argument is not optional, a `Matter.Body` reference must be provided.
* *
* @method create * @method create