net.richarddawkins.watchmaker.geom

Class GridBoxManager

java.lang.Object

net.richarddawkins.watchmaker.geom.BoxManager

net.richarddawkins.watchmaker.geom.GridBoxManager

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

public class GridBoxManager
extends BoxManager

Author:

Alan

Constructor Summary

Constructors

Constructor and Description
GridBoxManager()
GridBoxManager(int cols)
GridBoxManager(int cols, int rows) Construct a cols * rows array of boxes.

Method Summary

Modifier and Type	Method and Description
void	addBox(Rect box)
void	addBox(Rect box, Dim dim)
Rect	firstElement()
Rect	getBox(int boxNo)
int	getBoxCount()
java.util.Vector<Rect>	getBoxes(Dim dimension) For the given dimension of the entire array of boxes, return a vector of Rectangles describing the corners of each box, in row-major order.
Dim	getBoxSize(Rect box, Dim dimension) For the supplied dimension of the entire array of boxes, return the size of one (any) box.
int	getCols()
Rect	getMidBox()
Point	getMidPoint(Dim dimension, Rect box) Given supplied dimension of the entire array of boxes, return the midpoint of the nth box (starting with n = 0).
java.util.Vector<Point>	getMidPoints(Dim dimension) For the given dimension of the entire array of boxes, return a vector of Points describing the midpoints of each box, in row-major order.
int	getRows()
void	setCols(int cols)
void	setRows(int rows)

Methods inherited from class net.richarddawkins.watchmaker.geom.BoxManager

addPropertyChangeListener, getBox, getBoxContainingPoint, getBoxes, getBoxesReversed, getOrigin, getScale, isAccentuateMidBox, moveToEnd, propertyChange, removeBox, removePropertyChangeListener, setAccentuateMidBox, setBox, setScale

Methods inherited from class java.lang.Object

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

Constructor Detail

GridBoxManager

public GridBoxManager(int cols)

GridBoxManager

public GridBoxManager(int cols,
                      int rows)

Construct a cols * rows array of boxes.

Parameters:

cols - the number of columns in the box array.

rows - the number of rows in the box array.

GridBoxManager

public GridBoxManager()

Method Detail

getBoxCount

public int getBoxCount()

Specified by:

getBoxCount in class BoxManager

getMidBox

public Rect getMidBox()

Specified by:

getMidBox in class BoxManager

getCols

public int getCols()

setCols

public void setCols(int cols)

getRows

public int getRows()

setRows

public void setRows(int rows)

getBoxSize

public Dim getBoxSize(Rect box,
                      Dim dimension)

Description copied from class: BoxManager

For the supplied dimension of the entire array of boxes, return the size of one (any) box. The returned box width is the dimension width divided by the number of columns, and the height is the dimension height divided by the number of rows.

Specified by:

getBoxSize in class BoxManager

Parameters:

box - the 0-based index of the box in the collection.

dimension - the size of the overall array of boxes, in pixels

Returns:

the size of an individual box within the array.

getBoxes

public java.util.Vector<Rect> getBoxes(Dim dimension)

Description copied from class: BoxManager

For the given dimension of the entire array of boxes, return a vector of Rectangles describing the corners of each box, in row-major order.

Specified by:

getBoxes in class BoxManager

Parameters:

dimension - the size of the overall array of boxes, in pixels.

Returns:

a Vector of Rectangles representing individual boxes, in row-major order.

getMidPoint

public Point getMidPoint(Dim dimension,
                         Rect box)

Description copied from class: BoxManager

Given supplied dimension of the entire array of boxes, return the midpoint of the nth box (starting with n = 0).

Specified by:

getMidPoint in class BoxManager

Parameters:

dimension - the dimensions of the overall array of boxes.

box - the box to retrieve.

Returns:

the midpoint of the nth Box.

getMidPoints

public java.util.Vector<Point> getMidPoints(Dim dimension)

Description copied from class: BoxManager

For the given dimension of the entire array of boxes, return a vector of Points describing the midpoints of each box, in row-major order.

Specified by:

getMidPoints in class BoxManager

Parameters:

dimension - the dimension of the entire array of boxes, in pixels

Returns:

a Vector of box midpoints, in row-major order.

addBox

public void addBox(Rect box)

Overrides:

addBox in class BoxManager

addBox

public void addBox(Rect box,
                   Dim dim)

Specified by:

addBox in class BoxManager

Parameters:

box - a Rect describing the left, right, top, and bottom of a box.

dim - the dimensions of the grid to which the Rect's coordinates are relative.

getBox

public Rect getBox(int boxNo)

Overrides:

getBox in class BoxManager

firstElement

public Rect firstElement()

Specified by:

firstElement in class BoxManager