com.luciad.format.magneticnorth.gxy

LuciadLightspeedClass TLcdMagneticNorthGXYController

java.lang.Object

com.luciad.view.gxy.controller.ALcdGXYController

com.luciad.view.gxy.controller.ALcdGXYSmartController

com.luciad.format.magneticnorth.gxy.TLcdMagneticNorthGXYController

All Implemented Interfaces:

ILcdUndoableSource, ILcdAWTEventListener, ILcdStatusSource, ILcdGXYChainableController, ILcdGXYController, KeyListener, MouseListener, MouseMotionListener, Serializable, EventListener

public class TLcdMagneticNorthGXYController
extends ALcdGXYSmartController
implements ILcdGXYChainableController

When active on a ILcdGXYView, this ILcdController will catch each mouseClicked and try to modify the properties of the ILcdProjection currently on the ILcdGXYView accordingly.

More specifically it re-centers the projection at the touched point and it will rotate the map such that the direction to the magnetic north (what a compass would indicate) is equal to the (vertical) direction to the top of your screen.

This controller will also display a tool tip showing the declination at the point under the mouse cursor, see formatToolTip..

Note that the user of this class is responsible for giving this object a correctly initialized magnetic north map.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdMagneticNorthGXYController() Default constructor, you will have to set a magnetic north map before the object is usable.
TLcdMagneticNorthGXYController(Cursor aCursor) Constructs a new controller with the given cursor.
TLcdMagneticNorthGXYController(Cursor aCursor, ILcdMagneticNorthMap aMagneticNorthMap) Creates a new TLcdMagneticNorthGXYController with the given cursor and the given ILcdMagneticNorthMap.
TLcdMagneticNorthGXYController(ILcdMagneticNorthMap aMagneticNorthMap) Creates a new TLcdMagneticNorthGXYController with the given ILcdMagneticNorthMap.

Method Summary

Modifier and Type	Method and Description
void	appendGXYController(ILcdGXYChainableController aEnd) This method will append the passed controller to the end of the chain.
protected String[]	formatToolTip(double aValue) Formats the tool tip for the given declination value.
ILcdAction	getActionToTrigger() Returns the action that will be triggered after each recenter and rotation of the gxy.
float	getHeightAboveSeaLevel() Gets the height the cursor is assumed to be above the surface of the earth.
Color	getLabelBackgroundColor() Returns the label background color.
Font	getLabelFont() Returns the font for used by the label displaying the declination.
Color	getLabelFontColor() Returns the color of the font of the label displaying the declination.
ILcdMagneticNorthMap	getMagneticNorthMap() Returns the magnetic north map this controller is using.
ILcdGXYChainableController	getNextGXYController() Returns a reference to the controller that is located after this one in a chain, or null if this controller is the last element of the chain.
void	handleAWTEvent(AWTEvent aEvent) This is method is called when the target of the listener has a new AWTEvent available.
boolean	isDisplayLabel() Returns true if the label should be displayed, false otherwise.
boolean	isRotateNorthToTopOnClick() Returns true if the map will be rotated such that the magnetic north is at the top of the map on a mouse click.
void	mouseClicked(MouseEvent aMouseEvent) Invoked when a mouse button has been clicked on the ILcdGXYView component.
void	mouseDragged(MouseEvent aMouseEvent)
void	mouseEntered(MouseEvent me) Invoked when the mouse enters the ILcdGXYView component.
void	mouseExited(MouseEvent me) Invoked when the mouse exits the ILcdGXYView component.
void	mouseMoved(MouseEvent aMouseEvent)
void	mousePressed(MouseEvent me) Invoked when a mouse button has been pressed on the ILcdGXYView component.
void	mouseReleased(MouseEvent aMouseEvent)
void	paint(Graphics aGraphics) Enables the controller to give visual feedback on the current user interactions.
void	restore() Restores the map rotation to normal.
protected double	retrieveDeclination(MouseEvent aMouseEvent) Returns the declination for the point associated with the current mouse position.
void	setActionToTrigger(ILcdAction aActionToTrigger) Sets an ILcdAction to trigger just after having recentered and rotated the ILcdGXYView.
void	setDisplayLabel(boolean aDisplayLabel) Sets whether this controller should display a label containing the declination at the point under the mouse cursor.
void	setHeightAboveSeaLevel(float aHeightAboveSeaLevel) Sets the height above the surface of the earth to perform the calculations for.
void	setLabelBackgroundColor(Color aLabelBackgroundColor) Sets a new background color for the label.
void	setLabelFont(Font aLabelFont) Sets a new font for the label displaying the declination.
void	setLabelFontColor(Color aLabelFontColor) Sets the font color of the label.
void	setMagneticNorthMap(ILcdMagneticNorthMap aMagneticNorthMap) Sets the magnetic north map this controller will use.
void	setNextGXYController(ILcdGXYChainableController aNext) This method sets the next controller in the chain for this controller.
void	setRotateNorthToTopOnClick(boolean aRotateNorthToTopOnClick) Sets whether this controller should rotate the map such that the magnetic north is at the top of the map.
void	startInteraction(ILcdGXYView aView) 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

getCursor, getIcon, getLayered, getName, getShortDescription, viewRepaint

Constructor Detail

TLcdMagneticNorthGXYController

public TLcdMagneticNorthGXYController()

Default constructor, you will have to set a magnetic north map before the object is usable.

TLcdMagneticNorthGXYController

public TLcdMagneticNorthGXYController(Cursor aCursor)

Constructs a new controller with the given cursor. You will have to set a magnetic north map before the object is usable.

Parameters:

aCursor - The cursor for this controller

TLcdMagneticNorthGXYController

public TLcdMagneticNorthGXYController(ILcdMagneticNorthMap aMagneticNorthMap)

Creates a new TLcdMagneticNorthGXYController with the given ILcdMagneticNorthMap. The object is ready to use.

Parameters:

aMagneticNorthMap - The magnetic north map the controller will use.

TLcdMagneticNorthGXYController

public TLcdMagneticNorthGXYController(Cursor aCursor,
                                      ILcdMagneticNorthMap aMagneticNorthMap)

Creates a new TLcdMagneticNorthGXYController with the given cursor and the given ILcdMagneticNorthMap.

Parameters:

aCursor - The cursor for this controller

aMagneticNorthMap - The magnetic north map this controller will use.

Method Detail

setActionToTrigger

public void setActionToTrigger(ILcdAction aActionToTrigger)

Sets an ILcdAction to trigger just after having recentered and rotated the ILcdGXYView. This can be used to set another ILcdGXController after each recenter.

Parameters:

aActionToTrigger - The action that will be triggered after each recenter and rotation of the gxy.

See Also:

getActionToTrigger()

getActionToTrigger

public ILcdAction getActionToTrigger()

Returns the action that will be triggered after each recenter and rotation of the gxy.

Returns:

the action that will be triggered after each recenter and rotation of the gxy.

See Also:

setActionToTrigger(com.luciad.gui.ILcdAction)

getMagneticNorthMap

public ILcdMagneticNorthMap getMagneticNorthMap()

Returns the magnetic north map this controller is using.

Returns:

the magnetic north map this controller is using.

See Also:

setMagneticNorthMap(com.luciad.format.magneticnorth.ILcdMagneticNorthMap)

setMagneticNorthMap

public void setMagneticNorthMap(ILcdMagneticNorthMap aMagneticNorthMap)

Sets the magnetic north map this controller will use.

Parameters:

aMagneticNorthMap - The magnetic north map this controller will use

See Also:

getMagneticNorthMap()

getLabelFontColor

public Color getLabelFontColor()

Returns the color of the font of the label displaying the declination.

Returns:

the color of the font of the label displaying the declination.

See Also:

setLabelFontColor(java.awt.Color)

setLabelFontColor

public void setLabelFontColor(Color aLabelFontColor)

Sets the font color of the label.

Parameters:

aLabelFontColor - The color for the font of the label.

See Also:

getLabelFontColor()

getLabelBackgroundColor

public Color getLabelBackgroundColor()

Returns the label background color.

Returns:

the label background color.

See Also:

setLabelBackgroundColor(java.awt.Color)

setLabelBackgroundColor

public void setLabelBackgroundColor(Color aLabelBackgroundColor)

Sets a new background color for the label.

Parameters:

aLabelBackgroundColor - The background color for the label.

See Also:

getLabelBackgroundColor()

getLabelFont

public Font getLabelFont()

Returns the font for used by the label displaying the declination.

Returns:

the font for used by the label displaying the declination.

See Also:

setLabelFont(java.awt.Font)

setLabelFont

public void setLabelFont(Font aLabelFont)

Sets a new font for the label displaying the declination.

Parameters:

aLabelFont - The new font.

See Also:

getLabelFont()

isDisplayLabel

public boolean isDisplayLabel()

Returns true if the label should be displayed, false otherwise.

Returns:

true if the label should be displayed, false otherwise.

See Also:

setDisplayLabel(boolean)

setDisplayLabel

public void setDisplayLabel(boolean aDisplayLabel)

Sets whether this controller should display a label containing the declination at the point under the mouse cursor.

Parameters:

aDisplayLabel - True if the label has to be displayed, false otherwise.

See Also:

isDisplayLabel()

isRotateNorthToTopOnClick

public boolean isRotateNorthToTopOnClick()

Returns true if the map will be rotated such that the magnetic north is at the top of the map on a mouse click.

Returns:

True if the map will be rotated on mouse click, false otherwise.

See Also:

setRotateNorthToTopOnClick(boolean)

setRotateNorthToTopOnClick

public void setRotateNorthToTopOnClick(boolean aRotateNorthToTopOnClick)

Sets whether this controller should rotate the map such that the magnetic north is at the top of the map.

Parameters:

aRotateNorthToTopOnClick - True if the map should be rotated on mouse click, false otherwise.

See Also:

isRotateNorthToTopOnClick()

getHeightAboveSeaLevel

public float getHeightAboveSeaLevel()

Gets the height the cursor is assumed to be above the surface of the earth.

Returns:

The height the cursor is assumed to be above the surface of the earth. Unit is km.

See Also:

setHeightAboveSeaLevel(float)

setHeightAboveSeaLevel

public void setHeightAboveSeaLevel(float aHeightAboveSeaLevel)

Sets the height above the surface of the earth to perform the calculations for.

Parameters:

aHeightAboveSeaLevel - The height the cursor is above the surface of the earth. Unit is km.

See Also:

getHeightAboveSeaLevel()

startInteraction

public void startInteraction(ILcdGXYView aView)

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:

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

retrieveDeclination

protected double retrieveDeclination(MouseEvent aMouseEvent)

Returns the declination for the point associated with the current mouse position.

Parameters:

aMouseEvent - the mouse event that contains the current mouse position.

Returns:

the declination for the point associated with the current mouse position.

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.

formatToolTip

protected String[] formatToolTip(double aValue)

Formats the tool tip for the given declination value.

Parameters:

aValue - The declination value, as an angle in degrees.

Returns:

The formatted array of strings. Every string is painted on a new line.

mouseReleased

public void mouseReleased(MouseEvent aMouseEvent)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class ALcdGXYSmartController

mouseDragged

public void mouseDragged(MouseEvent aMouseEvent)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class ALcdGXYSmartController

mouseMoved

public void mouseMoved(MouseEvent aMouseEvent)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class ALcdGXYSmartController

restore

public void restore()

Restores the map rotation to normal.

mouseClicked

public void mouseClicked(MouseEvent aMouseEvent)

Invoked when a mouse button has been clicked on the ILcdGXYView component.

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class ALcdGXYSmartController

mousePressed

public void mousePressed(MouseEvent me)

Invoked when a mouse button has been pressed on the ILcdGXYView component.

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class ALcdGXYSmartController

mouseEntered

public void mouseEntered(MouseEvent me)

Invoked when the mouse enters the ILcdGXYView component.

Specified by:

mouseEntered in interface MouseListener

Overrides:

mouseEntered in class ALcdGXYSmartController

mouseExited

public void mouseExited(MouseEvent me)

Invoked when the mouse exits the ILcdGXYView component.

Specified by:

mouseExited in interface MouseListener

Overrides:

mouseExited in class ALcdGXYSmartController

getNextGXYController

public ILcdGXYChainableController getNextGXYController()

Description copied from interface: ILcdGXYChainableController

Returns a reference to the controller that is located after this one in a chain, or null if this controller is the last element of the chain.

Specified by:

getNextGXYController in interface ILcdGXYChainableController

Returns:

a reference to the next controller.

See Also:

ILcdGXYChainableController.setNextGXYController(ILcdGXYChainableController)

setNextGXYController

public void setNextGXYController(ILcdGXYChainableController aNext)

Description copied from interface: ILcdGXYChainableController

This method sets the next controller in the chain for this controller. You can set null if you want the chain to end. This method does not start or terminate any interaction. If you need to replace a controller while it's being used you are responsible for properly terminating and starting it yourself.

Specified by:

setNextGXYController in interface ILcdGXYChainableController

Parameters:

aNext - the reference to the controller that will be the next element in the chain

See Also:

ILcdGXYChainableController.getNextGXYController()

appendGXYController

public void appendGXYController(ILcdGXYChainableController aEnd)

Description copied from interface: ILcdGXYChainableController

This method will append the passed controller to the end of the chain. The controller will be the stored as the next controller in the last element of the current chain.

Specified by:

appendGXYController in interface ILcdGXYChainableController

Parameters:

aEnd - the controller to be appended to the end of the chain.

handleAWTEvent

public void handleAWTEvent(AWTEvent aEvent)

Description copied from interface: ILcdAWTEventListener

This is method is called when the target of the listener has a new AWTEvent available.

Specified by:

handleAWTEvent in interface ILcdAWTEventListener

Parameters:

aEvent - The event to be handled.