001 //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/model/spatialschema/Position.java $
002 /*----------------------------------------------------------------------------
003 This file is part of deegree, http://deegree.org/
004 Copyright (C) 2001-2009 by:
005 Department of Geography, University of Bonn
006 and
007 lat/lon GmbH
008
009 This library is free software; you can redistribute it and/or modify it under
010 the terms of the GNU Lesser General Public License as published by the Free
011 Software Foundation; either version 2.1 of the License, or (at your option)
012 any later version.
013 This library is distributed in the hope that it will be useful, but WITHOUT
014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016 details.
017 You should have received a copy of the GNU Lesser General Public License
018 along with this library; if not, write to the Free Software Foundation, Inc.,
019 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020
021 Contact information:
022
023 lat/lon GmbH
024 Aennchenstr. 19, 53177 Bonn
025 Germany
026 http://lat-lon.de/
027
028 Department of Geography, University of Bonn
029 Prof. Dr. Klaus Greve
030 Postfach 1147, 53001 Bonn
031 Germany
032 http://www.geographie.uni-bonn.de/deegree/
033
034 e-mail: info@deegree.org
035 ----------------------------------------------------------------------------*/
036 package org.deegree.model.spatialschema;
037
038 import javax.vecmath.Point3d;
039
040 /**
041 * A sequence of decimals numbers which when written on a width are a sequence of coordinate positions. The width is
042 * derived from the CRS or coordinate dimension of the container.
043 *
044 * <p>
045 * -----------------------------------------------------------------------
046 * </p>
047 *
048 * @version 5.6.2001
049 * @author Andreas Poth
050 * <p>
051 */
052 public interface Position {
053 /**
054 * @return the x-value of the point
055 */
056 public double getX();
057
058 /**
059 * @return the y-value of the point
060 */
061 public double getY();
062
063 /**
064 * @return the z-value of the point
065 */
066 public double getZ();
067
068 /**
069 * @return the coordinate dimension of the position
070 */
071 public int getCoordinateDimension();
072
073 /**
074 * NOTE: The returned array always has a length of 3, regardless of the dimension. This is due to a limitation in
075 * the coordinate transformation package (proj4), which expects coordinates to have 3 dimensions.
076 *
077 * @return the x- and y-value of the point as a two dimensional array the first field contains the x- the second
078 * field the y-value.
079 *
080 */
081 public double[] getAsArray();
082
083 /**
084 * translates the coordinates of the position.
085 *
086 * @param d
087 * the first coordinate of the position will be translated by the first field of <tt>d</tt> the second
088 * coordinate by the second field of <tt>d</tt> and so on...
089 */
090 public void translate( double[] d );
091
092 /**
093 * returns the accuracy the position is defined. The accuracy is measured in values of the CRS the positions
094 * coordinates are stored
095 *
096 * @return the accuracy the position is defined
097 */
098 public double getAccuracy();
099
100 /**
101 * @see #getAccuracy()
102 * @param accuracy
103 */
104 public void setAccuracy( double accuracy );
105
106 /**
107 * @return the position as a point3d
108 */
109 public Point3d getAsPoint3d();
110
111 }