Added ParseOBJ type defs

Author: photonstorm

src/gameobjects/mesh/Mesh.js

@@ -255,6 +255,8 @@ var Mesh = new Class({
      * moved or rotated. You can scale the model data, should it be too small, or too large, to see.
      * You can also offset the vertices of the model via the `x`, `y` and `z` parameters.
      *
+     * If you wish to add OBJ data to this Mesh without loading it, you can call the `Mesh.addModel` method directly.
+     *
      * @method Phaser.GameObjects.Mesh#addOBJ
      * @since 3.50.0
      *
@@ -369,7 +371,7 @@ var Mesh = new Class({
      * The obj should have been parsed in advance via the ParseObj function:
      *
      * ```javascript
-     * var data = Phaser.Geom.ParseObj(rawData, flipUV);
+     * var data = Phaser.Geom.Mesh.ParseObj(rawData, flipUV);
      *
      * Mesh.addModel(data);
      * ```
@@ -385,7 +387,7 @@ var Mesh = new Class({
      * @method Phaser.GameObjects.Mesh#addModel
      * @since 3.50.0
      *
-     * @param {array} data - The parsed model data array.
+     * @param {Phaser.Types.Geom.Mesh.OBJData} data - The parsed OBJ model data.
      * @param {number} [scale=1] - An amount to scale the model data by. Use this if the model has exported too small, or large, to see.
      * @param {number} [x=0] - Offset the model x position by this amount.
      * @param {number} [y=0] - Offset the model y position by this amount.

src/geom/mesh/ParseObj.js

@@ -224,16 +224,17 @@ function parseUseMtl (lineItems)
 }
 
 /**
- * Parses a Wavefront OBJ File, extracting the models from it and returning them
- * in an array. The model data *must* be triangulated.
+ * Parses a Wavefront OBJ File, extracting the models from it and returning them in an array.
+ *
+ * The model data *must* be triangulated for a Mesh Game Object to be able to render it.
  *
  * @function Phaser.Geom.Mesh.ParseObj
  * @since 3.50.0
  *
  * @param {string} data - The OBJ File data as a raw string.
- * @param {boolean} [flipUV=true] - Flip the UV data?
+ * @param {boolean} [flipUV=true] - Flip the UV coordinates?
  *
- * @return {object} The parsed model data.
+ * @return {Phaser.Types.Geom.Mesh.OBJData} The parsed model and material data.
  */
 var ParseObj = function (data, flipUV)
 {

src/geom/mesh/typedefs/OBJData.js

@@ -0,0 +1,7 @@
+/**
+ * @typedef {object} Phaser.Types.Geom.Mesh.OBJData
+ * @since 3.50.0
+ *
+ * @property {string[]} materialLibraries - An array of material libraries in the OBJ file.
+ * @property {Phaser.Types.Geom.Mesh.OBJModel[]} models - An array of parsed models extracted from the OBJ file.
+ */

src/geom/mesh/typedefs/OBJFace.js

@@ -0,0 +1,8 @@
+/**
+ * @typedef {object} Phaser.Types.Geom.Mesh.OBJFace
+ * @since 3.50.0
+ *
+ * @property {string} group - The name of the Group this Face is in.
+ * @property {string} material - The name of the material this Face uses.
+ * @property {Phaser.Types.Geom.Mesh.OBJFaceVertice[]} vertices - An array of vertices in this Face.
+ */

src/geom/mesh/typedefs/OBJFaceVertice.js

@@ -0,0 +1,8 @@
+/**
+ * @typedef {object} Phaser.Types.Geom.Mesh.OBJFaceVertice
+ * @since 3.50.0
+ *
+ * @property {number} textureCoordsIndex - The index in the `textureCoords` array that this vertex uses.
+ * @property {number} vertexIndex - The index in the `vertices` array that this vertex uses.
+ * @property {number} vertexNormalIndex - The index in the `vertexNormals` array that this vertex uses.
+ */

src/geom/mesh/typedefs/OBJModel.js

@@ -0,0 +1,10 @@
+/**
+ * @typedef {object} Phaser.Types.Geom.Mesh.OBJModel
+ * @since 3.50.0
+ *
+ * @property {Phaser.Types.Geom.Mesh.OBJFace[]} faces - An array of Faces.
+ * @property {string} name - The name of the model.
+ * @property {Phaser.Types.Geom.Mesh.UV[]} textureCoords - An array of texture coordinates.
+ * @property {Phaser.Types.Math.Vector3Like[]} vertexNormals - An array of vertex normals.
+ * @property {Phaser.Types.Math.Vector3Like[]} vertices - An array of vertices in the model.
+ */

src/geom/mesh/typedefs/UV.js

@@ -0,0 +1,8 @@
+/**
+ * @typedef {object} Phaser.Types.Geom.Mesh.UV
+ * @since 3.50.0
+ *
+ * @property {number} u - The u component.
+ * @property {number} v - The v component.
+ * @property {number} w - The w component.
+ */

src/geom/mesh/typedefs/index.js

@@ -0,0 +1,9 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * @namespace Phaser.Types.Geom.Mesh
+ */

src/geom/typedefs/index.js

@@ -0,0 +1,9 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * @namespace Phaser.Types.Geom
+ */