org.kynosarges.tektosyne.geometry

Class MultiLinePoint.Line

java.lang.Object

org.kynosarges.tektosyne.geometry.MultiLinePoint.Line

Enclosing class:

MultiLinePoint

public static final class MultiLinePoint.Line
extends java.lang.Object

Represents one of the line segments intersecting at the MultiLinePoint.shared coordinates. Immutable class that also stores the LineLocation of the MultiLinePoint.shared coordinates relative to the indicated line segment.

Field Summary

Fields

Modifier and Type	Field and Description
int	index The input index of a line segment intersecting at the MultiLinePoint.shared coordinates.
LineLocation	location The location of the MultiLinePoint.shared coordinates relative to the line segment at index.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

index

public final int index

The input index of a line segment intersecting at the MultiLinePoint.shared coordinates. Holds a zero-based index relative to the original input collection, indicating one of the line segments that intersect at the MultiLinePoint.shared coordinates.

location

public final LineLocation location

The location of the MultiLinePoint.shared coordinates relative to the line segment at index. Holds a LineLocation value specifying the location of the MultiLinePoint.shared coordinates relative to the input line segment indicated by index.

Since all line segments of a MultiLinePoint are guaranteed to intersect at the MultiLinePoint.shared coordinates, each location is either LineLocation.START, LineLocation.BETWEEN, or LineLocation.END.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the specified Object to this MultiLinePoint.Line 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 MultiLinePoint.Line instance whose index and location equal those of this instance, else false

hashCode

public int hashCode()

Returns a hash code for the MultiLinePoint.Line.

Overrides:

hashCode in class java.lang.Object

Returns:

an Integer hash code for the MultiLinePoint.Line

toString

public java.lang.String toString()

Returns a String representation of the MultiLinePoint.Line.

Overrides:

toString in class java.lang.Object

Returns:

a String containing the value of index and location