org.kynosarges.tektosyne.geometry

Class RectLocation

java.lang.Object

org.kynosarges.tektosyne.geometry.RectLocation

public final class RectLocation
extends java.lang.Object

Specifies the location of a point relative to a rectangle. Immutable class containing a pair of LineLocation values indicating the location of each point dimension relative to the corresponding rectangle edge. For this purpose, the rectangle edges are interpreted as directed line segments starting at the minimum coordinate and ending at the maximum coordinate.

Field Summary

Fields

Modifier and Type	Field and Description
LineLocation	edgeX The relative location of the point along the x-coordinate.
LineLocation	edgeY The relative location of the point along the y-coordinate.

Constructor Summary

Constructors

Constructor and Description
RectLocation(LineLocation edgeX, LineLocation edgeY) Creates a RectLocation with the specified dimensional locations.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares the specified Object to this RectLocation instance.
int	hashCode() Returns a hash code for the RectLocation.
java.lang.String	toString() Returns a String representation of the RectLocation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

edgeX

public final LineLocation edgeX

The relative location of the point along the x-coordinate. Holds the LineLocation of the point relative to the rectangle’s top (or bottom) edge, shifted to the point’s y-coordinate. Never null, LineLocation.LEFT, or LineLocation.RIGHT.

edgeY

public final LineLocation edgeY

The relative location of the point along the y-coordinate. Holds the LineLocation of the point relative to the rectangle’s left (or right) edge, shifted to the point’s x-coordinate. Never null, LineLocation.LEFT, or LineLocation.RIGHT.

Constructor Detail

RectLocation

public RectLocation(LineLocation edgeX,
                    LineLocation edgeY)

Creates a RectLocation with the specified dimensional locations.

Parameters:

edgeX - the relative location of the point along the x-coordinate

edgeY - the relative location of the point along the y-coordinate

Throws:

java.lang.NullPointerException - if edgeX or edgeY is null

java.lang.IllegalArgumentException - if edgeX or edgeY is LineLocation.LEFT or LineLocation.RIGHT

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the specified Object to this RectLocation instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the Object to compare to this instance

Returns:

true if obj is not null and a RectLocation instance whose edgeX and edgeY values equal those of this instance, else false

hashCode

public int hashCode()

Returns a hash code for the RectLocation.

Overrides:

hashCode in class java.lang.Object

Returns:

an Integer hash code for the RectLocation

toString

public java.lang.String toString()

Returns a String representation of the RectLocation.

Overrides:

toString in class java.lang.Object

Returns:

a String containing the values of edgeX and edgeY