com.github.wuic.engine

Interface DimensionPacker<T>

Type Parameters:

T - a type of data associated to the dimensions

All Known Implementing Classes:

BinPacker

public interface DimensionPacker<T>

A packer packs a set of dimensions (2d) in the smalled area.

Since:

0.2.3

Version:

1.0

Author:

Guillaume DROUET

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.
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 addElement(Dimension, Object) method.

Method Detail

addElement

void addElement(Dimension dimension,
              T data)

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

Parameters:

dimension - the dimension

data - the data.

clearElements

void clearElements()

Clears all the elements previously added.

getRegions

Map<Region,T> getRegions()

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

Returns:

the packed regions

getFilledArea

Dimension getFilledArea()

Returns the area which contains all the filled zones.

Returns:

the filled area