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.TransparencyRange;

/**

 * Interfaz que representa la transparencia.

 * 

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

 */

public interface Transparency {

	/**

	 * 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);

	/**

	 * Obtiene el grado de opacidad de todo el raster

	 * @return valor del grado de opacidad.

	 */

	public int getOpacity();

	/**

	 * 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();

	/**

	 * Obtiene el valor noData 

	 * @return

	 */

	public double getNoData();

	/**

	 * Obtiene la informaci?n de si existe o no la posibilidad de aplicar valore no data

	 * como transparentes. Para ello tiene que estar activo su uso y el buffer debe contener datos

	 * @return true si puede aplicarse noData y false si no se puede

	 */

	public boolean isNoDataActive();

	/**

	 * Obtiene el ?rea de datos

	 * @return M?scara de transparencia

	 */

	public Buffer getDataBuffer();

}