com.luciad.tea

Terrain Analysis EngineClass TLcdTerrainProfileController

java.lang.Object

com.luciad.view.gxy.controller.ALcdGXYController

com.luciad.view.gxy.controller.ALcdGXYSmartController

com.luciad.tea.TLcdTerrainProfileController

All Implemented Interfaces:

ILcdUndoableSource, ILcdStatusSource, ILcdGXYController, KeyListener, MouseListener, MouseMotionListener, PropertyChangeListener, Serializable, EventListener

public class TLcdTerrainProfileController
extends ALcdGXYSmartController
implements MouseListener, MouseMotionListener, PropertyChangeListener

A ILcdGXYController implementation that contains information on the altitude of terrain beneath the position of the mouse over the view. The controller allows to draw a line segment on the map of which a side-view or profile can be calculated. This profile can then be displayed by an ILcdProfileView.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdTerrainProfileController()

Method Summary

Modifier and Type	Method and Description
void	cleanGhost(ILcdGXYView aGXYView) Remove the ghost line segment of the controller from the view.
protected String	formatAltitude(double aAltitude) Returns a string representation of the given altitude value.
Color	getBackground() Gets the color of the label frames filling.
Font	getFont() Gets the Font for drawing the labels.
Color	getForeground() Gets the color for drawing the labels.
Color	getGhostColor() Gets the property that holds the color of the lines and circles that are drawn.
int	getGhostLineWidth() GhostLineWidth is the property that holds the width of the lines and circle that are drawn.
TLcdGXYViewBasedTerrainElevationProvider	getGXYViewBasedTerrainElevationProvider() Returns the provider that is used to retrieve elevation data for this profile controller.
ILcdProfileView	getProfileView() Gets the ILcdProfileView the terrain profile is shown on
double	getScanResolution() Gets scan resolution in meters.
Color	getTextColor() Gets the color of the text.
ILcdFormatter	getValueFormat() Gets the formatter used to format elevation values.
boolean	isFallBackOnNonVisibleLayers() Returns the flag indicating if invisible layers should be scanned.
boolean	isOutOfRasterBoundsValueLabeled() Returns whether points corresponding to invalid elevation values should be labeled or not.
boolean	isUnknownElevationLabeled() Returns whether points corresponding to invalid elevation values should be labeled or not.
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e) Will perform a pan depending on the values of isDragging, isPanOnMouseDragExit and isPanOnMouseMoveExit properties
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	paint(Graphics aGraphics) Enables the controller to give visual feedback on the current user interactions.
void	propertyChange(PropertyChangeEvent e)
void	resetProfile() Clear the profile.
void	setBackground(Color aBackground) Sets the color of the label frames filling to aBackground.
void	setFallBackOnNonVisibleLayers(boolean aFallBackOnNonVisibleLayers) By default only visible layers will be scanned for terrain information.
void	setFont(Font newFont) Sets the Font for drawing the labels to newFont.
void	setForeground(Color newForeground) Sets the color for drawing the labels to newForeground.
void	setGhostColor(Color aGhostColor) Sets the property that holds the color of the lines and circles that are drawn.
void	setGhostLineWidth(int aGhostLineWidth) GhostLineWidth is the property that holds the width of the lines and circle that are drawn.
void	setGXYViewBasedTerrainElevationProvider(TLcdGXYViewBasedTerrainElevationProvider aViewElevationProvider) Sets a new elevation provider to retrieve elevation data for this profile controller.
void	setOutOfRasterBoundsValueLabeled(boolean aOutOfRasterBoundsValueLabeled) Sets the flag indicating whether points corresponding to unknown elevation values should be labeled or not.
void	setProfileView(ILcdProfileView aProfileView) Sets the ILcdProfileView to show the terrain profile on
void	setScanResolution(double aScanResolution) Sets scan resolution in meters.
void	setTextColor(Color aTextColor) Sets the color of the text to aTextColor.
void	setUnknownElevationLabeled(boolean aUnknownElevationLabeled) Sets the flag indicating whether points corresponding to unknown elevation values should be labeled or not.
void	setValueFormat(ILcdFormatter aValueFormat) Sets the formatter used to format elevation values.
protected boolean	shouldDisplayLabel(double aElevationValue) Checks whether the elevation is an unknown value as returned by the terrain elevation provider.
void	startInteraction(ILcdGXYView aGXYView) Sets up the controller to receive input through the view passed.
void	terminateInteraction(ILcdGXYView aGXYView) Releases a few items.

Methods inherited from class com.luciad.view.gxy.controller.ALcdGXYSmartController

addUndoableListener, doPanGXYView, doZoomGXYView, fireUndoableEvent, getDownPanChars, getDownPanCodes, getLeftPanChars, getLeftPanCodes, getPanAbsDelta, getPanAbsDelta, getRightPanChars, getRightPanCodes, getUndoableListenerCount, getUpPanChars, getUpPanCodes, getZoomInChars, getZoomInCodes, getZoomOutChars, getZoomOutCodes, isDragging, isPanOnMouseDragExit, isPanOnMouseMoveExit, isPanUndoable, isRequestFocusOnMouseEntered, isRequestFocusOnMousePressed, isTraceOn, isZoomUndoable, keyPressed, keyReleased, keyTyped, removeUndoableListener, setDownPanChars, setDownPanCodes, setIsDragging, setLeftPanChars, setLeftPanCodes, setPanAbsDelta, setPanOnMouseDragExit, setPanOnMouseMoveExit, setPanUndoable, setRequestFocusOnMouseEntered, setRequestFocusOnMousePressed, setRightPanChars, setRightPanCodes, setTraceOn, setUpPanChars, setUpPanCodes, setZoomInChars, setZoomInCodes, setZoomOutChars, setZoomOutCodes, setZoomUndoable, updateViewLocationAfterZoomSFCT

Methods inherited from class com.luciad.view.gxy.controller.ALcdGXYController

addStatusListener, asGXYController, fireStatusEvent, getCursor, getGXYView, getIcon, getName, getShortDescription, registerInstance, removeStatusListener, retrieveGXYViewXYWorldTransformation, setClassTraceOn, setCursor, setGXYView, setIcon, setName, setShortDescription, viewRepaint

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.view.gxy.ILcdGXYController

getLayered

Constructor Detail

TLcdTerrainProfileController

public TLcdTerrainProfileController()

Method Detail

getGXYViewBasedTerrainElevationProvider

public TLcdGXYViewBasedTerrainElevationProvider getGXYViewBasedTerrainElevationProvider()

Returns the provider that is used to retrieve elevation data for this profile controller.

Returns:

the provider that is used to retrieve elevation data for this profile controller.

See Also:

setGXYViewBasedTerrainElevationProvider(com.luciad.tea.TLcdGXYViewBasedTerrainElevationProvider)

setGXYViewBasedTerrainElevationProvider

public void setGXYViewBasedTerrainElevationProvider(TLcdGXYViewBasedTerrainElevationProvider aViewElevationProvider)

Sets a new elevation provider to retrieve elevation data for this profile controller.

Parameters:

aViewElevationProvider - the elevation provider to be used.

See Also:

setGXYViewBasedTerrainElevationProvider(com.luciad.tea.TLcdGXYViewBasedTerrainElevationProvider)

resetProfile

public void resetProfile()

Clear the profile.

startInteraction

public void startInteraction(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYController

Sets up the controller to receive input through the view passed.

All ILcdGXYView implementations that support interaction call this method when the controller has been made active with setGXYController on the view, so this method shouldn't normally be called directly. Note that most view implementations add the controller as listener if appropriate before calling this method.

Sets the cursor on the view and sets the view for which this controller is now active. Sends out a status event based on the short description.

Specified by:

startInteraction in interface ILcdGXYController

Overrides:

startInteraction in class ALcdGXYSmartController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController will interact with.

See Also:

ILcdGXYView.setGXYController(com.luciad.view.gxy.ILcdGXYController), ILcdGXYController.terminateInteraction(com.luciad.view.gxy.ILcdGXYView)

terminateInteraction

public void terminateInteraction(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYController

Releases a few items. Can be redefined but this 'super' method should be called too.

Specified by:

terminateInteraction in interface ILcdGXYController

Overrides:

terminateInteraction in class ALcdGXYSmartController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController interacted with.

See Also:

ILcdGXYView.setGXYController(com.luciad.view.gxy.ILcdGXYController), ILcdGXYController.startInteraction(com.luciad.view.gxy.ILcdGXYView)

cleanGhost

public void cleanGhost(ILcdGXYView aGXYView)

Remove the ghost line segment of the controller from the view.

Parameters:

aGXYView - The view from which to remove the line.

paint

public void paint(Graphics aGraphics)

Description copied from class: ALcdGXYController

Enables the controller to give visual feedback on the current user interactions. Note that the controller is responsible for repainting the view.

Empty implementation. Redefine this method to render on the Graphics on which the view is rendered.

Specified by:

paint in interface ILcdGXYController

Overrides:

paint in class ALcdGXYController

Parameters:

aGraphics - the Graphics on which the view was rendered.

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class ALcdGXYSmartController

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class ALcdGXYSmartController

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class ALcdGXYSmartController

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

Overrides:

mouseEntered in class ALcdGXYSmartController

mouseExited

public void mouseExited(MouseEvent e)

Description copied from class: ALcdGXYSmartController

Will perform a pan depending on the values of isDragging, isPanOnMouseDragExit and isPanOnMouseMoveExit properties

Specified by:

mouseExited in interface MouseListener

Overrides:

mouseExited in class ALcdGXYSmartController

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class ALcdGXYSmartController

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class ALcdGXYSmartController

setProfileView

public void setProfileView(ILcdProfileView aProfileView)

Sets the ILcdProfileView to show the terrain profile on

Parameters:

aProfileView - The ILcdProfileView to be set

See Also:

getProfileView()

getProfileView

public ILcdProfileView getProfileView()

Gets the ILcdProfileView the terrain profile is shown on

Returns:

the ILcdProfileView the terrain profile is shown on.

See Also:

setProfileView(com.luciad.tea.ILcdProfileView)

setGhostColor

public void setGhostColor(Color aGhostColor)

Sets the property that holds the color of the lines and circles that are drawn.

Parameters:

aGhostColor - the color to use for the drawing of lines and circles.

See Also:

getGhostColor()

getGhostColor

public Color getGhostColor()

Gets the property that holds the color of the lines and circles that are drawn.

Returns:

the color to use for the drawing of lines and circles.

See Also:

setGhostColor(java.awt.Color)

setGhostLineWidth

public void setGhostLineWidth(int aGhostLineWidth)

GhostLineWidth is the property that holds the width of the lines and circle that are drawn. This property has an effect only for JVM versions higher than 1.2. For lower versions, the line width will be always 1.

Parameters:

aGhostLineWidth - the line width to set.

See Also:

getGhostLineWidth()

getGhostLineWidth

public int getGhostLineWidth()

GhostLineWidth is the property that holds the width of the lines and circle that are drawn. This property has an effect only for JVM versions upper that 1.2 For lower versions, the line width will be always 1.

Returns:

the current line width.

See Also:

setGhostLineWidth(int)

setFont

public void setFont(Font newFont)

Sets the Font for drawing the labels to newFont.

Parameters:

newFont - the new font for drawing the labels.

See Also:

getFont()

getFont

public Font getFont()

Gets the Font for drawing the labels.

Returns:

the font used for drawing the labels.

See Also:

setFont(java.awt.Font)

setFallBackOnNonVisibleLayers

public void setFallBackOnNonVisibleLayers(boolean aFallBackOnNonVisibleLayers)

By default only visible layers will be scanned for terrain information. When set to true, also layers that are not visible will be scanned.

Parameters:

aFallBackOnNonVisibleLayers - the flag indicating if invisible layers should be scanned.

See Also:

isFallBackOnNonVisibleLayers()

isFallBackOnNonVisibleLayers

public boolean isFallBackOnNonVisibleLayers()

Returns the flag indicating if invisible layers should be scanned. Default is false.

Returns:

the flag indicating if invisible layers should be scanned.

See Also:

setFallBackOnNonVisibleLayers(boolean)

setForeground

public void setForeground(Color newForeground)

Sets the color for drawing the labels to newForeground.

Parameters:

newForeground - the new color for drawing the labels.

See Also:

getForeground()

getForeground

public Color getForeground()

Gets the color for drawing the labels.

Returns:

the color for drawing the labels.

See Also:

setForeground(java.awt.Color)

setBackground

public void setBackground(Color aBackground)

Sets the color of the label frames filling to aBackground.

Parameters:

aBackground - the new color of the label frames filling.

See Also:

getBackground()

getBackground

public Color getBackground()

Gets the color of the label frames filling.

Returns:

the color of the label frames filling.

See Also:

setBackground(java.awt.Color)

setTextColor

public void setTextColor(Color aTextColor)

Sets the color of the text to aTextColor.

Parameters:

aTextColor - the new color of the text.

See Also:

getTextColor()

getTextColor

public Color getTextColor()

Gets the color of the text.

Returns:

the color of the text.

See Also:

setTextColor(java.awt.Color)

setValueFormat

public void setValueFormat(ILcdFormatter aValueFormat)

Sets the formatter used to format elevation values.

Parameters:

aValueFormat - the formatter used to format elevation values.

See Also:

getValueFormat()

getValueFormat

public ILcdFormatter getValueFormat()

Gets the formatter used to format elevation values.

Returns:

the formatter used to format elevation values.

See Also:

setValueFormat(com.luciad.util.ILcdFormatter)

setScanResolution

public void setScanResolution(double aScanResolution)

Sets scan resolution in meters.

Parameters:

aScanResolution - the new scan resolution in meters.

See Also:

getScanResolution()

getScanResolution

public double getScanResolution()

Gets scan resolution in meters.

Returns:

the scan resolution in meters.

See Also:

setScanResolution(double)

setUnknownElevationLabeled

public void setUnknownElevationLabeled(boolean aUnknownElevationLabeled)

Sets the flag indicating whether points corresponding to unknown elevation values should be labeled or not. The default is false.

Parameters:

aUnknownElevationLabeled - the new flag indicating if invalid elevation points are labeled.

See Also:

isUnknownElevationLabeled()

isUnknownElevationLabeled

public boolean isUnknownElevationLabeled()

Returns whether points corresponding to invalid elevation values should be labeled or not.

Returns:

whether invalid elevation points are labeled or not.

See Also:

setUnknownElevationLabeled(boolean)

setOutOfRasterBoundsValueLabeled

public void setOutOfRasterBoundsValueLabeled(boolean aOutOfRasterBoundsValueLabeled)

Sets the flag indicating whether points corresponding to unknown elevation values should be labeled or not. The default is false.

Parameters:

aOutOfRasterBoundsValueLabeled - the new flag indicating if invalid elevation points are labeled.

See Also:

isOutOfRasterBoundsValueLabeled()

isOutOfRasterBoundsValueLabeled

public boolean isOutOfRasterBoundsValueLabeled()

Returns whether points corresponding to invalid elevation values should be labeled or not.

Returns:

whether invalid elevation points are labeled or not.

See Also:

setOutOfRasterBoundsValueLabeled(boolean)

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

formatAltitude

protected String formatAltitude(double aAltitude)

Returns a string representation of the given altitude value. This implementation checks whether a value format is set. If so, this format is used to format the altitude, otherwise the default Double.toString method is used.

Parameters:

aAltitude - the altitude value to format.

Returns:

a string representation of the given altitude value.

See Also:

setValueFormat(ILcdFormatter)

shouldDisplayLabel

protected boolean shouldDisplayLabel(double aElevationValue)

Checks whether the elevation is an unknown value as returned by the terrain elevation provider. If so, a label is displayed depending on the values of the properties OutOfRasterBoundsLabeled and UnknownElevationLabeled.

Parameters:

aElevationValue - the value to display a label for, or not.

Returns:

true for known values and, depending on the properties OutOfRasterBoundsLabeled and UnknownElevationLabeled, for the corresponding unknown values, otherwise false.

See Also:

setOutOfRasterBoundsValueLabeled(boolean), setUnknownElevationLabeled(boolean)