phaser/src/actions/PlaceOnRectangle.js

54 lines
1.5 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
var MarchingAnts = require('../geom/rectangle/MarchingAnts');
var RotateLeft = require('../utils/array/RotateLeft');
var RotateRight = require('../utils/array/RotateRight');
// Place the items in the array around the perimeter of the given rectangle.
// Placement starts from the top-left of the rectangle, and proceeds in a
// clockwise direction. If the shift parameter is given you can offset where
// placement begins.
2017-10-04 16:05:26 +00:00
/**
* [description]
*
* @function Phaser.Actions.PlaceOnRectangle
* @since 3.0.0
2018-03-20 14:57:12 +00:00
*
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
2017-10-04 16:05:26 +00:00
* @param {Phaser.Geom.Rectangle} rect - [description]
* @param {integer} [shift=1] - [description]
2017-10-06 02:05:01 +00:00
*
2017-10-04 16:05:26 +00:00
* @return {array} The array of Game Objects that was passed to this Action.
*/
var PlaceOnRectangle = function (items, rect, shift)
{
if (shift === undefined) { shift = 0; }
var points = MarchingAnts(rect, false, items.length);
if (shift > 0)
{
RotateLeft(points, shift);
}
else if (shift < 0)
{
RotateRight(points, Math.abs(shift));
}
for (var i = 0; i < items.length; i++)
{
items[i].x = points[i].x;
items[i].y = points[i].y;
}
return items;
};
module.exports = PlaceOnRectangle;