org.opengis.geometry.coordinate.Tin Maven / Gradle / Ivy

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.geometry.coordinate;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.List;
import java.util.Set;
import org.opengis.annotation.UML;

/**
 * A triangulated surface that uses the Delaunay algorithm or a similar algorithm complemented with
 * consideration for breaklines, stoplines and maximum length of triangle sides. These networks
 * satisfy the Delaunay criterion away from the modifications: For each triangle in the network, the
 * circle passing through its vertexes does not contain, in its interior, the vertex of any other
 * triangle.
 *
 * @version ISO 19107
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.0
 * @see GeometryFactory#createTin
 */
@UML(identifier = "GM_Tin", specification = ISO_19107)
public interface Tin extends TriangulatedSurface {
    /**
     * Stoplines are lines where the local continuity or regularity of the surface is questionable.
     * In the area of these pathologies, triangles intersecting a stopline shall be removed from the
     * TIN surface, leaving holes in the surface. If coincidence occurs on surface boundary
     * triangles, the result shall be a change of the surface boundary. The attribute {@code
     * stopLines} contains all these pathological segments as a set of line strings.
     */
    @UML(identifier = "stopLines", obligation = MANDATORY, specification = ISO_19107)
    Set getStopLines();

    /**
     * Breaklines are lines of a critical nature to the shape of the surface, representing local
     * ridges, or depressions (such as drainage lines) in the surface. As such their constituent
     * segments must be included in the TIN even if doing so violates the Delaunay criterion. The
     * attribute {@code breakLines} contains these critical segments as a set of line strings.
     */
    @UML(identifier = "breakLines", obligation = MANDATORY, specification = ISO_19107)
    Set getBreakLines();

    /**
     * Maximal length for retention. Areas of the surface where the data is not sufficiently dense
     * to assure reasonable calculations shall be removed by adding a retention criterion for
     * triangles based on the length of their sides. For any triangle sides exceeding maximum
     * length, the adjacent triangles to that triangle side shall be removed from the surface.
     */
    @UML(identifier = "maxLength", obligation = MANDATORY, specification = ISO_19107)
    double getMaxLength();

    /**
     * The corners of the triangles in the TIN are often referred to as posts. The attribute {@code
     * controlPoint} shall contain a set of the {@linkplain Position positions} used as posts for
     * this TIN. Since each TIN contains triangles, there must be at least 3 posts. The order in
     * which these points are given does not affect the surface that is represented. Application
     * schemas may add information based on the ordering of the control points to facilitate the
     * reconstruction of the TIN from the control points.
     */
    @UML(identifier = "controlPoint", obligation = MANDATORY, specification = ISO_19107)
    List getControlPoints();
}