Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package org.gvsig.fmap.geom;

import java.awt.Shape;

import java.awt.geom.AffineTransform;

import java.awt.geom.PathIterator;

import java.awt.geom.Rectangle2D;

import java.io.Serializable;

import org.cresques.cts.ICoordTrans;

import org.gvsig.fmap.geom.handler.Handler;

import org.gvsig.fmap.geom.operation.GeometryOperationContext;

import org.gvsig.fmap.geom.operation.GeometryOperationException;

import org.gvsig.fmap.geom.operation.GeometryOperationNotSupportedException;

import org.gvsig.fmap.geom.type.GeometryType;

/**

 * Root interface in the geometry model.

 */

public interface Geometry extends Shape, Serializable {

        /**

         * Predefined geometry types in the model

         */

        public interface TYPES {

                /**

                 * Unknown or not defined type.

                 */

                public final static int NULL = 0;

                /**

                 * A geometric element that has zero dimensions and a location determinable by an ordered set

                 *  of coordinates

                 */

                public final static int POINT = 1;

                /**

                 * A straight or curved geometric element that is generated by a moving point and that has extension

                 *  only along the path of the point.

                 */

                public final static int CURVE = 2;

                /**

                 * A closed plane figure bounded by straight lines.

                 */

                public final static int SURFACE = 4;

                /**

                 * Solids in 3D

                 */

                public final static int SOLID = 8;

                /**

                 * Words, symbols and form of a written or printed work.

                 */

                public final static int TEXT = 16;

                /**

                 * A set that can contain points, lines and polygons. This is usual in <i>CAD</i> layers <i>(dxf, dgn, dwg)</i>.

                 */

                public final static int AGGREGATE = 32;

                /**

                 * A set of points.

                 */

                public final static int MULTIPOINT = 64;

                /**

                 * A set of lines.

                 */

                public final static int MULTICURVE = 128;

                /**

                 * A set of polygons.

                 */

                public final static int MULTISURFACE = 256;

                /**

                 * A set of solids.

                 */

                public final static int MULTISOLID = 512;

                /**

                 * A closed plane curve every point of which is equidistant from a fixed point within the curve.

                 */

                public final static int CIRCLE = 1024;

                /**

                 * A continuous portion (as of a circle or ellipse) of a curved line.

                 */

                public final static int ARC = 2048;

                /**

                 *  A closed plane curve generated by a point moving in such a way that the sums of its distances

                 *   from two fixed points is a constant : a plane section of a right circular cone that is a closed

                 *   curve.

                 *

                 */

                public final static int ELLIPSE=4096;

                /**

                 * Indicates third coordinate. And can be combined with other geometries via the bits enabled.

                 */

                public final static int Z=8192;

        }

        public static int BEST = 0;

        public static int N = 1;

        public static int NE = 2;

        public static int E = 3;

        public static int SE = 4;

        public static int S = 5;

        public static int SW = 6;

        public static int W = 7;

        public static int NW = 8;

        public static int SELECTHANDLER=0;

        public static int STRETCHINGHANDLER=1;

        /**

         * Returns the FShape type of the geometry.

         *

         * @return One FShape constant: {@link FShape}

         * @deprecated Use {@link getType} instead

         */

        public int getShapeType();

        /**

         * If this geometry is a predefined interface then this method returns one of {@link Geometry.TYPES} contants.<br>

         * If this geometry is an extended type then this method returns a runtime constant that identifies its type.

         * By convention this value is stored in a constant called GEOM_TYPE within the geometry class, for instance: Point2D.GEOM_TYPE.

         *

         * @return If this geometry is a predefined interface then one of {@link Geometry.TYPES} or a runtime constant if 

         * it is an extended type.

         */

        public int getType();

        /**

         * Creates a clone of this geometry

         *

         * @return A clone of this geometry.

         */

        public Geometry cloneGeometry();

        /**

         * Returns true if this geometry intersects the rectangle passed as parameter

         *

         * @param r Rectangle.

         *

         * @return True, if <code>this</code> intersects <code>r</code>.

         */

        public boolean intersects(Rectangle2D r);

        /**

         * Used by the drawing strategies to quickly test whether this geometry

         * intersects with the visible rectangle.

         * 

         * @param x

         * @param y 

         * @param w Width

         * @param h Height

         * @return true if <code>this</code> intersects the rectangle defined by the parameters

         */

        public boolean fastIntersects(double x, double y, double w, double h);

        /**

         * Returns this geometry's boundary rectangle.

         *

         * @return Boundary rectangle.

         */

        public Rectangle2D getBounds2D();

        /**

         * Reprojects this geometry by the coordinate transformer passed as parameter.

         *

         * @param ct Coordinate Transformer.

         */

        public void reProject(ICoordTrans ct);

        /**

         * Returns the GeneralPathXIterator with this geometry's information

         * @param at AffineTransform

         *

         * @return PathIterator.

         */

        public PathIterator getPathIterator(AffineTransform at);

    /**

         * It returns the handlers of the geometry,

         * these they can be of two types is straightening and of selection.

         *

         * @param type Type of handlers

         *

         * @return Handlers.

         */

        public Handler[] getHandlers(int type);

        public void transform(AffineTransform at);

        PathIterator getPathIterator(AffineTransform at, double flatness);

        /**

         * Useful to have the real shape behind the scenes.

         * May be uses to edit it knowing it it is a Circle, Ellipse, etc

         * @return

         */

        public Shape getInternalShape();

        public int getCoordinateDimension();

        public boolean isSimple();

        /**

         * Invokes a geometry operation given its index and context

         * @param index unique index of the operation. Operation code.

         * @return object returned by the operation.

         */

        public Object invokeOperation(int index, GeometryOperationContext ctx) throws GeometryOperationNotSupportedException, GeometryOperationException;

        /**

         * Instance of the GeometryType associated to this geometry

         * @return

         */

        public GeometryType getGeometryType();

}