Package org.neuroml.export.svg

Class RectanglePacker<P>

java.lang.Object

org.neuroml.export.svg.RectanglePacker<P>

Type Parameters:

P - The type of items to be held

public class RectanglePacker<P>
extends Object

Tries to pack rectangles as tightly as possible. An implementation of the algorithm described at http://www.blackpawn.com/texts/lightmaps/default.html

Author:

ryanm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RectanglePacker.Rectangle	Yet another Rectangle class.

Constructor Summary

Constructors

Constructor	Description
RectanglePacker(int width, int height, int border)	Builds a new RectanglePacker

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the packer of all items
RectanglePacker.Rectangle	findRectangle(P item)	Finds the RectanglePacker.Rectangle where an item is stored
int	getHeight()	Gets the height of this packer
int	getWidth()	Gets the width of this packer
RectanglePacker.Rectangle	insert(int width, int height, P o)	Attempts to pack an item of the supplied dimensions
void	inspectRectangles(List<RectanglePacker.Rectangle> rectangles)	Builds a list of all RectanglePacker.Rectangles in the tree, for debugging purposes
boolean	remove(P o)	Removes an item from the tree, consolidating the space if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

RectanglePacker

public RectanglePacker(int width,
                       int height,
                       int border)

Builds a new RectanglePacker

Parameters:

width - The width of the space available to pack into

height - The height of the space available to pack into

border - The border to preserve between packed items

Method Detail

inspectRectangles

public void inspectRectangles(List<RectanglePacker.Rectangle> rectangles)

Builds a list of all RectanglePacker.Rectangles in the tree, for debugging purposes

Parameters:

rectangles - The list to add the tree's RectanglePacker.Rectangles to

findRectangle

public RectanglePacker.Rectangle findRectangle(P item)

Finds the RectanglePacker.Rectangle where an item is stored

Parameters:

item - The item to search for

Returns:

The RectanglePacker.Rectangle where that item resides, or null if not found

clear

public void clear()

Clears the packer of all items

insert

public RectanglePacker.Rectangle insert(int width,
                                        int height,
                                        P o)

Attempts to pack an item of the supplied dimensions

Parameters:

width - The width of the item

height - The height of the item

o - The item to pack

Returns:

The packed location, or null if it will not fit.

remove

public boolean remove(P o)

Removes an item from the tree, consolidating the space if possible. The space can easily become fragmented, so don't rely on this to work as cleverly as you would like.

Parameters:

o - the item to remove

Returns:

true if the item was found, false otherwise

getWidth

public int getWidth()

Gets the width of this packer

Returns:

the width of this packer

getHeight

public int getHeight()

Gets the height of this packer

Returns:

The height of this packer