net.richarddawkins.watchmaker.geom

Class BoxManager

java.lang.Object

net.richarddawkins.watchmaker.geom.BoxManager

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

FreeBoxManager, GridBoxManager

public abstract class BoxManager
extends java.lang.Object
implements java.beans.PropertyChangeListener

Constructor Summary

Constructors

Constructor and Description
BoxManager()

Method Summary

Modifier and Type	Method and Description
void	addBox(Rect box)
abstract void	addBox(Rect margin, Dim dim)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
abstract Rect	firstElement()
Rect	getBox(int boxNo)
Rect	getBox(int boxNo, Dim size)
Rect	getBoxContainingPoint(Point p, Dim d) Find the box within the array containing a particular point, in reverse order to the natural (drawing) order.
abstract int	getBoxCount()
java.util.Vector<Rect>	getBoxes()
abstract 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.
java.util.Vector<Rect>	getBoxesReversed(Dim scale) Return the boxes in reverse order, so that offspring are "on top" of their ancestors.
abstract Dim	getBoxSize(Rect selectedBox, Dim dimension) For the supplied dimension of the entire array of boxes, return the size of one (any) box.
abstract Rect	getMidBox()
abstract 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).
abstract 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.
Point	getOrigin(Dim size, int selectedBoxNo)
int	getScale()
boolean	isAccentuateMidBox()
void	moveToEnd(Rect box)
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	removeBox(Rect boxedMorphBox)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	setAccentuateMidBox(boolean accentuateMidBox)
void	setBox(Rect box, Rect newBox, Dim size)
void	setScale(int newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxManager

public BoxManager()

Method Detail

moveToEnd

public void moveToEnd(Rect box)

getScale

public int getScale()

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setScale

public void setScale(int newValue)

addBox

public abstract void addBox(Rect margin,
                            Dim dim)

Parameters:

margin - 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.

getBoxCount

public abstract int getBoxCount()

getBoxes

public abstract 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.

Parameters:

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

Returns:

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

getBoxContainingPoint

public Rect getBoxContainingPoint(Point p,
                                  Dim d)

Find the box within the array containing a particular point, in reverse order to the natural (drawing) order. Operating on the reversed order means that offspring precede their parents in search order. This is useful in Pedigree mode, where it is used to ensure that click order follows the reverse of drawing order, so that box-selecting is sane.

Parameters:

p - the point to locate within one of the particular boxes

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

Returns:

the box number containing the given point.

getBoxSize

public abstract Dim getBoxSize(Rect selectedBox,
                               Dim dimension)

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.

Parameters:

selectedBox - 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.

getMidBox

public abstract Rect getMidBox()

getMidPoint

public abstract 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).

Parameters:

dimension - the dimensions of the overall array of boxes.

box - the box to retrieve.

Returns:

the midpoint of the nth Box.

getMidPoints

public abstract 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.

Parameters:

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

Returns:

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

isAccentuateMidBox

public boolean isAccentuateMidBox()

setAccentuateMidBox

public void setAccentuateMidBox(boolean accentuateMidBox)

setBox

public void setBox(Rect box,
                   Rect newBox,
                   Dim size)

getBox

public Rect getBox(int boxNo,
                   Dim size)

removeBox

public void removeBox(Rect boxedMorphBox)

getBoxesReversed

public java.util.Vector<Rect> getBoxesReversed(Dim scale)

Return the boxes in reverse order, so that offspring are "on top" of their ancestors. Useful for z-ordering so that younger morphs overlap their parents in click order as well as drawing order.

Parameters:

scale - the size of the MorphView centre panel in pixels.

Returns:

the same Vector as getBoxes() in reverse order.

getOrigin

public Point getOrigin(Dim size,
                       int selectedBoxNo)

getBoxes

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

getBox

public Rect getBox(int boxNo)

addBox

public void addBox(Rect box)

firstElement

public abstract Rect firstElement()

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)