001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.geometry.coordinate;
033
034 import org.opengis.annotation.UML;
035
036 import static org.opengis.annotation.Obligation.*;
037 import static org.opengis.annotation.Specification.*;
038
039
040 /**
041 * A placement defined by linear transformation from the parameter space to the target
042 * coordinate space. In 2-dimensional Cartesian parameter space, (<var>u</var>, <var>v</var>),
043 * transforms into a 3-dimensional coordinate reference system, (<var>x</var>, <var>y</var>, <var>z</var>),
044 * by using an affine transformation, (<var>u</var>, <var>v</var>) → (<var>x</var>, <var>y</var>, <var>z</var>),
045 * which is defined:
046 *
047 * <P><center><img src="doc-files/AffinePlacement.png"></center></P>
048 *
049 * Then, given this equation, the {@link #getLocation()} method returns the direct position
050 * (<var>x</var><sub>0</sub>, <var>y</var><sub>0</sub>, <var>z</var><sub>0</sub>), which
051 * is the target position of the origin in (<var>u</var>, <var>v</var>). The two
052 * {@linkplain #getReferenceDirection(int) reference directions}
053 * (<var>u</var><sub>x</sub>, <var>u</var><sub>y</sub>, <var>u</var><sub>z</sub>)
054 * and (<var>v</var><sub>x</sub>, <var>v</var><sub>y</sub>, <var>v</var><sub>z</sub>) are the
055 * target directions of the unit basis vectors at the origin in (<var>u</var>, <var>v</var>).
056 *
057 * @author Martin Desruisseaux (IRD)
058 * @author Axel Francois (LSIS/Geomatys)
059 * @version 3.1
060 * @since 2.0
061 *
062 * @navassoc 1 - - Position
063 *
064 * @todo Refactor as an {@code org.opengis.referencing.operation.AffineTransform} interface?
065 */
066 @UML(identifier="GM_AffinePlacement", specification=ISO_19107)
067 public interface AffinePlacement extends Placement {
068 /**
069 * Gives the target of the parameter space origin. This is the vector
070 * (<var>x</var><sub>0</sub>, <var>y</var><sub>0</sub>, <var>z</var><sub>0</sub>)
071 * in the formulae shown in the class description.
072 *
073 * @return The target of the parameter space origin.
074 */
075 @UML(identifier="location", obligation=MANDATORY, specification=ISO_19107)
076 Position getLocation();
077
078 /**
079 * Gives the target directions for the coordinate basis vectors of the parameter space.
080 * These are the columns of the matrix in the formulae given in the class description.
081 * The number of directions given shall be {@link #getInDimension() inDimension}.
082 * The dimension of the directions shall be {@link #getOutDimension() outDimension}.
083 *
084 * @param dimension The in dimension, as an index from 0 inclusive to
085 * {@link #getInDimension() inDimension} exclusive.
086 * @return The direction as an array of length {@link #getOutDimension() outDimension}.
087 */
088 @UML(identifier="refDirection", obligation=MANDATORY, specification=ISO_19107)
089 double[] getReferenceDirection(int dimension);
090 }