| Documentation

ShelfPack ▸
- Instance members
- #pack
- #packOne
- #clear
- #resize

ShelfPack

Create a new ShelfPack bin allocator.

Uses the Shelf Best Height Fit algorithm from http://clb.demon.fi/files/RectangleBinPack.pdf

ShelfPack(w: [number], h: [number], options: [Object])

Parameters

([number]
            (default 64)
            )

Initial width of the sprite

([number]
            (default 64)
            )

Initial width of the sprite

options ([Object])

Name	Description
options.autoResize `[boolean]` (default `false`)	If `true` , the sprite will automatically grow

Example

var sprite = new ShelfPack(64, 64, { autoResize: false });

Instance Members

pack (bins, [options])

Batch pack multiple bins into the sprite.

pack(bins: Array, options: [Object]): Array

Parameters

bins (Array) Array of requested bins - each object should have width , height (or w , h ) properties

options ([Object])

Name	Description
options.inPlace `[boolean]` (default `false`)	If `true` , the supplied bin objects will be updated inplace with `x` and `y` properties

Returns

Array: Array of allocated bins - each bin is an object with x , y , w , h properties

Example

var bins = [
    { id: 'a', width: 12, height: 12 },
    { id: 'b', width: 12, height: 16 },
    { id: 'c', width: 12, height: 24 }
];
var results = sprite.pack(bins, { inPlace: false });

packOne (w, h)

clear ()

resize (w, h)