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.grid.render;

import java.awt.Image;

import org.gvsig.fmap.dal.coverage.dataset.Buffer;

import org.gvsig.fmap.dal.coverage.exception.ProcessInterruptedException;

import org.gvsig.fmap.dal.coverage.store.props.Statistics;

import org.gvsig.fmap.dal.coverage.store.props.Transparency;

/**

 * Writes data from a buffer on a Image object. At this level neither bounding box nor

 * rotations nor world coordinates are managed.

 *

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

 */

public interface ImageDrawer {

        /**

         * Sets the buffer to render

         */

        public void setBuffer(Buffer b);

        /**

         * Assigns the buffer transparency

         * @param t

         */

        public void setLastTransparency(Transparency t);

        /**

         * Sets the shift in pixels from the upper left corner. It is useful when we need supersampling to render

         * the image. If the step is null then the supersampling is deactivated else the size of the output

         * buffer will be width X height pixels. This size should be set with setOutPutSize method.

         * 

         * Exists supersampling when the zoom to draw is greater than 1:1. To draw a pixel will be necessary

         * more than one pixel in the output buffer. 

         * 

         * @param step Desplazamiento

         */

        public void setSupersamplingOn(double[] step);

        /**

         * Sets the size of the output buffer. This is useful to reescale the output buffer

         * @param width Ancho

         * @param h Alto

         */

        public void setOutputSize(int width, int height);

        /**

         * Releases the link to the buffer.

         */

        public void dispose();

        /**

         * Adds a enhanced filter to the buffer

         * @param stats

         * @return

         */

        public Buffer addEnhanced(Statistics stats);

        /**

         * Adds a enhanced filter to the buffer

         * @param stats

         * @return

         */

        public Buffer addEnhanced(Statistics stats, boolean tailTrim, double tailTrimValue);

        /**

         * Dibuja el buffer sobre un objeto Image de java.awt y devuelve el resultado.

         *

         * @param replicateBand Flag de comportamiento del renderizado. Al renderizar el buffer

         * este obtiene la primera banda del buffer y la asigna al R, la segunda al G y la tercera

         * al B. Este flag no es tomado en cuenta en caso de que existan 3 bandas en el buffer.

         * Si no hay tres bandas, por ejemplo una y el flag es true esta ser? replicada

         * en R, G y B, en caso de ser false la banda ser? dibujada en su posici?n (R, G o B)

         * y en las otras bandas se rellenar? con 0.

         *

         * @param transparentBand. Si es true la banda 4 es alpha y si es false no lo es.

         *

         * @return java.awt.Image con el buffer dibujado.

         * @throws ProcessInterruptedException

         */

        public Image drawBufferOverImageObject() throws ProcessInterruptedException;

}