public class TLcdWarpRasterPainter extends ALcdRasterPainter implements ILcdRasterPainter, ILcdGXYPainterProvider
ILcdGXYPainter can paint ILcdRaster instances,
warping them between different coordinate systems as required.
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.
ILcdRaster,
Serialized FormDENSITY_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 |
|---|
TLcdWarpRasterPainter()
Creates a new TLcdWarpRasterPainter, with a default name.
|
TLcdWarpRasterPainter(String aDisplayName)
Creates a new TLcdWarpRasterPainter.
|
| 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. |
protected Image |
createTransformedImage(ILcdGXYContext aGXYContext,
Rectangle aClip,
ILcdRaster aRaster,
RGBImageFilter aRGBImageFilter,
float aTransparency,
float aBrightness,
float aContrast,
ColorModel aColorModel)
Creates the warped image that can be painted onto the view.
|
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 |
isTraceOn()
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
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 |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
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 |
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 |
setTraceOn(boolean aTraceOn)
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
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, isTouched, resolutionFactor, setBrightness, setColorModel, setContrast, setFillOutlineArea, setForcePainting, setMaxNoOfOutlineTiles, setMaxNumberOfOutlineTiles, setOutlineAreaFillStyle, setOutlineColor, setOutlineStyle, setPaintOutline, setRGBImageFilter, setSnapIcon, setStartResolutionFactor, setStartScale, setStopResolutionFactor, setStopScale, setTransparency, snapTarget, supportSnapaddPropertyChangeListener, anchorPointSFCT, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, removePropertyChangeListener, setClassTraceOn, setDisplayNameequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetBrightness, getColorModel, getMaxNoOfOutlineTiles, getMaxNumberOfOutlineTiles, getOutlineColor, getStartResolutionFactor, getStopResolutionFactor, getTransparency, isForcePainting, isPaintOutline, setBrightness, setColorModel, setForcePainting, setMaxNoOfOutlineTiles, setMaxNumberOfOutlineTiles, setOutlineColor, setPaintOutline, setStartResolutionFactor, setStopResolutionFactor, setTransparencyanchorPointSFCT, getCursor, getDisplayName, isTouched, snapTarget, supportSnapaddPropertyChangeListener, removePropertyChangeListenerpublic TLcdWarpRasterPainter()
public TLcdWarpRasterPainter(String aDisplayName)
aDisplayName - the displayName of the painter.public void setTraceOn(boolean aTraceOn)
true or false as argument automatically turns
off tracing for all other class instances for which
setTraceOn has not been called.
If the argument is false then only the informative, warning
and error log messages are recorded.setTraceOn in class ALcdGXYPainteraTraceOn - if true then all log messages are recorded for this
instance. If false, then only the informative, warning and
error log messages are recorded.public boolean isTraceOn()
true if tracing is enabled for this class.isTraceOn in class ALcdGXYPainterpublic void setPaintCache(boolean aCache)
true.setReuseInternalBuffer(boolean)public boolean getPaintCache()
setPaintCache(boolean)public void setReuseInternalBuffer(boolean aReuseInternalBuffer)
false.
This property is only relevant if setPaintCache(boolean) is
true.
public boolean isReuseInternalBuffer()
setReuseInternalBuffer(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 setBorder(int aBorder)
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.aOverSamplingRate - the number of samples used per pixel in one direction.public int getOversamplingRate()
setOversamplingRate(int)public void setWarpBlockSize(int aWarpBlockSize)
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.protected Image createTransformedImage(ILcdGXYContext aGXYContext, Rectangle aClip, ILcdRaster aRaster, RGBImageFilter aRGBImageFilter, float aTransparency, float aBrightness, float aContrast, ColorModel aColorModel)
This method is subject to change.
paint(Graphics, int, ILcdGXYContext)public 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()