org.kynosarges.tektosyne.geometry

Class VoronoiEdge

java.lang.Object

org.kynosarges.tektosyne.geometry.VoronoiEdge

public final class VoronoiEdge
extends java.lang.Object

Represents one edge in the Voronoi diagram found by the Voronoi algorithm. Immutable class holding one element in the VoronoiResults.voronoiEdges collection of the VoronoiResults class. Contains the indices of the two VoronoiResults.voronoiVertices that terminate the edge, as well as the indices of the two VoronoiResults.generatorSites that are bisected by the edge. This allows constructing the Voronoi region corresponding to each generator site.

Field Summary

Fields

Modifier and Type	Field and Description
int	site1 The index of the first of the two VoronoiResults.generatorSites that are bisected by the VoronoiEdge.
int	site2 The index of the second of the two VoronoiResults.generatorSites that are bisected by the VoronoiEdge.
int	vertex1 The index of the first of the two VoronoiResults.voronoiVertices that are connected by the VoronoiEdge.
int	vertex2 The index of the second of the two VoronoiResults.voronoiVertices that are connected by the VoronoiEdge.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

site1

public final int site1

The index of the first of the two VoronoiResults.generatorSites that are bisected by the VoronoiEdge.

site2

public final int site2

The index of the second of the two VoronoiResults.generatorSites that are bisected by the VoronoiEdge.

vertex1

public final int vertex1

The index of the first of the two VoronoiResults.voronoiVertices that are connected by the VoronoiEdge.

vertex2

public final int vertex2

The index of the second of the two VoronoiResults.voronoiVertices that are connected by the VoronoiEdge.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the specified Object to this VoronoiEdge 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 VoronoiEdge instance whose site1, site2, vertex1, and vertex2 values equal those of this instance, else false

hashCode

public int hashCode()

Returns a hash code for the VoronoiEdge.

Overrides:

hashCode in class java.lang.Object

Returns:

an Integer hash code for the VoronoiEdge

toString

public java.lang.String toString()

Returns a String representation of the VoronoiEdge.

Overrides:

toString in class java.lang.Object

Returns:

a String containing the values of site1, site2, vertex1, and vertex2