com.luciad.view.gxy.painter

LuciadFusionClass TLcdGXYImageIconPainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYPainter

com.luciad.view.gxy.painter.TLcdGXYImageIconPainter

All Implemented Interfaces:

ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYPainter, ILcdGXYPainterProvider, Serializable, Cloneable

public class TLcdGXYImageIconPainter
extends ALcdGXYPainter

This ILcdGXYPainter paints ALcdImage using icons at regular grid locations in the view. The grid spacing and the icon can be specified.

This painter can for example be used to label an image containing temperature values, or to label a multi-band image containing the x- and y- components of wind speed. For example:

Since:

2015.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.luciad.view.gxy.ALcdGXYPainter

defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBounds

Fields inherited from interface com.luciad.view.gxy.ILcdGXYPainter

BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

Constructor Summary

Constructors

Constructor and Description
TLcdGXYImageIconPainter() Creates a new TLcdGXYImageIconPainter using a default shared imaging engine.
TLcdGXYImageIconPainter(ALcdImagingEngine aImagingEngine) Create a new TLcdGXYImageIconPainter which uses the specified imaging engine.

Method Summary

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	getDeltaX() Returns the horizontal grid spacing of the icons, expressed in pixels.
int	getDeltaY() Returns the vertical grid spacing of the icons, expressed in pixels.
Color	getHaloColor() Returns the halo color of multi-valued raster icons.
int	getHaloThickness() Returns the halo thickness of image icons in pixels.
ELcdInterpolationType	getInterpolationType() Returns the interpolation type that is used to sample the image when determining parameter values for the icon.
Object	getObject() Returns the Object for which the representation is currently being handled by this painter.
ILcdParameterizedIcon	getParameterizedIcon() Returns the parameterized icon.
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	setDeltaX(int aDeltaX) Sets the horizontal grid spacing of the icons, expressed in pixels.
void	setDeltaY(int aDeltaY) Sets the vertical grid spacing of the icons, expressed in pixels.
void	setHaloColor(Color aHaloColor) Sets the halo color of multi-valued raster icons.
void	setHaloThickness(int aHaloThickness) Sets the halo thickness of image icons in pixels.
void	setInterpolationType(ELcdInterpolationType aInterpolationType) Sets the interpolation type that is used to sample the image when determining parameter values for the icon.
void	setObject(Object aObject) Sets the Object for which the representation shall be handled by this painter.
void	setParameterizedIcon(ILcdParameterizedIcon aParameterizedIcon) Sets the parameterized icon.

Methods inherited from class com.luciad.view.gxy.ALcdGXYPainter

addPropertyChangeListener, anchorPointSFCT, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, getGXYPainter, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOn, snapTarget, supportSnap

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdGXYImageIconPainter

public TLcdGXYImageIconPainter()

Creates a new TLcdGXYImageIconPainter using a default shared imaging engine.

TLcdGXYImageIconPainter

public TLcdGXYImageIconPainter(ALcdImagingEngine aImagingEngine)

Create a new TLcdGXYImageIconPainter which uses the specified imaging engine.

Parameters:

aImagingEngine - imaging engine to use.

Method Detail

getDeltaX

public int getDeltaX()

Returns the horizontal grid spacing of the icons, expressed in pixels.

Returns:

the horizontal grid spacing of the icons, expressed in pixels.

See Also:

setDeltaX(int)

setDeltaX

public void setDeltaX(int aDeltaX)

Sets the horizontal grid spacing of the icons, expressed in pixels. The default is 50.

Parameters:

aDeltaX - the horizontal grid spacing of the icons, expressed in pixels.

See Also:

getDeltaX()

getDeltaY

public int getDeltaY()

Returns the vertical grid spacing of the icons, expressed in pixels.

Returns:

the vertical grid spacing of the icons, expressed in pixels.

See Also:

setDeltaY(int)

setDeltaY

public void setDeltaY(int aDeltaY)

Sets the vertical grid spacing of the icons, expressed in pixels. The default is 50.

Parameters:

aDeltaY - the vertical grid spacing of the icons, expressed in pixels.

See Also:

getDeltaY()

getParameterizedIcon

public ILcdParameterizedIcon getParameterizedIcon()

Returns the parameterized icon.

Returns:

the parameterized icon.

See Also:

setParameterizedIcon(com.luciad.format.raster.ILcdParameterizedIcon)

setParameterizedIcon

public void setParameterizedIcon(ILcdParameterizedIcon aParameterizedIcon)

Sets the parameterized icon. If the icon implements ILcdOriented, its orientation is taken into account. By default, an icon is used that displays a numeric String, based on the first parameter that is passed to it.

Parameters:

aParameterizedIcon - the parametrized icon to use.

See Also:

getParameterizedIcon()

getInterpolationType

public ELcdInterpolationType getInterpolationType()

Returns the interpolation type that is used to sample the image when determining parameter values for the icon.

Returns:

the interpolation type that is used to sample the image.

See Also:

setInterpolationType(com.luciad.util.ELcdInterpolationType)

setInterpolationType

public void setInterpolationType(ELcdInterpolationType aInterpolationType)

Sets the interpolation type that is used to sample the image when determining parameter values for the icon. The default is ELcdInterpolationType.NONE. Note that only NONE and LINEAR are currently supported.

Parameters:

aInterpolationType - the interpolation type.

See Also:

getInterpolationType()

getHaloColor

public Color getHaloColor()

Returns the halo color of multi-valued raster icons. This property is only used if the halo thickness is larger than 0.

Returns:

the halo color

setHaloColor

public void setHaloColor(Color aHaloColor)

Sets the halo color of multi-valued raster icons. This property is only used if the halo thickness is larger than 0.

Parameters:

aHaloColor - the halo color

getHaloThickness

public int getHaloThickness()

Returns the halo thickness of image icons in pixels.

Returns:

the thickness in pixels (zero if no halo should be visible)

See Also:

setHaloThickness(int)

setHaloThickness

public void setHaloThickness(int aHaloThickness)

Sets the halo thickness of image icons in pixels.

Parameters:

aHaloThickness - the thickness in pixels (zero if no halo should be visible)

See Also:

getHaloThickness()

setObject

public void setObject(Object aObject)

Description copied from interface: ILcdGXYPainter

Sets the Object for which the representation shall be handled by this painter.

Setting 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.

Parameters:

aObject - the object for which the representation shall be handled by this painter.

See Also:

ILcdGXYPainter.getObject()

getObject

public Object getObject()

Description copied from interface: ILcdGXYPainter

Returns the Object for which the representation is currently being handled by this painter.

Returns:

the Object for which the representation is currently being handled by this painter.

See Also:

ILcdGXYPainter.setObject(Object)

paint

public void paint(Graphics aGraphics,
                  int aMode,
                  ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYPainter

Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.

The 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:

• transformations which allow to compute the location in view space of points and bounds given in model, space
• a pen which can connect points with a line or create arcs around a point,
• the view for which the object's representation must be painted. This can be useful when the painted object depends on the scale of the view, or the presence of other layers in the view.
• the current location(s) of the mouse or input device and the last location(s) the mouse or input device was pressed.

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.

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in (see class documentation).

aGXYContext - the ILcdGXYContext the drawing depends on.

boundsSFCT

public void boundsSFCT(Graphics aGraphics,
                       int aMode,
                       ILcdGXYContext aGXYContext,
                       ILcd2DEditableBounds aBoundsSFCT)
                throws TLcdNoBoundsException

Description copied from interface: ILcdGXYPainter

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.

If 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.

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - 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.

Throws:

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.

See Also:

isTouched

isTouched

public boolean isTouched(Graphics aGraphics,
                         int aMode,
                         ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYPainter

Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.

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:

• transform the location of the interaction back to model space and compare the coordinates with the object in model space.
• transform the location to world space and compare with a world representation of the object. This forces the painter into caching a world representation of the object. Caching a view representation of an object is not very practical as it would have to change whenever the view's scale changes or when it is panned. A world representation of an object only changes when the view's XYWorldReference changes, which happens less frequently.

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.

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in

aGXYContext - contains the location of the interaction and the transformations to convert this location into model coordinates

Returns:

true if the representation of the object in the given mode is touched by the location as defined in the context passed, false otherwise

See Also:

boundsSFCT

clone

public Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from 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 );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Specified by:

clone in interface ILcdGXYPainterProvider

Overrides:

clone in class ALcdGXYPainter

Returns:

a clone of this painter provider.

See Also:

Object.clone()