public class TLcdRasterPainter extends ALcdRasterPainter implements ILcdRasterPainter, ILcdGXYPainterProvider
com.luciad.imaging presents a new API
for the modeling of raster data. For new projects, it is recommended to use
this API instead of ILcdRaster et al. For visualization in a GXY view,
see TLcdGXYImagePainter
This ILcdGXYPainter can paint ILcdRaster instances.
It can warp them between different coordinate systems, if required, or just
paint their linearly scaled images, if possible.
It paints the visible portion of the raster if the scale of the
ILcdGXYView on which to paint is such that the screen resolution
is inside the range defined by the properties startResolutionFactor and
stopResolutionFactor. Outside of this range, it paints only the outline of
the tiles of the raster The resolution factor defines ratio between the
resolution of the raster and the resolution of the screen. For example, a
resolution factor of 4 indicates that 4 raster pixels are used to color a
single screen pixel. A factor of 0.25 indicates that a single raster pixel
will be used to paint four screen pixels. Typical values for
startResolutionFactor and stopResolutionFactor are 2 and 0.5, respectively,
indicating that as we zoom in, the raster becomes visible at a point where 2
raster pixels are merged into a single screen pixel, and the raster becomes
invisible at a point where a single raster pixel is blurred into two screen
pixels.
The value of the startResolutionFactor, the dimensions of the tiles and the
dimension of the ILcdGXYView on which to paint, determine the
maximum number of tiles that need to be loaded in memory, when painting the
visible portion of the raster. The minimum value of the maximum number of
tiles is always four because the visible portion can always be pointed at the
intersection of four tiles. Suppose we have tiles of 1024 by 1024 pixels, and
a maximum ILcdGXYView size of 800 by 600. Suppose further that
we we choose a startResolutionFactor of 9. Then, there may be a maximum of 3
by 2 tiles needed to paint the 800 by 600 ILcdGXYView, thus
requiring 6 tiles to be in memory. This calculation is a rough approximation
because of the non-linear transformation between the data reference of the
raster and the data reference of the ILcdGXYView. For example,
at a small scale, an ILcdGXYView with a data reference based on
an Orthographic projection may require more tiles than calculated with the
above procedure. Therefore, as a rule of thumb, allocate twice the amount of
memory to hold the maximum number of tiles calculated.
It is clear that, if the number of non-empty tiles in the raster is less than four, the value of the startResolutionFactor can be set at any value.
Often times, multiple instances of ILcdRaster with different
resolutions are painted in different layers. In that case, the choice of the
startResolutionFactor and the stopResolutionFactor of the different
TLcdRasterPainters is often chosen such that the
stopResolutionFactor of the painter in one layer corresponds to the
startResolutionFactor of the next layer holding a raster with a higher
resolution. For example, suppose we have two ILcdRaster objects,
one that holds 1 degree by 1 degree tiles of 1024 by 1024 pixels and a second
raster 30' by 30' of 1024 by 1024 pixels. The resolution of the second raster
is four times the resolution of the first raster. Hence, in order to match
the stopResolutionFactor of the first raster with the startResolutionFactor
of the second raster, they have to be in the proportion of 1 to 4. The
symmetrical choice around a ResolutionFactor of 1 is 0.5 for the
stopResolutionFactor of the painter of the first raster and 2 for the
startResolutionFactor of the painter of the second raster.
DENSITY_OK, DENSITY_TOO_HIGH, DENSITY_TOO_LOW, fBrightness, fColorModel, fContrast, fFillOutlineArea, fForcePainting, fMaxNumberOfOutlineTiles, fPaintOutline, fRGBImageFilter, fStartResolutionFactor, fStopResolutionFactor, fTransparencydefaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBoundsBODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING| Constructor and Description |
|---|
TLcdRasterPainter()
Creates a new TLcdRasterPainter, with a default name.
|
TLcdRasterPainter(String aDisplayName)
Creates a new TLcdRasterPainter.
|
| Modifier and Type | Method and Description |
|---|---|
void |
boundsSFCT(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext,
ILcd2DEditableBounds aBoundsSFCT)
Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object
in the given mode taking into account the given context.
|
Object |
clone()
Makes
Object.clone() public. |
int |
getBorder()
Returns the additional border around all sides of the view.
|
ILcdGXYPainter |
getGXYPainter(Object aObject)
Finds an
ILcdGXYPainter that can be used to paint or locate the object passed. |
Object |
getObject()
Returns the Object for which the representation is currently being handled by this painter.
|
int |
getOversamplingRate()
Returns the sampling rate used when transforming the raster.
|
boolean |
getPaintCache()
Returns whether this painter caches the warped raster images it has
painted.
|
int |
getWarpBlockSize()
Returns the width and height of the block in which the raster
transformation is approximated using bilinear interpolation.
|
boolean |
isAvoidOpaqueBorder() |
boolean |
isReuseInternalBuffer()
Returns whether this painter caches a single warped raster image with this
raster painter.
|
boolean |
isTouched(Graphics aGraphics,
int aState,
ILcdGXYContext aGXYContext)
Checks if the representation of the object in the given mode is touched at the location as defined in the
supplied context.
|
boolean |
isUseDeferredSubTileDecoding()
Returns whether this painter does not wait for tiles to be fully decoded
before painting them.
|
boolean |
isUseSubTileImageCaching()
Returns whether this painter caches images that have been created from
raster subtiles.
|
void |
paint(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Displays the representation of the object in the given mode on the Graphics passed, taking into account the
supplied context.
|
void |
setAvoidOpaqueBorder(boolean aAvoidOpaqueBorder)
Specifies whether the painter should avoid drawing opaque borders around
transformed rasters.
|
void |
setBorder(int aBorder)
Sets an additional border around all sides of the view, defining a region
in which a painted raster is transformed and cached.
|
void |
setBrightness(float aBrightness)
Sets the brightness factor that is applied to painted rasters.
|
void |
setColorModel(ColorModel aColorModel)
Sets the ColorModel that determines how a raster pixel is transformed
into color components for a screen pixel.
|
void |
setContrast(float aContrast)
Sets the gamma correction that is applied to painted rasters.
|
void |
setFillOutlineArea(boolean aFillOutlineArea)
Specifies whether the raster outlines and tile outlines should be filled
when the pixel density (number of raster pixels per screen pixel) of the
raster to be painted is higher than the startResolutionFactor.
|
void |
setForcePainting(boolean aForcePainting)
Specifies whether the visible portion of the raster should always be
painted, irrespective of the startResolutionFactor and
stopResolutionFactor.
|
void |
setMaxNoOfOutlineTiles(int aMaxNumberOfOutlineTiles) |
void |
setMaxNumberOfOutlineTiles(int aMaxNumberOfOutlineTiles)
Sets the maximum number of outlines of individual tiles to paint when
the pixel density (number of raster pixels per screen pixel) of the raster
to be painted is higher than the startResolutionFactor.
|
void |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
void |
setOutlineAreaFillStyle(ILcdGXYPainterStyle aFillStyle)
Sets the style that is used when filling the outline area of raster and/or tiles.
|
void |
setOutlineColor(Color aColor)
Sets the line color used to paint the raster outlines and tile outlines
when the pixel density (number of raster pixels per screen pixel) of the
raster to be painted is higher than the startResolutionFactor.
|
void |
setOutlineStyle(ILcdGXYPainterStyle aOutlineStyle)
Sets the style that is used when drawing the outline of the area of raster and/or tiles.
|
void |
setOversamplingRate(int aOverSamplingRate)
Sets the number of samples used per pixel when transforming a raster.
|
void |
setPaintCache(boolean aCache)
Specifies whether this painter should cache the warped raster images it
has painted.
|
void |
setPaintOutline(boolean aPaintOutline)
Specifies whether the raster outlines and tile outlines should be painted
when the pixel density (number of raster pixels per screen pixel) of the
raster to be painted is higher than the startResolutionFactor.
|
void |
setReuseInternalBuffer(boolean aReuseInternalBuffer)
Specifies whether this painter should cache a single warped raster image
with this raster painter, or whether it should cache a warped raster
image with each raster that is painted.
|
void |
setRGBImageFilter(RGBImageFilter aRGBImageFilter)
Sets the optional filter that is applied to painted rasters.
|
void |
setStartResolutionFactor(double aFactor)
Sets the highest pixel density (number of raster pixels per screen pixel)
at which a raster is painted.
|
void |
setStartScale(double aStartScale)
As an alternative for the start resolution factor and stop resolution factor, this method and
ALcdRasterPainter.getStopScale() can be used for more intuitive control on when to paint a raster and when
to paint the outline. |
void |
setStopResolutionFactor(double aFactor)
Sets the lowest pixel density (number of raster pixels per screen pixel)
at which a raster is painted.
|
void |
setStopScale(double aStopScale)
As an alternative for the start resolution factor and stop resolution factor, this method and
ALcdRasterPainter.getStartScale() can be used for more intuitive control on when to paint a raster. |
void |
setTransparency(float aTransparency)
Sets the transparency factor that is applied to painted rasters.
|
void |
setUseDeferredSubTileDecoding(boolean aDefer)
Specifies whether this painter should not wait for tiles to be fully
decoded before painting them.
|
void |
setUseSubTileImageCaching(boolean aCaching)
Specifies whether this painter should cache images that have been created
from raster subtiles.
|
void |
setWarpBlockSize(int aWarpBlockSize)
Sets the width and height of the block in which the raster transformation
is approximated using bilinear interpolation.
|
densityCheck, densityCheck, getBrightness, getColorModel, getContrast, getMaxNoOfOutlineTiles, getMaxNumberOfOutlineTiles, getOutlineAreaFillStyle, getOutlineColor, getOutlineStyle, getRGBImageFilter, getSnapIcon, getStartResolutionFactor, getStartScale, getStopResolutionFactor, getStopScale, getTransparency, idealPixelDensity, idealPixelDensity, idealPixelDensity, isFillOutlineArea, isForcePainting, isPaintOutline, resolutionFactor, setSnapIcon, snapTarget, supportSnapaddPropertyChangeListener, anchorPointSFCT, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOnequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetBrightness, getColorModel, getMaxNoOfOutlineTiles, getMaxNumberOfOutlineTiles, getOutlineColor, getStartResolutionFactor, getStopResolutionFactor, getTransparency, isForcePainting, isPaintOutlineanchorPointSFCT, getCursor, getDisplayName, snapTarget, supportSnapaddPropertyChangeListener, removePropertyChangeListenerpublic TLcdRasterPainter()
public TLcdRasterPainter(String aDisplayName)
aDisplayName - the displayName of the painter.public void setStartResolutionFactor(double aFactor)
ILcdRasterPaintersetStartResolutionFactor in interface ILcdRasterPaintersetStartResolutionFactor in class ALcdRasterPainterpublic void setStopResolutionFactor(double aFactor)
ILcdRasterPaintersetStopResolutionFactor in interface ILcdRasterPaintersetStopResolutionFactor in class ALcdRasterPainterpublic void setStartScale(double aStartScale)
ALcdRasterPainterALcdRasterPainter.getStopScale() can be used for more intuitive control on when to paint a raster and when
to paint the outline. When the internal scale of the view (ILcdGXYView.getScale()
is smaller than the start scale, the outline will be painted in stead of the raster.
The default value is 0.
Warning: when the view scale is in between the start and stop scale, the start
resolution factor and the stop resolution factor are still used as a second check. If you don't
want interference from these two settings, set the start resolution factor to Double.POSITIVE_INFINITY
and the stop resolution factor to 0.setStartScale in class ALcdRasterPainteraStartScale - The view scale at which one starts painting the raster rather that the outline (when zooming in).ALcdRasterPainter.getStartScale()public void setStopScale(double aStopScale)
ALcdRasterPainterALcdRasterPainter.getStartScale() can be used for more intuitive control on when to paint a raster.
When the internal scale of the view (ILcdGXYView.getScale()
is larger than the stop scale, the raster won't be painted.
The default value is Double.POSITIVE_INFINITY.setStopScale in class ALcdRasterPainteraStopScale - The view scale at which one stops painting the raster (when zooming in).ALcdRasterPainter.getStopScale()public void setForcePainting(boolean aForcePainting)
ILcdRasterPaintersetForcePainting in interface ILcdRasterPaintersetForcePainting in class ALcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double),
ILcdRasterPainter.setStopResolutionFactor(double)public void setPaintOutline(boolean aPaintOutline)
ILcdRasterPaintersetPaintOutline in interface ILcdRasterPaintersetPaintOutline in class ALcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double)public void setOutlineStyle(ILcdGXYPainterStyle aOutlineStyle)
ALcdRasterPainternon-null value the configure style will take precedence over the
configured outline color if the style modifies the Graphics current color.setOutlineStyle in class ALcdRasterPainteraOutlineStyle - the outline style to useALcdRasterPainter.setPaintOutline(boolean),
ALcdRasterPainter.setOutlineColor(java.awt.Color)public void setOutlineColor(Color aColor)
ILcdRasterPaintersetOutlineColor in interface ILcdRasterPaintersetOutlineColor in class ALcdRasterPainterILcdRasterPainter.setPaintOutline(boolean),
ILcdRasterPainter.setStartResolutionFactor(double)public void setFillOutlineArea(boolean aFillOutlineArea)
ALcdRasterPaintersetFillOutlineArea in class ALcdRasterPainterALcdRasterPainter.setStartResolutionFactor(double),
ALcdRasterPainter.setPaintOutline(boolean)public void setOutlineAreaFillStyle(ILcdGXYPainterStyle aFillStyle)
ALcdRasterPainternull and fill outline area
is enabled the result visual result on screen is undefined.setOutlineAreaFillStyle in class ALcdRasterPainteraFillStyle - the fill style to useALcdRasterPainter.setFillOutlineArea(boolean)public void setMaxNumberOfOutlineTiles(int aMaxNumberOfOutlineTiles)
ILcdRasterPaintersetMaxNumberOfOutlineTiles in interface ILcdRasterPaintersetMaxNumberOfOutlineTiles in class ALcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double)public void setMaxNoOfOutlineTiles(int aMaxNumberOfOutlineTiles)
setMaxNoOfOutlineTiles in interface ILcdRasterPaintersetMaxNoOfOutlineTiles in class ALcdRasterPainterpublic void setColorModel(ColorModel aColorModel)
ILcdRasterPaintersetColorModel in interface ILcdRasterPaintersetColorModel in class ALcdRasterPainterpublic void setRGBImageFilter(RGBImageFilter aRGBImageFilter)
ALcdRasterPaintersetRGBImageFilter in class ALcdRasterPainterpublic void setTransparency(float aTransparency)
ILcdRasterPaintersetTransparency in interface ILcdRasterPaintersetTransparency in class ALcdRasterPainterpublic void setBrightness(float aBrightness)
ILcdRasterPaintersetBrightness in interface ILcdRasterPaintersetBrightness in class ALcdRasterPainterALcdRasterPainter.setContrast(float)public void setContrast(float aContrast)
ALcdRasterPaintersetContrast in class ALcdRasterPainterpublic void setUseSubTileImageCaching(boolean aCaching)
true helps to
avoid disk access during painting (due to lazy loading of raster tiles).
It may also speed up the painting of rasters with non-standard color
models, like 16 bit indexed color images. The default is
false.
This property is only relevant for rasters that don't have to be warped, that is, when the model reference of the raster is the same as the world reference of the view.
public boolean isUseSubTileImageCaching()
setUseSubTileImageCaching(boolean)public void setUseDeferredSubTileDecoding(boolean aDefer)
true
means that parts of the view may remain blank, but the display will update
sooner. A proper complete display update will be triggered when there are
no more tiles waiting to be decoded. The default is false.
This property is only relevant if isUseSubTileImageCaching() is true.
Note that this functionality is not needed for layers wrapped by ILcdGXYAsynchronousLayerWrapper. For best results, use the latter mechanism instead and set this property to false.
public boolean isUseDeferredSubTileDecoding()
setUseDeferredSubTileDecoding(boolean)public void setPaintCache(boolean aCache)
true.
This property is only relevant for rasters that have to be warped, that is, when the model reference of the raster is different from the world reference of the view.
setReuseInternalBuffer(boolean)public boolean getPaintCache()
setPaintCache(boolean)public void setAvoidOpaqueBorder(boolean aAvoidOpaqueBorder)
The painter normally uses the default pixel of a raster when painting the border around a transformed raster. If the default pixel is transparent, the border is invisible. Otherwise, the border is opaque. This typically occurs if a raster has an IndexColorModel without a transparent color index.
Setting this property activates some additional processing to avoid the
opaque border anyway. The processing overhead can run up to 50% when
painting described rasters. Leaving the property unset is therefore
preferable, for instance when the area around painted rasters is not
relevant for the application. The default is false.
public boolean isAvoidOpaqueBorder()
setAvoidOpaqueBorder(boolean)public void setReuseInternalBuffer(boolean aReuseInternalBuffer)
false.
This property is only relevant if setPaintCache(boolean) is
true.
public boolean isReuseInternalBuffer()
setReuseInternalBuffer(boolean)public void setBorder(int aBorder)
This property is only relevant for rasters that have to be warped, that is, when the model reference of the raster is different from the world reference of the view.
aBorder - the border, expressed in pixels.public int getBorder()
setBorder(int)public void setOversamplingRate(int aOverSamplingRate)
(aOverSamplingRate * aOverSamplingRate). For instance,
if the oversampling rate is set to 2, the painter will take 4 samples
per pixel and average their values. This increases the image quality,
especially if the raster contains sharp edges, but it also increases
the computational cost.
This property is only relevant for rasters that have to be warped, that is, when the model reference of the raster is different from the world reference of the view.
aOverSamplingRate - the number of samples used per pixel in one direction.public int getOversamplingRate()
setOversamplingRate(int)public void setWarpBlockSize(int aWarpBlockSize)
This property is only relevant for rasters that have to be warped, that is, when the model reference of the raster is different from the world reference of the view.
aWarpBlockSize - the width and height, expressed in pixels.public int getWarpBlockSize()
setWarpBlockSize(int)public void setObject(Object aObject)
ILcdGXYPainterSetting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.
When the object is set to a painter, the context parameter in subsequent calls to methods in this class must contain a layer that contains this object and for which the painter for this object is this painter.
setObject in interface ILcdGXYPainteraObject - the object for which the representation shall be handled by this painter.ILcdGXYPainter.getObject()public Object getObject()
ILcdGXYPaintergetObject in interface ILcdGXYPainterILcdGXYPainter.setObject(Object)public void paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainterThe visual representation of an object depends on the context. Depending on the context (e.g. is the location covered by the view), an object may or may not have a representation. The context contains:
The mode passed in this method indicates what part of the object must be painted, whether it should be painted as selected or not, and whether user interaction (via mouse movements) must be taken into account.
When the mode passed contains either TRANSLATING, RESHAPING or CREATING, this method is also responsible for
interpreting interaction on the representation of an object and modifying the representation of the object
accordingly. The painter is not responsible for modifying the object itself, this is done by
a corresponding ILcdGXYEditor .
Implementations of ILcdGXYPainter and ILcdGXYEditor interfaces must be consistent for
an object: the painter must display the result of the user interaction on the object, while the editor is
responsible for modifying the object as a result of the user interaction.
A good practice to ensure a consistent implementation is to implement both the ILcdGXYPainter
and ILcdGXYEditor interfaces in a single class.
When the mode passed includes SNAPS, the part of the representation which corresponds to the object returned as
snap target by the method snapTarget
must be painted in order to provide the user with a visual indication of the snap target.
The Graphics passed in this method can be different from the Graphics returned by a view due to techniques such as double buffering (as applied in Swing). Basic drawing operations must always be performed on the Graphics passed as an argument in this method.
paint in interface ILcdGXYPainterpaint in class ALcdRasterPainteraGraphics - the Graphics on which the representation of the object is paintedaMode - the mode the object is represented in (see class documentation).aGXYContext - the ILcdGXYContext the drawing depends on.public boolean isTouched(Graphics aGraphics, int aState, ILcdGXYContext aGXYContext)
ILcdGXYPainter
The location that must be taken into account to check whether the representation is touched can be retrieved from
the context passed with the methods
ILcdGXYContext.getX() and ILcdGXYContext.getY().
If the check is part of an ongoing operation of
user interaction, for example, when the mouse is being dragged, the location of the start of the operation can also
be taken into account using the methods
ILcdGXYContext.getDeltaX() and ILcdGXYContext.getDeltaY().
The context contains the transformations required to convert this location into the equivalent location in
model space. Implementations of this interface usually follow either of the following patterns:
As the mode influences the way an object is represented, it must also be taken into account when checking whether that representation is being touched. When the mode contains CREATING, RESHAPING or TRANSLATING which indicate that the object must be represented in a state for an ongoing operation, the location of the start of the operation may be taken into account as mentioned above. The painting result can take into account multiple locations, to respond to, for example, multi-touch input. When the mode contains SELECTED, the painter should also check if the non-selected representation is touched, since these are always painted on top of each other.
The boundsSFCT is often used to speed up the performance of this method as a location outside these bounds can never
touch the representation of the object.
Note that this method does not give an indication of what part of the object is touched. It is up to the painter implementations to provide methods to make this distinction. The method does also not indicate what sensitivity must be applied when checking if an object is touched. It is up to the implementation to decide what should be the maximum distance between the location given in the context and the closest relevant point or area of the representation of the object.
isTouched in interface ILcdGXYPainterisTouched in class ALcdRasterPainteraGraphics - the Graphics on which the representation of the object is paintedaState - the mode the object is represented inaGXYContext - contains the location of the interaction and the transformations to convert this location into
model coordinatesboundsSFCTpublic void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
ILcdGXYPainterIf this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.
The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model
space for ILcdBounded objects.
boundsSFCT in interface ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaMode - the mode the object is represented in (see class documentation). For example, an object may be
represented differently in SELECTED mode compared to DEFAULT mode. The returned bounds of the representation
must take this different representation into account.aGXYContext - the context for which the representation of the object is painted. It contains amongst others
the transformations from model to world and world to view.aBoundsSFCT - the bounds that must be adapted to encompass the representation of the object in the given
mode and context. These bounds must not be taken into account when the method has thrown an exception.TLcdNoBoundsException - if no bounds can be determined for the representation of the object.
This can happen when the object does not have a representation in the given context, for example when it is located
in a part of the world which is not visible in the current view.isTouchedpublic ILcdGXYPainter getGXYPainter(Object aObject)
ILcdGXYPainterProviderILcdGXYPainter that can be used to paint or locate the object passed.
The painter provider is responsible for setting the object to the painter before returning the painter. An implementation should therefore have the following structure:
public ILcdGXYPainter getGXYPainter(Object aObject) {
ILcdGXYPainter painter = ... // find the painter for the object
if (painter != null) {
painter.setObject(aObject);
}
return painter;
}
getGXYPainter in interface ILcdGXYPainterProvidergetGXYPainter in class ALcdGXYPainteraObject - the object to find a painter forpublic Object clone()
ILcdCloneableMakes Object.clone() public.
java.lang.Object, it can be implemented like this:
public Object clone() {
try {
return super.clone();
} catch ( CloneNotSupportedException e ) {
// Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
throw new RuntimeException( e );
}
}
clone in interface ILcdCloneableclone in interface ILcdGXYPainterProviderclone in class ALcdRasterPainterObject.clone()