rectangle-bin-pack

Fast (in native c++) implementation of bin packing algorithm for Node.js. Based on https://github.com/juj/RectangleBinPack.

Information

Package	rectangle-bin-pack
Description	Fast rect packer
Node Version	>= 0.10

Install

$ npm install --save-dev rectangle-bin-pack

Usage

var rbp = require('rectangle-bin-pack');
 
var rects = [{w: 10, h: 10}, {w: 25, h: 25}, {w: 15, h: 15}];
rbp.solveSync({w: 50, h: 25}, rects);
console.log(rects);

[ { w: 10, h: 10, x: 0, y: 0 },
  { w: 25, h: 25, x: 25, y: 0 },
  { w: 15, h: 15, x: 25, y: 15 } ]

API

solveSync(options, rects);

Pack rectangles from rects array in place. rects is an array of objects with w (width) and h (height) fields (sure, the objects can have other fields as well). After successful execution, every object will have two additional fields: x and y.

solve(options, rects, cb);

Pack rectangles and return new array in callback. Same as solveSync, but works asynchronously, and return an array of objects with two fields: x and y.

options

w - width of bin (required)
h - height of bin (required)
alg - type of algorithm (default BestAreaFit):
- BestShortSideFit or BSSF
- BestLongSideFit or BLSF
- BestAreaFit or BAF
- BottomLeftRule or BL
- ContactPointRule or CP

LICENSE

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.