org.gvsig.raster.impl.store.properties

Class DataStoreTransparency

java.lang.Object

org.gvsig.raster.impl.store.properties.DataStoreTransparency

All Implemented Interfaces:

Transparency, Disposable, Persistent

public class DataStoreTransparency
extends Object
implements Transparency, Persistent

Esta clase contiene información de transparencia de un objeto. Los objetos pueden ser dataset, grid u otros. Cuando un usuario quiere añadir nueva información de transparencia crea un objeto de este tipo que debe ser mezclado (merge) con otros objetos de este tipo que existan para la misma fuente de datos.

Un multirasterdatset obtiene los distintos objetos transparency de todos los ficheros que los componen. Para realizar un solo objeto transparency se hará un merge de todos ellos.

Finalmente y antes de renderizar se necesita un objeto Transparency. Este estará compuesto con toda la información de transparencia aplicar, es decir, todos los objetos Transparency mezclados.Transparency con tiene el método de procesado de un pixel. Se le proporciona un pixel y devuelve este mismo pixel con la transparencia aplicada.

Una transparencia que se aplica a un buffer puede tener cuatro procedencias distintas:

• Mascara: Un buffer de NxN aplicado sobre la zona a renderizar como una máscara de transparencia. Las bandas alpha de las imagenes se comportan de esta forma.
• Opacidad global: Un valor de opacidad se aplicado a cada pixel a renderizar. Este es igual para todos los píxeles.
• Rangos: Una lista de rangos de valores RGB. Cada pixel cuyo valor esté dentro de alguno de los rangos se aplica como transparente.
• Dato: Todos los valores del buffer que coincidan con ese dato son puestos como transparente. Para que esto sea posible tenemos que disponer del buffer de datos originales sin ningún proceso.

Field Summary

Fields

Modifier and Type	Field and Description
protected ColorInterpretation	colorInterpretation Alpha source
static int	MAX_OPACITY
protected NoData	noData Valor de dato transparente.
protected int	opacity Grado de opacidad de todo el raster
protected Buffer	originalData Buffer con los datos originales (sin filtrar) correspondiente a la zona a renderizar.
protected List<TransparencyRange>	transparencyRanges Rangos de transparencia aplicados.

Constructor Summary

Constructors

Constructor and Description
DataStoreTransparency()
DataStoreTransparency(ColorInterpretation colorInterpretation) Constructor

Method Summary

Modifier and Type	Method and Description
void	activeTransparency() Comprueba si hay criterios para la aplicación de transparencia y la activa si es así sino se desactiva.
void	addPropertyListener(PropertyListener listener) Asigna un listener a la lista que será informado cuando cambie una propiedad visual en la renderización.
void	clearListOfTransparencyRange() Inicializa la lista de rangos de transparencia.
Transparency	cloneTransparency() Clones this object
void	dispose() Disposes the current object, to allow it to close and dispose any used resources.
boolean	existAlphaBand() Obtiene la información de si existe o no banda de transparencia cuando este objeto va asociado a un dataset.
protected void	finalize()
int	getAlphaBandNumber() Obtiene la banda de transpareci si existe o -1 si no existe.
ColorInterpretation	getColorInterpretation() Gets the color interpretation
Buffer	getDataBuffer() Obtiene el área de datos
NoData	getNoData() Obtiene el valor noData
int	getOpacity() Obtiene el grado de opacidad de todo el raster
List<TransparencyRange>	getTransparencyRange() Obtiene los rangos de pixels que son transparentes en el raster.
protected boolean	isNoData(int line, int col) Consulta si el valor de la posición (line, col) del buffer es considerado NoData o no.
boolean	isTransparencyActive() Obtiene el flag de transparencia activa o desactivada.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	mergeBuffers(Buffer src1, Buffer src2)
int	processRGB(int r, int g, int b, int line, int col, Buffer buf) Aplica las reglas de transparencia a un pixel RGB y devuelve el valor de ese mismo pixel con la transparencia aplicada.
static void	registerPersistence()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setColorInterpretation(ColorInterpretation colorInterpretation) Sets the band color interpretation
void	setDataBuffer(Buffer b) Asigna el área de datos
void	setNoData(NoData noData) Asigna el valor noData
void	setOpacity(int opacity) Asigna el grado de opacidad de todo el raster
void	setTransparencyActive(boolean transparencyActive) Asigna el flag de transparencia activa o desactivada.
void	setTransparencyBand(int alphaBandNumber) Asigna la información de si existe o no banda de transparencia cuando este objeto va asociado a un dataset.
void	setTransparencyByPixelFromMetadata(DataStoreMetadata metadata) Asigna la transparencia a partir de un objeto con los metadatos del raster.
void	setTransparencyRange(TransparencyRange range) Asigna un rango de pixels que son transparentes en el raster.
void	setTransparencyRangeList(List<TransparencyRange> ranges) Asigna la lista de rangos de transparencia

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_OPACITY

public static int MAX_OPACITY

colorInterpretation

protected ColorInterpretation colorInterpretation

Alpha source

originalData

protected Buffer originalData

Buffer con los datos originales (sin filtrar) correspondiente a la zona a renderizar. Esto es util para aplicar el valor NoData ya que hay que consultar el valor original del dato. Después de hacer un process es recomendable hacer free para poner a null los buffers.

noData

protected NoData noData

Valor de dato transparente. Todos los píxeles de originalData que correspondan con este valor se pondrán 100% transparentes.

transparencyRanges

protected List<TransparencyRange> transparencyRanges

Rangos de transparencia aplicados. Lista de TransparencyRange

opacity

protected int opacity

Grado de opacidad de todo el raster

Constructor Detail

DataStoreTransparency

public DataStoreTransparency()

DataStoreTransparency

public DataStoreTransparency(ColorInterpretation colorInterpretation)

Constructor

Method Detail

mergeBuffers

public static void mergeBuffers(Buffer src1,
                                Buffer src2)

addPropertyListener

public void addPropertyListener(PropertyListener listener)

Description copied from interface: Transparency

Asigna un listener a la lista que será informado cuando cambie una propiedad visual en la renderización.

Specified by:

addPropertyListener in interface Transparency

Parameters:

listener - VisualPropertyListener

existAlphaBand

public boolean existAlphaBand()

Description copied from interface: Transparency

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.

Specified by:

existAlphaBand in interface Transparency

Returns:

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

getDataBuffer

public Buffer getDataBuffer()

Obtiene el área de datos

Specified by:

getDataBuffer in interface Transparency

Returns:

Máscara de transparencia

setDataBuffer

public void setDataBuffer(Buffer b)

Description copied from interface: Transparency

Asigna el área de datos

Specified by:

setDataBuffer in interface Transparency

getNoData

public NoData getNoData()

Obtiene el valor noData

Specified by:

getNoData in interface Transparency

Returns:

setNoData

public void setNoData(NoData noData)

Description copied from interface: Transparency

Asigna el valor noData

Specified by:

setNoData in interface Transparency

getTransparencyRange

public List<TransparencyRange> getTransparencyRange()

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

Specified by:

getTransparencyRange in interface Transparency

Returns:

Rangos de transparencias a aplicar

setTransparencyRange

public void setTransparencyRange(TransparencyRange range)

Description copied from interface: Transparency

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

Specified by:

setTransparencyRange in interface Transparency

setTransparencyRangeList

public void setTransparencyRangeList(List<TransparencyRange> ranges)

Asigna la lista de rangos de transparencia

Specified by:

setTransparencyRangeList in interface Transparency

Parameters:

ranges -

clearListOfTransparencyRange

public void clearListOfTransparencyRange()

Description copied from interface: Transparency

Inicializa la lista de rangos de transparencia.

Specified by:

clearListOfTransparencyRange in interface Transparency

getOpacity

public int getOpacity()

Obtiene el grado de opacidad de todo el raster

Specified by:

getOpacity in interface Transparency

Returns:

valor del grado de opacidad.

setOpacity

public void setOpacity(int opacity)

Description copied from interface: Transparency

Asigna el grado de opacidad de todo el raster

Specified by:

setOpacity in interface Transparency

Parameters:

opacity - valor del grado de opacidad.

setTransparencyByPixelFromMetadata

public void setTransparencyByPixelFromMetadata(DataStoreMetadata metadata)

Asigna la transparencia a partir de un objeto con los metadatos del raster.

Parameters:

metadata -

getAlphaBandNumber

public int getAlphaBandNumber()

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

Specified by:

getAlphaBandNumber in interface Transparency

Returns:

número de banda de transparencia o -1 si no existe.

setTransparencyBand

public void setTransparencyBand(int alphaBandNumber)

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.

Specified by:

setTransparencyBand in interface Transparency

Parameters:

true - si existe banda de transparencia y false si no lo es.

isNoData

protected boolean isNoData(int line,
                           int col)

Consulta si el valor de la posición (line, col) del buffer es considerado NoData o no.

Parameters:

line - Linea del buffer

col - Columna del buffer

Returns:

activeTransparency

public void activeTransparency()

Description copied from interface: Transparency

Comprueba si hay criterios para la aplicación de transparencia y la activa si es así sino se desactiva. Los criterios son:

Que haya una mascara de transparencia.

Que exista un buffer de datos para la aplicación de nodata

Que hayan reglas sobre la aplicación de transparencia.

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

Specified by:

activeTransparency in interface Transparency

isTransparencyActive

public boolean isTransparencyActive()

Description copied from interface: Transparency

Obtiene el flag de transparencia activa o desactivada.

Specified by:

isTransparencyActive in interface Transparency

Returns:

true la transparencia está activa y false desactiva

setTransparencyActive

public void setTransparencyActive(boolean transparencyActive)

Asigna el flag de transparencia activa o desactivada.

Specified by:

setTransparencyActive in interface Transparency

Parameters:

transparencyActive - true activa la transparencia false la desactiva

processRGB

public int processRGB(int r,
                      int g,
                      int b,
                      int line,
                      int col,
                      Buffer buf)

Description copied from interface: Transparency

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.

Specified by:

processRGB in interface Transparency

Returns:

setColorInterpretation

public void setColorInterpretation(ColorInterpretation colorInterpretation)

Description copied from interface: Transparency

Sets the band color interpretation

Specified by:

setColorInterpretation in interface Transparency

cloneTransparency

public Transparency cloneTransparency()

Description copied from interface: Transparency

Clones this object

Specified by:

cloneTransparency in interface Transparency

Returns:

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Throws:

PersistenceException

registerPersistence

public static void registerPersistence()

dispose

public void dispose()

Description copied from interface: Disposable

Disposes the current object, to allow it to close and dispose any used resources.

NOTE:After calling this method, the object may not be usable anymore.

Specified by:

dispose in interface Disposable

getColorInterpretation

public ColorInterpretation getColorInterpretation()

Description copied from interface: Transparency

Gets the color interpretation

Specified by:

getColorInterpretation in interface Transparency

Returns:

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable