mirror of
https://github.com/photonstorm/phaser
synced 2024-12-26 13:03:36 +00:00
116 lines
4.1 KiB
JavaScript
116 lines
4.1 KiB
JavaScript
/**
|
|
* @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 AlignIn = require('../display/align/in/QuickSet');
|
|
var CONST = require('../display/align/const');
|
|
var GetFastValue = require('../utils/object/GetFastValue');
|
|
var NOOP = require('../utils/NOOP');
|
|
var Zone = require('../gameobjects/zone/Zone');
|
|
|
|
var tempZone = new Zone({ sys: { queueDepthSort: NOOP }}, 0, 0, 1, 1);
|
|
|
|
/**
|
|
* @typedef {object} GridAlignConfig
|
|
*
|
|
* @property {integer} [width=-1] - The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.
|
|
* If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.
|
|
* @property {integer} [height=-1] - The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.
|
|
* If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.
|
|
* @property {boolean} [cellWidth=1] - The width of the cell, in pixels, in which the item is positioned.
|
|
* @property {integer} [cellHeight=1] - The height of the cell, in pixels, in which the item is positioned.
|
|
* @property {integer} [position=0] - The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.
|
|
* @property {number} [x=0] - Optionally place the top-left of the final grid at this coordinate.
|
|
* @property {number} [y=0] - Optionally place the top-left of the final grid at this coordinate.
|
|
*/
|
|
|
|
/**
|
|
* Takes an array of Game Objects, or any objects that have public `x` and `y` properties,
|
|
* and then aligns them based on the grid configuration given to this action.
|
|
*
|
|
* @function Phaser.Actions.GridAlign
|
|
* @since 3.0.0
|
|
*
|
|
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
|
* @param {GridAlignConfig} options - The GridAlign Configuration object.
|
|
*
|
|
* @return {array} The array of objects that were passed to this Action.
|
|
*/
|
|
var GridAlign = function (items, options)
|
|
{
|
|
if (options === undefined) { options = {}; }
|
|
|
|
var width = GetFastValue(options, 'width', -1);
|
|
var height = GetFastValue(options, 'height', -1);
|
|
var cellWidth = GetFastValue(options, 'cellWidth', 1);
|
|
var cellHeight = GetFastValue(options, 'cellHeight', cellWidth);
|
|
var position = GetFastValue(options, 'position', CONST.TOP_LEFT);
|
|
var x = GetFastValue(options, 'x', 0);
|
|
var y = GetFastValue(options, 'y', 0);
|
|
|
|
var cx = 0;
|
|
var cy = 0;
|
|
var w = (width * cellWidth);
|
|
var h = (height * cellHeight);
|
|
|
|
tempZone.setPosition(x, y);
|
|
tempZone.setSize(cellWidth, cellHeight);
|
|
|
|
for (var i = 0; i < items.length; i++)
|
|
{
|
|
AlignIn(items[i], tempZone, position);
|
|
|
|
if (width === -1)
|
|
{
|
|
// We keep laying them out horizontally until we've done them all
|
|
cy += cellHeight;
|
|
tempZone.y += cellHeight;
|
|
|
|
if (cy === h)
|
|
{
|
|
cy = 0;
|
|
tempZone.x += cellWidth;
|
|
tempZone.y = y;
|
|
}
|
|
}
|
|
else if (height === -1)
|
|
{
|
|
// We keep laying them out vertically until we've done them all
|
|
cx += cellWidth;
|
|
tempZone.x += cellWidth;
|
|
|
|
if (cx === w)
|
|
{
|
|
cx = 0;
|
|
tempZone.x = x;
|
|
tempZone.y += cellHeight;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// We keep laying them out until we hit the column limit
|
|
cx += cellWidth;
|
|
tempZone.x += cellWidth;
|
|
|
|
if (cx === w)
|
|
{
|
|
cx = 0;
|
|
cy += cellHeight;
|
|
tempZone.x = x;
|
|
tempZone.y += cellHeight;
|
|
|
|
if (cy === h)
|
|
{
|
|
// We've hit the column limit, so return, even if there are items left
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return items;
|
|
};
|
|
|
|
module.exports = GridAlign;
|