added note in docs about vertices order

liabru · Jun 25, 2016 · ad033f5 · ad033f5
1 parent 1340159
commit ad033f5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/src/body/Body.js b/src/body/Body.js
@@ -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.
      * 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.
      * @method create
      * @param {} options

diff --git a/src/geometry/Vertices.js b/src/geometry/Vertices.js
@@ -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,
      * 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.
      *
      * @method create