com.luciad.format.raster

LuciadLightspeedInterface ILcdParameterizedIcon

All Known Implementing Classes:

ALcdEarth2DVectorIcon, ALcdEarthParameterizedIcon, TLcdEarthArrowIcon, TLcdEarthSparseIcon, TLcdEarthWindIcon, TLcdNumericParameterizedIcon

public interface ILcdParameterizedIcon

An icon that is based on a set of parameters. It can be used as an alternate means to visualize multi-dimensional raster data.

Since:

2015.0

See Also:

TLcdGXYImageIconPainter, TLspParameterizedRasterIconStyle

Method Summary

Modifier and Type	Method and Description
void	anchorPointSFCT(double[] aParameters, Point aPointSFCT) Returns the anchor point of this icon.
int	getHeight(double[] aParameters) Returns the height of the icon for the given parameter values.
int	getWidth(double[] aParameters) Returns the width of the icon for the given parameter values.
void	paintIcon(Graphics aGraphics, int aX, int aY, double[] aParameters) Paint the icon at the specified location for the parameters

Method Detail

paintIcon

void paintIcon(Graphics aGraphics,
               int aX,
               int aY,
               double[] aParameters)

Paint the icon at the specified location for the parameters

Parameters:

aGraphics - the Graphics on which the icon is painted

aX - the x coordinate at which the icon is painted. aX is the x-coordinate of the top left corner point of the icon.

aY - the y coordinate at which the icon is painted. aY is the y-coordinate of the top left corner point of the icon.

aParameters - the parameter values

getWidth

int getWidth(double[] aParameters)

Returns the width of the icon for the given parameter values.

Parameters:

aParameters - the parameter values as passed in paintIcon(java.awt.Graphics, int, int, double[])

Returns:

the width

getHeight

int getHeight(double[] aParameters)

Returns the height of the icon for the given parameter values.

Parameters:

aParameters - the parameter values as passed in paintIcon(java.awt.Graphics, int, int, double[])

Returns:

the height

anchorPointSFCT

void anchorPointSFCT(double[] aParameters,
                     Point aPointSFCT)

Returns the anchor point of this icon. The anchor point of an icon is the point on the icon that is attached to the underlying object. For example: a circle icon is attached to an underlying point object by its center. An arrow icon can for example be attached to its object at the start of the arrow. The x-coordinate of the anchor point typically lies between 0 and getWidth(). The y-coordinate typically lies between 0 and getHeight().

Note that implementations don't need to take the anchor point into account when implementing the paintIcon method. The coordinates passed to that method always represent the top left corner of the icon. Callers of the paint method should make sure that the anchor point is taken into account.

A good default implementation can be to use the middle of the icon:

 aPointSFCT.setLocation(getWidth(aParameters) / 2, getHeight(aParameters) / 2);
 

Parameters:

aParameters - the parameter values

aPointSFCT - the point that has to be moved to the location of the anchor point of this icon.