https://github.com/barisyild/hxpotpack
A tiny rectangle packing haxe library (for sprite layouts)
https://github.com/barisyild/hxpotpack
algorithms haxe packing port potpack sprites
Last synced: about 2 months ago
JSON representation
A tiny rectangle packing haxe library (for sprite layouts)
- Host: GitHub
- URL: https://github.com/barisyild/hxpotpack
- Owner: barisyild
- License: isc
- Created: 2023-07-13T15:56:01.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T01:56:29.000Z (12 months ago)
- Last Synced: 2025-02-28T10:22:12.782Z (2 months ago)
- Topics: algorithms, haxe, packing, port, potpack, sprites
- Language: Haxe
- Homepage:
- Size: 8.79 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hxpotpack
hxpotpack is the haxe port of the original [potpack](https://github.com/mapbox/potpack) project.
A variation of algorithms used in [rectpack2D](https://github.com/TeamHypersomnia/rectpack2D) and [bin-pack](https://github.com/bryanburgers/bin-pack), which are in turn based on [this article by Blackpawn](http://blackpawn.com/texts/lightmaps/default.html).
## Ordered Example usage
```haxe
import haxe.ds.Vector;
import hx.potpack.Potpack;
import hx.potpack.geom.PotpackRectangle; //or you can import "openfl.display.Rectangle" for openfl
class Test {
static function main() {
final boxes:Vector = new Vector(2);
boxes.set(0, new PotpackRectangle(0, 0, 300, 50));
boxes.set(1, new PotpackRectangle(0, 0, 100, 200));
final data = Potpack.pack(boxes);
trace('width: ${data.width}, height: ${data.height}, rect size: ${data.size} fill: ${data.fill}');
// potpack mutates the boxes array: it's sorted by height,
// and box objects are augmented with x, y coordinates:
trace(boxes[0]); // {x: 0, y: 200, width: 300, height: 50}
trace(boxes[1]); // {x: 0, y: 0, width: 100, height: 200}
}
}
```
## Unordered Example usage
```haxe
import haxe.ds.Vector;
import hx.potpack.Potpack;
import hx.potpack.geom.PotpackRectangle; //or you can import "openfl.display.Rectangle" for openfl
class Test {
static function main() {
final boxes:Vector = new Vector(2);
boxes.set(0, new PotpackRectangle(0, 0, 300, 50));
boxes.set(1, new PotpackRectangle(0, 0, 100, 200));
final data = Potpack.pack(boxes, false);
trace('width: ${data.width}, height: ${data.height}, rect size: ${data.size} fill: ${data.fill}');
// potpack mutates the boxes array: it's sorted by height,
// and box objects are augmented with x, y coordinates:
trace(boxes[0]); // {x: 0, y: 0, width: 100, height: 200}
trace(boxes[1]); // {x: 0, y: 200, width: 300, height: 50}
}
}
```
## Compatibility
Compatible with all haxe projects.
There is an additional compatibility feature for OpenFL, you can use OpenFL Rectangles.
## Install Release Version
Install with haxelib: `haxelib install hxpotpack`
## Install Development Version
Install with haxelib: `haxelib git hxpotpack https://github.com/barisyild/hxpotpack.git`
### Original project created by [Mapbox](https://github.com/mapbox)