com.luciad.earth.view.gxy.util

LuciadFusionClass TLcdEarthSparseIcon

java.lang.Object

com.luciad.earth.view.gxy.util.ALcdEarthParameterizedIcon

com.luciad.earth.view.gxy.util.ALcdEarth2DVectorIcon

com.luciad.earth.view.gxy.util.TLcdEarthSparseIcon

All Implemented Interfaces:

ILcdParameterizedIcon, ILcdOriented

public class TLcdEarthSparseIcon
extends ALcdEarth2DVectorIcon
implements ILcdOriented

An icon that paints another icon with a density that is based on the strength of a vector. When the strength is high in a region, many icons are drawn. When the strength is low, only a few icons are drawn.

The density policy is implemented by sparsely painting the icon (e.g. the icon is sometimes not painted, depending on the strength).

Since:

10.1

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.earth.view.gxy.util.ALcdEarth2DVectorIcon

ALcdEarth2DVectorIcon.Parameterization

Constructor Summary

Constructors

Constructor and Description
TLcdEarthSparseIcon(ILcdParameterizedIcon aDelegate, ALcdEarth2DVectorIcon.Parameterization aType, int aDeltaX, int aDeltaY, double aMinimumStrength, double aMaximumStrength) Constructs a new sparse icon.

Method Summary

Modifier and Type	Method and Description
void	anchorPointSFCT(double[] aParameters, Point aPointSFCT) Returns the anchor point of this icon.
int	getDeltaX() Returns the horizontal grid spacing at which this icon is painted.
int	getDeltaY() Returns the vertical grid spacing at which this icon is painted.
int	getHeight(double[] aParameters) Returns the height of the icon for the given parameter values.
double	getMaximumStrength() Returns the expected maximum strength.
double	getMinimumStrength() Returns the minimum strength.
double	getOrientation() Returns the orientation of this object in degrees.
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
void	setDeltaX(int aDeltaX) Sets the horizontal grid spacing at which this icon is painted.
void	setDeltaY(int aDeltaY) Sets the vertical grid spacing at which this icon is painted.
void	setMaximumStrength(double aMaximumStrength) Sets the expected maximum strength.
void	setMinimumStrength(double aMinimumStrength) Sets the minimum strength.

Methods inherited from class com.luciad.earth.view.gxy.util.ALcdEarth2DVectorIcon

getAngle, getParameterization, getStrength, setParameterization

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdEarthSparseIcon

public TLcdEarthSparseIcon(ILcdParameterizedIcon aDelegate,
                           ALcdEarth2DVectorIcon.Parameterization aType,
                           int aDeltaX,
                           int aDeltaY,
                           double aMinimumStrength,
                           double aMaximumStrength)

Constructs a new sparse icon.

Parameters:

aDelegate - the icon to paint sparsely

aType - the parameterization type

aDeltaX - the horizontal grid spacing at which this icon is painted

aDeltaY - the vertical grid spacing at which this icon is painted

aMinimumStrength - the minimum strength

aMaximumStrength - the expected maximum strength

Method Detail

getDeltaX

public int getDeltaX()

Returns the horizontal grid spacing at which this icon is painted.

Returns:

the horizontal grid spacing at which this icon is painted

See Also:

TLcdEarthGXYMultivaluedRasterPainter.getDeltaX()

setDeltaX

public void setDeltaX(int aDeltaX)

Sets the horizontal grid spacing at which this icon is painted.

Parameters:

aDeltaX - the horizontal grid spacing at which this icon is painted

See Also:

getDeltaX()

getDeltaY

public int getDeltaY()

Returns the vertical grid spacing at which this icon is painted.

Returns:

the vertical grid spacing at which this icon is painted

See Also:

TLcdEarthGXYMultivaluedRasterPainter.getDeltaY()

setDeltaY

public void setDeltaY(int aDeltaY)

Sets the vertical grid spacing at which this icon is painted.

Parameters:

aDeltaY - the vertical grid spacing at which this icon is painted

See Also:

getDeltaY()

getMinimumStrength

public double getMinimumStrength()

Returns the minimum strength.

Icons with a strength equal to or lower than the minimum strength are never painted.

Returns:

the minimum strength

setMinimumStrength

public void setMinimumStrength(double aMinimumStrength)

Sets the minimum strength.

Parameters:

aMinimumStrength - the minimum strength

See Also:

getMinimumStrength()

getMaximumStrength

public double getMaximumStrength()

Returns the expected maximum strength.

Icons with a strength larger than the maximum strength are always painted.

Returns:

the expected maximum strength

setMaximumStrength

public void setMaximumStrength(double aMaximumStrength)

Sets the expected maximum strength.

Parameters:

aMaximumStrength - the expected maximum strength

See Also:

getMaximumStrength()

getWidth

public int getWidth(double[] aParameters)

Description copied from interface: ILcdParameterizedIcon

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

Specified by:

getWidth in interface ILcdParameterizedIcon

Parameters:

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

Returns:

the width

getHeight

public int getHeight(double[] aParameters)

Description copied from interface: ILcdParameterizedIcon

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

Specified by:

getHeight in interface ILcdParameterizedIcon

Parameters:

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

Returns:

the height

paintIcon

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

Description copied from interface: ILcdParameterizedIcon

Paint the icon at the specified location for the parameters

Specified by:

paintIcon in interface ILcdParameterizedIcon

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

anchorPointSFCT

public void anchorPointSFCT(double[] aParameters,
                            Point aPointSFCT)

Description copied from class: ALcdEarthParameterizedIcon

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);
 

This method implementation provides a default anchor point: (width/2, height/2). Override this method to provide an other anchor point.

Specified by:

anchorPointSFCT in interface ILcdParameterizedIcon

Overrides:

anchorPointSFCT in class ALcdEarthParameterizedIcon

Parameters:

aParameters - the parameter values

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

getOrientation

public double getOrientation()

Description copied from interface: ILcdOriented

Returns the orientation of this object in degrees. The orientation should be interpreted as a clockwise angle in degrees starting from 12 o'clock.

If there is no rotation known for this object, return Double.NaN.

Specified by:

getOrientation in interface ILcdOriented

Returns:

the orientation of this object in degrees, or NaN if undefined.