Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.fmap.dal.coverage.datastruct;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import org.cresques.cts.ICoordTrans;

import org.gvsig.fmap.geom.primitive.EnvelopeNotInitializedException;

import org.gvsig.tools.persistence.Persistent;

/**

 * Representaci?n de la extensi?n de una imagen.

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface Extent extends Persistent {

        /**

         * Builds a new GridExtent using this extension

         * @param cellSize

         * @return

         */

        public GridExtent getGridExtent(double cellSize);

    /**

     * Obtiene la coordenada X m?nima

     * @return valor de la coordenada X m?nima

     */

    public double minX();

    /**

     * Obtiene la coordenada Y m?nima

     * @return valor de la coordenada X m?nima

     */

    public double minY();

    /**

     * Obtiene la coordenada X m?xima

     * @return valor de la coordenada X m?xima

     */

    public double maxX();

    /**

     * Obtiene la coordenada Y m?xima

     * @return valor de la coordenada Y m?xima

     */

    public double maxY();

    /**

     * Obtiene el punto m?nimo

     * @return m?nimo

     */

    public Point2D getMin();

    /**

     * Obtiene el punto m?ximo

     * @return m?ximo

     */

    public Point2D getMax();

    /**

     * Obtiene el ancho

     * @return

     */

    public double width();

    /**

     * Obtiene el alto

     * @return

     */

    public double height();

    /**

     * Obtiene el centro en X del extent

     * @return

     */

    public double getCenterX();

    /**

     * Obtiene el centro en Y del extent

     * @return

     */

    public double getCenterY();

    public Rectangle2D toRectangle2D();

    /**

     * Gets the upper left corner

     * @return

     */

    public Point2D getUL();

    /**

     * Gets the lower right corner

     * @return

     */

    public Point2D getLR();

    /**

     * Obtiene la coordenada X de la esquina superior izquierda. Esta, en condiciones normales

     * conincide con el minimo en X pero cuando un raster est? rotado esto puede variar.

     * @return ulx

     */

    public double getULX();

    /**

     * Obtiene la coordenada Y de la esquina superior izquierda. Esta, en condiciones normales

     * conincide con el maximo en Y pero cuando un raster est? rotado esto puede variar.

     * @return uly

     */

    public double getULY();

    /**

     * Obtiene la coordenada X de la esquina inferior derecha. Esta, en condiciones normales

     * conincide con el m?ximo en X pero cuando un raster est? rotado esto puede variar.

     * @return lrx

     */

    public double getLRX();

    /**

     * Obtiene la coordenada Y de la esquina inferior derecha. Esta, en condiciones normales

     * conincide con el minimo en Y pero cuando un raster est? rotado esto puede variar.

     * @return lry

     */

    public double getLRY();

    /**

     * Obtiene la coordenada X de la esquina superior derecha. 

     * @return urx

     */

    public double getURX();

    /**

     * Obtiene la coordenada Y de la esquina superior derecha.

     * @return uly

     */

    public double getURY();

    /**

     * Obtiene la coordenada X de la esquina inferior izquierda.

     * @return lrx

     */

    public double getLLX();

    /**

     * Obtiene la coordenada Y de la esquina inferior izquierda.

     * @return lly

     */

    public double getLLY();

    /**

     * Asigna la coordenada X de la esquina superior izquierda al m?nimo X

     */

    public void setULXToMin();

    /**

     * Asigna la coordenada X de la esquina superior izquierda al m?ximo X

     */

    public void setULXToMax();

    /**

     * Asigna la coordenada Y de la esquina superior izquierda al m?nimo Y

     */

    public void setULYToMin();

    /**

     * Asigna la coordenada Y de la esquina superior izquierda al m?ximo Y

     */

    public void setULYToMax();

    /**

     * Asigna la coordenada X de la esquina inferior derecha al m?nimo X

     */

    public void setLRXToMin();

    /**

     * Asigna la coordenada X de la esquina inferior derecha al m?ximo X

     */

    public void setLRXToMax();

    /**

     * Asigna la coordenada Y de la esquina inferior derecha al m?nimo Y

     */

    public void setLRYToMin();

    /**

     * Asigna la coordenada Y de la esquina inferior derecha al m?ximo Y

     */

    public void setLRYToMax();

    /**

     * Adds the current extent to the selected extent and returns the maximum 

     * bounding box that enclose both.

     * @param ext

     * @return

     */

    public Extent encloseBoundinBoxes(Extent ext);

    /**

     * Gets the intersection between two bounding box

     * @param ext

     * @return

     */

    public Extent intersection(Extent ext);

    /**

     * Returns true if the selected bounding box intersects with the 

     * current

     * @param ext

     * @return

     */

    public boolean intersects(Extent ext);

    /**

     * Obtiene la escala

     * @param width        Ancho

     * @param height        Alto

     * @return

     */

    public double[] getScale(int width, int height);

    public double[] getScale(double width, double height);

        /**

         * Converts the bounding box to other coordinate reference system

         * @param trans

         * The CRS conversor

         * @return

         * A new envelope in other CRS 

         * @throws EnvelopeNotInitializedException

     * if the envelope is empty.

         */

    public Extent convert(ICoordTrans trans);

        /**

         * Given a cell size, converts a point in raster coordinates to world coordinates

         * @param pt Point to transform

         */

        public Point2D rasterToWorld(Point2D pt, double cellsize);

        /**

         * Given a cell size, converts a point in world coordinates to pixel coordinates

         * @param pt Point to transform

         */

        public Point2D worldToRaster(Point2D pt, double cellsize);

    /**

     * Compares two extents

     * @param obj

     * @return

     */

    public boolean equals(Object obj);

    public Extent clone();

}