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.store.props;

import java.util.ArrayList;

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

import org.gvsig.fmap.dal.coverage.datastruct.NoData;

import org.gvsig.fmap.dal.coverage.datastruct.TransparencyRange;

import org.gvsig.fmap.dal.coverage.util.PropertyListener;

/**

 * <P>Interfaz que representa la transparencia.</P>

 * 

 * <P>

 * El estado de transparencia de un raster puede verse modificado desde los siguientes sitios:

 * <UL>

 * <LI>Color con transparencia definido en los metadatos de la imagen. Caracteristica de PNG.</LI>

 * <LI>Una banda del raster definida como banda de transparencia. PNGs, IMGs o TIFFs 

 * pueden tener bandas de transparencia</LI>

 * <LI>Tablas de color con valores de transparencia. GIF y PNG pueden tener tablas 

 * que definan entradas de color con transparencia</LI>

 * <LI>Informaci?n de transparencia en la cabecera raster. Tipicamente valores NO_DATA suelen 

 * ser interpretados como transparentes en la visualizaci?n.</LI>

 * <LI>Modificaci?n hecha por el usuario. En la visualizaci?n un usuario puede necesitar

 * asignar valores o rangos de valores como transparentes.</LI>

 * </UL> 

 * </P>

 * <P>

 * Estas transparencias quedan representadas por cinco tipo b?sicos:

 * <UL>

 * <LI><b>Transparencia por rangos. </b>Esta se aplicar? antes que ninguna y siempre sobre los valores

 * base del raster.</LI>

 * <LI><b>Banda de transparencia en un raster. </b></LI>

 * <LI>M?scara de transparencia</LI>

 * <LI>Opacidad</LI>

 * <LI>Zona de recorte</LI>

 * </UL>

 * </P>

 * 

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

 */

public interface Transparency {

        /**

         * Asigna un listener a la lista que ser? informado cuando cambie una

         * propiedad visual en la renderizaci?n.

         * @param listener VisualPropertyListener

         */

        public void addPropertyListener(PropertyListener listener);

        /**

         * Asigna la informaci?n de si existe o no banda de transparencia cuando este

         * objeto va asociado a un dataset. Si tiene este tipo de banda en cada

         * dibujado se cargar? la informaci?n de m?scara de transparencia en el la

         * variable mask.

         * @param true si existe banda de transparencia y false si no lo es.

         */

        public void setTransparencyBand(int alphaBandNumber);

        /**

         * Mezcla un objeto Transparency con el actual

         * @param ts objeto TransparencyStatus

         */

        public Transparency merge(Transparency transp);

        /**

         * Mezcla el alpha actual con el que nos pasan por parametro y se asigna

         * directamente a destino

         * @param buffer

         * @param dst

         */

        public void mergeBuffer(Buffer buffer, Buffer dst);

        /**

         * Obtiene el grado de opacidad de todo el raster

         * @return valor del grado de opacidad.

         */

        public int getOpacity();

        /**

         * Asigna el grado de opacidad de todo el raster

         * @param opacity valor del grado de opacidad.

         */

        public void setOpacity(int opacity);

        /**

         * Obtiene la m?scara asociada

         * @return M?scara de transparencia

         */

        public Buffer getAlphaBand();

        /**

         * Obtiene la banda de transpareci si existe o -1 si no existe.

         * @return n?mero de banda de transparencia o -1 si no existe.

         */

        public int getAlphaBandNumber();

        /**

         * Obtiene los rangos de pixels que son transparentes en el raster.

         * @return Rangos de transparencias a aplicar

         */

        public ArrayList<TransparencyRange> getTransparencyRange();

        /**

         * Asigna la lista de rangos de transparencia

         * @param ranges

         */

        public void setTransparencyRangeList(ArrayList<TransparencyRange> ranges);

        /**

         * Obtiene el valor noData 

         * @return

         */

        public NoData getNoData();

        /**

         * Obtiene el ?rea de datos

         * @return M?scara de transparencia

         */

        public Buffer getDataBuffer();

        /**

         * Obtiene la informaci?n de si existe o no banda de transparencia cuando este

         * objeto va asociado a un dataset. Si tiene este tipo de banda en cada

         * dibujado se cargar? la informaci?n de m?scara de transparencia en el la

         * variable mask.

         * @return true si existe banda de transparencia y false si no lo es.

         */

        public boolean existAlphaBand();

        /**

         * Asigna el buffer con la m?scara

         * @param b

         */

        public void setAlphaBand(Buffer b);

        /**

         * Asigna el ?rea de datos

         * @param b

         */

        public void setDataBuffer(Buffer b);

        /**

         * Asigna el valor noData

         * @param noData

         */

        public void setNoData(NoData noData);

        /**

         * Inicializa la lista de rangos de transparencia.

         */

        public void clearListOfTransparencyRange();

        /**

         * Asigna un rango de pixels que son transparentes en el raster.

         * @param range

         */

        public void setTransparencyRange(TransparencyRange range);

        /**

         * Pone a null los buffers de datos y pasa el garbage collector para liberar la memoria.

         * Despu?s de renderizar es conveniente hacer esto porque el objeto Transparency asociado a

         * un dataset no se destruye hasta que no se cierra este. Esto hace que esta memoria este

         * siempre ocupada.

         */

        public void free() ;

        /**

         * Comprueba si hay criterios para la aplicaci?n de transparencia y la activa si es

         * as? sino se desactiva. Los criterios son:

         * <P>

         * Que haya una mascara de transparencia.

         * </P><P>

         * Que exista un buffer de datos para la aplicaci?n de nodata

         * </P><P>

         * Que hayan reglas sobre la aplicaci?n de transparencia.

         * </P><P>

         * Que la opacidad sea distita de 255 (completamente opaco). 

         * </P>

         */

        public void activeTransparency();

        /**

         * Obtiene el flag de transparencia activa o desactivada.

         * @return true la transparencia est? activa y false desactiva

         */

        public boolean isTransparencyActive();

        /**

         * Asigna el flag de transparencia activa o desactivada.

         * @param transparencyActive true activa la transparencia false la desactiva

         */

        public void setTransparencyActive(boolean transparencyActive);

        /**

         * Aplica las reglas de transparencia a un pixel RGB y devuelve el valor de ese

         * mismo pixel con la transparencia aplicada. Primero procesar? los rangos. Si

         * el pixel est? en alguno directamente lo pone transparente y lo devuelve, sino

         * comprueba si existe banda de transparencia y si es as? la aplica.

         * @param rgb

         * @param line

         * @param col

         * @return

         */

        public int processRGB(int r, int g, int b, int line, int col);

        /**

         * Clones this object

         * @return

         */

        public Transparency cloneTransparency();

}