0.0.1 • Published 4 years ago

2d-bounding-box v0.0.1

Weekly downloads
40
License
MIT
Repository
github
Last release
4 years ago

simple 2d bounding box library

Note, this is still in alpha and may contain lots and lots of bugs. Please make an issue if you encounter a bug.

To use it:

let BoundingBox = require('2d-bounding-box');

let bb_create = new BoundingBox( min_x, min_y, max_x, max_y, [origin_type]);

Sometimes you already have an entity with a certain width and height, and you wish to create a bounding box based on the dimensions of this creature without having to calculate the correct positions yourself.

Important is for these calculations that you define where the origin of your entity is. Is it smack in the middle of the entity that decides the position or anywhere around the entity, bottom left for example.

let bb_from_entity = BoundingBox.create( origin_type, position_x, position_y, width, height);

For the origin type there are 9 possible options:

BoundingBox.ORIGIN_CENTER;
BoundingBox.ORIGIN_LEFT_BOTTOM;
BoundingBox.ORIGIN_RIGHT_BOTTOM;
BoundingBox.ORIGIN_CENTER_BOTTOM;
BoundingBox.ORIGIN_LEFT_CENTER;
BoundingBox.ORIGIN_LEFT_TOP;
BoundingBox.ORIGIN_CENTER_TOP;
BoundingBox.ORIGIN_RIGHT_TOP;
BoundingBox.ORIGIN_RIGHT_CENTER;

If you need more options, you will have to calculate the offsets yourself and instantiate the bounding box via the new BoundingBox(...) method.

Please see the demo_basic_bb.html file in the demo directory for examples.

If you wish to fiddle with the demo_basic.js file recompile it with gulp less browserify before refreshing the demo_basic_bb.html file.