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.io.IOException;

import org.gvsig.tools.persistence.Persistent;

/**

 * Clase que representa a un conjunto de pixeles con transparencia. Incluye los

 * rangos de transparencia para cada banda, la cadena que va en la lista y la

 * operaci?n que se realiza entre ellos. Un And significa que ser?n

 * transparentes todos los pixeles que cumplan con R con G y con B. Un Or

 * significar? que tendr?n transparencia todos los pixeles que cumplan con R con

 * G o con B.

 *

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

 */

public interface TransparencyRange extends Persistent {

        /**

         * Obtiene la operaci?n  utilizada

         * @param and Si es true significa que se usa un AND y false implica

         * que se usa un OR

         */

        public boolean isAnd();

        /**

         * Asigna la operaci?n AND como la utilizada

         * @param and booleano que si est? a true significa que el la operaci?n

         * AND es la utilizada como operaci?n.

         */

        public void setAnd(boolean and);

        /**

         * Obtiene el intervalo de valores correspondiente a la banda del azul

         * @return Array bidimensional de enteros correspondiente a la banda del azul

         */

        public int[] getBlue();

        /**

         * Asigna los intervalos de valores correspondientes a las bandas del

         * rojo, azul y verde

         * @param red Array bidimensional de enteros correspondiente a la banda del rojo

         * @param green Array bidimensional de enteros correspondiente a la banda del verde

         * @param blue Array bidimensional de enteros correspondiente a la banda del azul

         */

        public void setRGB(int[] red, int[] green, int[] blue);

        /**

         * Asigna el intervalo de valores correspondiente a la banda del azul

         * @param blue Array bidimensional de enteros correspondiente a la banda del azul

         */

        public void setBlue(int[] blue);

        /**

         * Obtiene el intervalo de valores correspondiente a la banda del verde

         * @return Array bidimensional de enteros correspondiente a la banda del verde

         */

        public int[] getGreen();

        /**

         * Asigna el intervalo de valores correspondiente a la banda del verde

         * @param green Array bidimensional de enteros correspondiente a la banda del verde

         */

        public void setGreen(int[] green);

        /**

         * Obtiene el intervalo de valores correspondiente a la banda del rojo

         * @return Array bidimensional de enteros correspondiente a la banda del rojo

         */

        public int[] getRed();

        /**

         * Asigna el intervalo de valores correspondiente a la banda del rojo

         * @param red Array bidimensional de enteros correspondiente a la banda del rojo

         */

        public void setRed(int[] red);

        /**

         * Obtiene la cadena que representa una entrada en la tabla.

         * @return Cadena que representa una entrada en la tabla

         */

        public String getStrEntry();

        /**

         * Asigna la cadena que representa una entrada en la tabla.

         * @param strEntry Cadena que representa una entrada en la tabla.

         */

        public void setStrEntry(String strEntry);

        /**

         * Esta funci?n valida la cadena de entrada por medio de una m?quina de estados. Valida las

         * siguientes posibilidades en la cadena de entrada:

         * <LI>

         * <UL>(valor_rojo) & (Valor_verde) & (Valor_azul)</UL>

         * <UL>(valor_rojo) | (Valor_verde) | (Valor_azul)</UL>

         * </LI>

         * Despues de la validaci?n parsea el contenido y carga los par?metros r,g,b con los

         * intervalos de valores. Estos par?metros deben ser pasados como arrays de enteros de

         * dos elementos.

         * @param values

         * @param r        Intervalo de rojo

         * @param g Intervalo de verde

         * @param b Intervalo de azul

         * @return Devuelve true si la operaci?n usada en los intervalos es un AND y false si es un OR

         */

        public boolean stringToInterval(String values, int[] r, int[] g, int[] b) throws IOException;

        /**

         * Carga la cadena StrEntry leyendo los valores en los vectores que representa los intervalos.

         */

        public void loadStrEntryFromValues();

        /**

         * Obtiene el alpha asociado al rango. Por defecto es de 0, es decir

         * totalmente transparente pero puede asociarsele un valor distinto

         * @return Alpha asociado

         */

        public int getAlpha();

        /**

         * Asigna el alpha asociado al rango. Por defecto es de 0, es decir

         * totalmente transparente pero puede asociarsele un valor distinto

         * @param alpha asociado

         */

        public void setAlpha(int alpha);

        /**

         * Realiza la uni?n entre el intervalo actual y el pasado por par?metro

         * @param interval intervalo pasado

         * @param rgb

         * @return union de intervalos

         */

        public int[] union(int[] interval, int rgb);

}