public class TLcdWMSProxyGXYPainter extends ALcdGXYPainter
ALcdWMSProxy objects.
When painting, the ALcdWMSProxy object is used to connect and retrieve
the necessary raster data from the WMS. This raster data is decoded through ImageIO
to obtain an image. The resulting image is then put in an ILcdRaster,
and rendered through a ALcdRasterPainter to support reprojection.
The ALcdRasterPainter to which is delegated can be configured through
setDelegateRasterPainter(com.luciad.format.raster.ALcdRasterPainter)
and getDelegateRasterPainter().
This painter reprojects the data from the WMS if necessary. The painter automatically determines a reference that is supported by all layers in the GetMap request and that is similar to the world reference of the view. The resulting image is then be warped to match the current world reference.
If a map is requested which contains WMS layers without a common reference, the painter uses multiple requests with different references and then paints the result as one image. It should be noted that using layers with incompatible references will generally be slower because multiple maps have to be retrieved.
A WMS can optionally define a limit on the map width and height in pixels. This painter automatically detects whether the size of the view exceeds those limits. If positive, a map will be requested that matches the maximum width and / or height while still maintaining the original aspect ratio, and image scaling will be applied to match the resulting map with the view.
This painter supports requesting images from the WMS with an extended view port (setBorderFactor(double)).
When the map is panned only slightly the painter checks if the previous requested image can be reused.
This results in less requests to the WMS.
defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBoundsBODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING| Constructor and Description |
|---|
TLcdWMSProxyGXYPainter()
Creates a new
TLcdWMSProxyGXYPainter. |
| Modifier and Type | Method and Description |
|---|---|
void |
boundsSFCT(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext,
ILcd2DEditableBounds a2DEditableBoundsSFCT)
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.
|
double |
getBorderFactor()
Returns the surplus border factor value used by the WMS proxy painter.
|
float |
getBrightness()
Returns the brightness factor that is applied to painted maps.
|
float |
getContrast()
Returns the contrast that is applied to painted maps.
|
ALcdRasterPainter |
getDelegateRasterPainter()
Returns the
ALcdRasterPainter to which the rendering of the object is delegated. |
TLcdWMSGetFeatureInfoContext |
getFeatureInfoContext(int aX,
int aY,
ILcdGXYContext aGXYContext)
Returns a
TLcdWMSGetFeatureInfoContext for the given view coordinate. |
Object |
getObject()
Returns the Object for which the representation is currently being handled by this painter.
|
ILcdXYWorldReference |
getPreferredMapRequestReference()
Returns the preferred reference to be used in WMS map requests.
|
float |
getTransparency()
Returns the transparency factor that is applied to painted maps.
|
boolean |
isTouched(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Checks if the representation of the object in the given mode is touched at the location as defined in the
supplied context.
|
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 |
setBorderFactor(double aBorderFactor)
Sets the surplus border factor value used to request images from the Web Map Server (WMS).
|
void |
setBrightness(float aBrightness)
Sets the brightness factor that is applied to painted maps.
|
void |
setContrast(float aContrast)
Sets the contrast (gamma correction) that is applied to painted maps.
|
void |
setDelegateRasterPainter(ALcdRasterPainter aGXYPainter)
Sets the
ALcdRasterPainter to which the rendering of the raster object is delegated. |
void |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
void |
setPreferredMapRequestReference(ILcdXYWorldReference aPreferredMapRequestReference)
Sets the preferred reference to be used in WMS map requests.
|
void |
setTransparency(float aTransparency)
Sets the transparency factor to be applied to painted maps.
|
addPropertyChangeListener, anchorPointSFCT, clone, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, getGXYPainter, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOn, snapTarget, supportSnappublic TLcdWMSProxyGXYPainter()
TLcdWMSProxyGXYPainter.
By default, the painter uses the current view reference in WMS requests, if this reference is supported
by the WMS server. If this is not the case, a fallback reference supported by the WMS server
is automatically chosen.public double getBorderFactor()
public void setBorderFactor(double aBorderFactor)
The image dimension based on the view size is extended with this surplus border factor in each direction.
Using a value of 0.1 for example results in extending the image size with 10% in every direction.
The total requested image size is then 44% larger than when no surplus border is being used.
This allows to reduce the number of WMS requests for small pan operations on the view and can avoid some empty space on the map while waiting for the WMS response.
Note that the size of the surplus border may be reduced if the requested image size would extend the maximum allowed image size advertised by the WMS.
The default value of the border factor is 0.0.
aBorderFactor - the new surplus border factor value.public void setPreferredMapRequestReference(ILcdXYWorldReference aPreferredMapRequestReference)
null,
indicating that the current reference of the view is used in WMS map requests. If a reference is
set that is not supported by the WMS server, a fallback reference is automatically chosen.aPreferredMapRequestReference - the preferred reference to be used in WMS map requestsgetPreferredMapRequestReference()public ILcdXYWorldReference getPreferredMapRequestReference()
null,
indicating that the current reference of the view is used in WMS map requests.null for the default behaviorsetPreferredMapRequestReference(com.luciad.view.ILcdXYWorldReference)public void setDelegateRasterPainter(ALcdRasterPainter aGXYPainter)
ALcdRasterPainter to which the rendering of the raster object is delegated.aGXYPainter - the ALcdRasterPainter to which the rendering of the raster object is delegated.public ALcdRasterPainter getDelegateRasterPainter()
ALcdRasterPainter to which the rendering of the object is delegated.
By default, an instance of TLcdRasterPainter is used.
ALcdRasterPainter to which the rendering of the object is delegated.public float getTransparency()
setTransparency(float)public void setTransparency(float aTransparency)
aTransparency - the transparencypublic float getBrightness()
setBrightness(float)public void setBrightness(float aBrightness)
aBrightness - the brightnesspublic float getContrast()
setContrast(float)public void setContrast(float aContrast)
aContrast - the contrastpublic boolean isTouched(Graphics aGraphics, int aMode, 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.
aGraphics - the Graphics on which the representation of the object is paintedaMode - the mode the object is represented inaGXYContext - contains the location of the interaction and the transformations to convert this location into
model coordinatesboundsSFCTpublic Object getObject()
ILcdGXYPainterILcdGXYPainter.setObject(Object)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.
aObject - the object for which the representation shall be handled by this painter.ILcdGXYPainter.getObject()public void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds a2DEditableBoundsSFCT) 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.
aGraphics - 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.a2DEditableBoundsSFCT - 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 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.
aGraphics - 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 TLcdWMSGetFeatureInfoContext getFeatureInfoContext(int aX, int aY, ILcdGXYContext aGXYContext)
Returns a TLcdWMSGetFeatureInfoContext for the given view coordinate. This context can be used
to perform a GetFeatureInfo request, see ALcdWMSProxy#createFeatureInfoInputStream. Before calling this method, the WMS proxy for which to get the
GetFeatureInfo context should be set on the painter.
aX - the x coordinate (in view coordinates) for which to retrieve a TLcdWMSGetFeatureInfoContextaY - the y coordinate (in view coordinates) for which to retrieve a TLcdWMSGetFeatureInfoContextaGXYContext - the context.TLcdWMSGetFeatureInfoContext for the given view coordinate or null when the given
coordinate lie outside the WMS model bounds.