Function FitToRegion

src/actions/FitToRegion.js:45–95

(items, scaleMode, region, itemCoverage)

 * @return {Phaser.GameObjects.GameObject[]} - The items that were fitted.
 */
var FitToRegion = function (items, scaleMode, region, itemCoverage)
{
    if (!Array.isArray(items)) { items = [ items ]; }
    if (scaleMode === undefined) { scaleMode = 0; }
    if (!region)
    {
        var scene = items[0].scene;
        region = new Rectangle(0, 0, scene.scale.width, scene.scale.height);
    }
    if (!itemCoverage) { itemCoverage = {}; }

    for (var i = 0; i < items.length; i++)
    {
        var item = items[i];
        var itemWidth = GetFastValue(itemCoverage, 'width', GetFastValue(item, 'width', 1));
        var itemHeight = GetFastValue(itemCoverage, 'height', GetFastValue(item, 'height', 1));
        var itemOriginX = GetFastValue(itemCoverage, 'originX', GetFastValue(item, 'originX', 0.5));
        var itemOriginY = GetFastValue(itemCoverage, 'originY', GetFastValue(item, 'originY', 0.5));

        // Reposition item.
        item.x = region.x + region.width * itemOriginX;
        item.y = region.y + region.height * itemOriginY;

        // Compute relative scales.
        var itemScaleXToRegion = region.width / itemWidth;
        var itemScaleYToRegion = region.height / itemHeight;
        switch (scaleMode)
        {
            case -1:
            {
                // Scale to fit the inside of the region.
                item.setScale(Math.min(itemScaleXToRegion, itemScaleYToRegion));
                break;
            }
            case 0:
            {
                // Scale both axes independently to match the region.
                item.setScale(itemScaleXToRegion, itemScaleYToRegion);
                break;
            }
            case 1:
            {
                // Scale to envelop the outside of the region.
                item.setScale(Math.max(itemScaleXToRegion, itemScaleYToRegion));
                break;
            }
        }
    }

    return item;
};

module.exports = FitToRegion;