Application: gvSIG desktop » gvSIG raster

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.raster.lib.buffer.api;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.exception.CreateGeometryException;

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

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

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

import org.gvsig.raster.lib.buffer.api.exceptions.GettingEnvelopeException;

import org.gvsig.tools.observer.Observable;

/**

 * @author fdiaz

 *

 */

public interface ROI extends Observable {

    public static final String ROI_CHANGED = "ROI Changed";

    /**

     * Checks if a point in pixel coordinates is inside of this region of

     * interest

     * 

     * @param cellX X cell of raster

     * @param cellY Y cell of raster

     * @return true whether the point is inside

     * @throws CreateGeometryException

     * @throws GeometryOperationException

     * @throws GeometryOperationNotSupportedException

     */

    public boolean isInside(int cellX, int cellY) throws CreateGeometryException,

        GeometryOperationNotSupportedException, GeometryOperationException;

    /**

     * Checks if the geometry is inside of this region of interest

     * 

     * @param geometry

     *            Geometry to check if it is inside roi

     * @return true whether the point is inside

     * @throws GeometryOperationException

     * @throws GeometryOperationNotSupportedException

     */

    public boolean isInside(Geometry geometry) throws GeometryOperationNotSupportedException,

        GeometryOperationException;

    /**

     * Gets the bounding box of this ROI

     *

     * @return the envelope

     * @throws GettingEnvelopeException

     * @throws CloneNotSupportedException

     */

    public Envelope getEnvelope() throws GettingEnvelopeException;

    /**

     * @return the name

     */

    public String getName();

    /**

     * @param name

     */

    public void setName(String name);

    /**

     * @return the identifier

     */

    public long getID();

    /**

     * @param id

     */

    public void setID(long id);

}