phaser4-rex-plugins/plugins/utils/geom/point/GetCentroid.js

Plugins of phaser4

/**
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2019 Photon Storm Ltd.
 * @license      {@link https://opensource.org/licenses/MIT|MIT License}
 */

import Point from './Point.js';

/**
 * Get the centroid or geometric center of a plane figure (the arithmetic mean position of all the points in the figure).
 * Informally, it is the point at which a cutout of the shape could be perfectly balanced on the tip of a pin.
 *
 * @function Phaser.Geom.Point.GetCentroid
 * @since 3.0.0
 *
 * @generic {Phaser.Geom.Point} O - [out,$return]
 *
 * @param {Phaser.Geom.Point[]} points - [description]
 * @param {Phaser.Geom.Point} [out] - [description]
 *
 * @return {Phaser.Geom.Point} [description]
 */
var GetCentroid = function (points, out) {
    if (out === undefined) { out = new Point(); }

    if (!Array.isArray(points)) {
        throw new Error('GetCentroid points argument must be an array');
    }

    var len = points.length;

    if (len < 1) {
        throw new Error('GetCentroid points array must not be empty');
    }
    else if (len === 1) {
        out.x = points[0].x;
        out.y = points[0].y;
    }
    else {
        for (var i = 0; i < len; i++) {
            out.x += points[i].x;
            out.y += points[i].y;
        }

        out.x /= len;
        out.y /= len;
    }

    return out;
};

export default GetCentroid;