org.opengis.geometry.primitive.Bearing Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation

Standard interfaces implemented throughout the library.

There is a newer version: 24.2-oss84-1

/*
 *    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.primitive;

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

import org.opengis.annotation.UML;

/**
 * Represents direction in the coordinate reference system. In a 2D coordinate reference system,
 * this can be accomplished using a "angle measured from true north" or a 2D vector point in that
 * direction. In a 3D coordinate reference system, two angles or any 3D vector is possible. If both
 * a set of angles and a vector are given, then they shall be consistent with one another.
 *
 * @version ISO 19107
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 1.0
 */
@UML(identifier = "Bearing", specification = ISO_19107)
public interface Bearing {
    /**
     * Returns the azimuth and (optionnaly) the altitude. In this variant of bearing usually used
     * for 2D coordinate systems, the first angle (azimuth) is measured from the first coordinate
     * axis (usually north) in a counterclockwise fashion parallel to the reference surface tangent
     * plane. If two angles are given, the second angle (altitude) usually represents the angle
     * above (for positive angles) or below (for negative angles) a local plane parallel to the
     * tangent plane of the reference surface.
     *
     * @return An array of length 0, 1 or 2 containing the azimuth and altitude angles.
     * @todo Should we split this method in {@code getAzimuth()} and {@code getAltitude()} methods
     *     instead? Should we provides a {@code getDimension()} method too?
     */
    @UML(identifier = "angle", obligation = MANDATORY, specification = ISO_19107)
    double[] getAngles();

    /**
     * Returns the direction as a vector. In this variant of bearing usually used for 3D coordinate
     * systems, the direction is express as an arbitrary vector, in the coordinate system.
     *
     * @return The direction.
     */
    @UML(identifier = "direction", obligation = MANDATORY, specification = ISO_19107)
    double[] getDirection();
}