layout/vertical

Constructor for the vertical canvas layout manager. Used to determine canvas dimensions and to place sprites without intersections (overlap). Places sprites in a vertical column

http://draeton.github.io/stitches
Copyright 2013 Matthew Cobbs
Licensed under the MIT license.

 
define([
    "wrap/jquery",
    "util/util",
    "layout/base"
],
function ($, util, BaseLayout) {

    "use strict";

    var defaults = {
        maxPass: 2 // number of tries to place sprite
    };

VerticalLayout

Create a new VerticalLayout instance

Params
options object 
    var VerticalLayout = function (options) {
        this.settings = $.extend({}, defaults, options);
    };

    util.inherit(VerticalLayout, BaseLayout, {

@getDimensions

Returns an object with the width and height necessary to contain the sprites. Calculation based on adding all of the sprite heights.

Params
sprites array The list of sprites to size for
defaults object Default width and height, if no sprites
Returns
object 
        getDimensions: function (sprites, defaults) {
            var width = 0;
            var height = 0;

            $.map(sprites, function (sprite) {
                width = sprite.width > width ? sprite.width : width;
                height += sprite.height;
            });

            return {
                width: width || defaults.width,
                height: height || defaults.height
            };
        },

@placeSprite

Determine sprite coordinates on the canvas. Once a position is determined with no intersections, the sprite is added to the placed array. If there is no space, the dimensions are updated. Seeks down to place the sprite.

Params
sprite Sprite The sprite to place
placed array An array of sprites already placed
dimensions object The current canvas dimensions 
        placeSprite: function (sprite, placed, dimensions) {
            var intersection;
            var pass = 0;
            var x = 0;
            var y = 0;

            while (pass++ < this.settings.maxPass) {
                for (y = 0; y <= dimensions.height - sprite.height; y++) {
                    sprite.x = x;
                    sprite.y = y;

                    intersection = this.intersection(sprite, placed);

                    if (!intersection) {
                        placed.push(sprite);
                        sprite.show();
                        return true;
                    }

                    y = intersection.y + intersection.height - 1;
                }

                dimensions.width += sprite.width;
                dimensions.height += sprite.height;
            }

            return false;
        }
    });

    return VerticalLayout;

});