com.github.wuic.engine.core

Class BinPacker<T>

java.lang.Object

com.github.wuic.engine.core.BinPacker<T>

All Implemented Interfaces:

DimensionPacker<T>, Comparator<T>

public final class BinPacker<T>
extends Object
implements Comparator<T>, DimensionPacker<T>

This packer is inspired from the grower bin packing algorithm explained by Jakes Gordon to give a position to a set of dimensions in the lowest area.

Comparator interface is implemented to guarantee that dimensions will be packed beginning with the biggest one (width * height).

Since:

0.2.3

Version:

1.4

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
BinPacker() Builds a new packer.

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(Dimension dimension, T data) Adds a new dimension with its associated data to the elements to be packed.
void	clearElements() Clears all the elements previously added.
int	compare(T a, T b)
Dimension	getFilledArea() Returns the area which contains all the filled zones.
Map<Region,T>	getRegions() Packs and returns the regions which result of the computation of the dimension indicated thanks to the DimensionPacker.addElement(Dimension, Object) method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

BinPacker

public BinPacker()

Builds a new packer.

Method Detail

addElement

public void addElement(Dimension dimension,
              T data)

Adds a new dimension with its associated data to the elements to be packed.

Specified by:

addElement in interface DimensionPacker<T>

Parameters:

dimension - the dimension

data - the data.

getRegions

public Map<Region,T> getRegions()

Packs and returns the regions which result of the computation of the dimension indicated thanks to the DimensionPacker.addElement(Dimension, Object) method.

Specified by:

getRegions in interface DimensionPacker<T>

Returns:

the packed regions

getFilledArea

public Dimension getFilledArea()

Returns the area which contains all the filled zones.

Specified by:

getFilledArea in interface DimensionPacker<T>

Returns:

the filled area

compare

public int compare(T a,
          T b)

Specified by:

compare in interface Comparator<T>

clearElements

public void clearElements()

Clears all the elements previously added.

Specified by:

clearElements in interface DimensionPacker<T>