org.opentripplanner.common.geometry.DelaunayTriangulation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.5.0

package org.opentripplanner.common.geometry;

import org.locationtech.jts.geom.Coordinate;

/**
 * A DelaunayPoint is the geometrical point of a node of the triangulation.
 * 
 * @author laurent
 * @param 
 */
interface DelaunayPoint {

    /**
     * @return The geometric location of this point.
     */
    public Coordinate getCoordinates();

    /**
     * @return The Z value for this point.
     */
    public TZ getZ();
}

/**
 * A DelaunayEdge is a directed segment between two DelaunayPoints of the triangulation.
 * 
 * The interface is kept minimal for isoline building purposes.
 * 
 * @author laurent
 * @param 
 */
interface DelaunayEdge {

    /**
     * @return The start point (node) of this edge.
     */
    public DelaunayPoint getA();

    /**
     * @return The end point (node) of this edge.
     */
    public DelaunayPoint getB();

    /**
     * @param ccw true (CCW) for A->B left edge, false (CW) for right edge.
     * @return The edge starting at B, going right or left.
     */
    public DelaunayEdge getEdge1(boolean ccw);

    /**
     * @param ccw For same value of ccw, will return the same side as getEdge1().
     * @return The edge starting at A, going right or left.
     */
    public DelaunayEdge getEdge2(boolean ccw);

    /**
     * HACK. This should not be here really. But with Java, attaching some user value to an object
     * rely on another level of indirection and costly maps/arrays. Exposing this flag directly here
     * saves *lots* of processing time. TODO Is there a better way to do that?
     * 
     * @return The flag set by setProcessed.
     */
    public boolean isProcessed();

    /**
     * @param processed
     */
    public void setProcessed(boolean processed);
}

/**
 * A Delaunay triangulation (adapted to isoline building).
 * 
 * A simple interface returning a collection (an iterable) of DelaunayEdges. The interface is kept
 * minimal for isoline building purposes.
 * 
 * @author laurent
 * @param TZ The value stored for each node.
 */
public interface DelaunayTriangulation {

    public int edgesCount();

    public Iterable> edges();

}