com.luciad.view.gxy.controller.touch

LuciadLightspeedClass TLcdGXYTouchNavigateController

java.lang.Object

com.luciad.view.gxy.controller.ALcdGXYController

com.luciad.view.gxy.controller.ALcdGXYChainableController

com.luciad.view.gxy.controller.touch.TLcdGXYTouchNavigateController

All Implemented Interfaces:

ILcdAWTEventListener, ILcdStatusSource, ILcdGXYChainableController, ILcdGXYController, Serializable

public class TLcdGXYTouchNavigateController
extends ALcdGXYChainableController

Touch controller to navigate on a 2D map. It supports two-finger rotation, two-finger zoom and one and two-finger panning.

When interacting with one finger, the map is panned. When interacting with two fingers, the controller will rotate/zoom/pan the map in such a way to keep the fingers at the same geographical location.

You can specify whether the controller should pan, zoom, or rotate the map. A typical use case would be to let the controller zoom and pan, but not rotate.

This controller only tries to handle TLcdTouchPoints which are not-consumed, and marks the TLcdTouchPoints it uses as consumed, similar to the ALcdGXYTouchChainableController.

Since:

10.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdGXYTouchNavigateController() Creates a new navigation controller with a default TLcdGXYNavigateControllerModel.
TLcdGXYTouchNavigateController(TLcdGXYNavigateControllerModel aControllerModel) Creates a new navigation controller based on aControllerModel.
TLcdGXYTouchNavigateController(TLcdGXYNavigateControllerModel aControllerModel, boolean aShouldRotate, boolean aShouldScale, boolean aShouldTranslate) Creates a new navigation controller based on aControllerModel.

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.
int	getMoveThreshold() Returns the threshold for move events.
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.
void	paint(Graphics aGraphics) Enables the controller to give visual feedback on the current user interactions.
protected void	paintImpl(Graphics aGraphics) The specific implementation of paint for this controller.
protected void	setGXYView(ILcdGXYView aGXYView) Sets the ILcdGXYView the controller is interacting with.
void	setMoveThreshold(int aMoveThreshold) Sets the threshold for move events.
void	setNextGXYController(ILcdGXYChainableController aNext) This method sets the next controller in the chain for this controller.
void	startInteraction(ILcdGXYView aGXYView) Sets up the controller to receive input through the view passed.
protected void	startInteractionImpl(ILcdGXYView aGXYView) The specific implementation of startInteraction for this controller.
void	terminateInteraction(ILcdGXYView aGXYView) Releases a few items.
protected void	terminateInteractionImpl(ILcdGXYView aGXYView) The specific implementation of terminateInteraction for this controller.

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

addStatusListener, removeStatusListener

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

asGXYController, fireStatusEvent, getCursor, getGXYView, getIcon, getName, getShortDescription, isTraceOn, registerInstance, retrieveGXYViewXYWorldTransformation, setClassTraceOn, setCursor, setIcon, setName, setShortDescription, setTraceOn, 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

TLcdGXYTouchNavigateController

public TLcdGXYTouchNavigateController()

Creates a new navigation controller with a default TLcdGXYNavigateControllerModel.

TLcdGXYTouchNavigateController

public TLcdGXYTouchNavigateController(TLcdGXYNavigateControllerModel aControllerModel)

Creates a new navigation controller based on aControllerModel.

Parameters:

aControllerModel - the model which will do the actual transformation of the view

TLcdGXYTouchNavigateController

public TLcdGXYTouchNavigateController(TLcdGXYNavigateControllerModel aControllerModel,
                                      boolean aShouldRotate,
                                      boolean aShouldScale,
                                      boolean aShouldTranslate)

Creates a new navigation controller based on aControllerModel.

Parameters:

aControllerModel - the model which will do the actual transformation of the view

aShouldRotate - boolean indicating whether a rotation should be applied (see TLcdGXYNavigateControllerModel.transform(com.luciad.view.gxy.ILcdGXYView, java.util.List, java.util.List, boolean, boolean, boolean)

aShouldScale - boolean indicating whether a scaling should be applied (see TLcdGXYNavigateControllerModel.transform(com.luciad.view.gxy.ILcdGXYView, java.util.List, java.util.List, boolean, boolean, boolean)

aShouldTranslate - boolean indicating whether a translation should be applied (see TLcdGXYNavigateControllerModel.transform(com.luciad.view.gxy.ILcdGXYView, java.util.List, java.util.List, boolean, boolean, boolean)

Method Detail

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

Overrides:

getNextGXYController in class ALcdGXYChainableController

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

Overrides:

setNextGXYController in class ALcdGXYChainableController

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

Overrides:

appendGXYController in class ALcdGXYChainableController

Parameters:

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

startInteractionImpl

protected void startInteractionImpl(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYChainableController

The specific implementation of startInteraction for this controller.

Overrides:

startInteractionImpl in class ALcdGXYChainableController

Parameters:

aGXYView - the view to start interaction with.

terminateInteractionImpl

protected void terminateInteractionImpl(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYChainableController

The specific implementation of terminateInteraction for this controller.

Overrides:

terminateInteractionImpl in class ALcdGXYChainableController

Parameters:

aGXYView - the view to terminate interaction with.

paintImpl

protected void paintImpl(Graphics aGraphics)

Description copied from class: ALcdGXYChainableController

The specific implementation of paint for this controller.

Overrides:

paintImpl in class ALcdGXYChainableController

Parameters:

aGraphics - the graphics to be used for painting.

startInteraction

public void startInteraction(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYChainableController

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.

This method also calls ALcdGXYChainableController.startInteraction(com.luciad.view.gxy.ILcdGXYView) on the next controller. Override ALcdGXYChainableController.startInteractionImpl(com.luciad.view.gxy.ILcdGXYView) if you want to add your own behavior to this controller.

Specified by:

startInteraction in interface ILcdGXYController

Overrides:

startInteraction in class ALcdGXYChainableController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController will interact with.

See Also:

ALcdGXYChainableController.startInteractionImpl(com.luciad.view.gxy.ILcdGXYView)

terminateInteraction

public void terminateInteraction(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYChainableController

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

This method also calls ALcdGXYChainableController.terminateInteraction(com.luciad.view.gxy.ILcdGXYView) on the next controller. Override ALcdGXYChainableController.terminateInteractionImpl(com.luciad.view.gxy.ILcdGXYView) if you want to add your own behavior to this controller.

Specified by:

terminateInteraction in interface ILcdGXYController

Overrides:

terminateInteraction in class ALcdGXYChainableController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController interacted with.

See Also:

ALcdGXYChainableController.terminateInteractionImpl(com.luciad.view.gxy.ILcdGXYView)

paint

public void paint(Graphics aGraphics)

Description copied from class: ALcdGXYChainableController

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.

This method also calls ALcdGXYChainableController.paint(java.awt.Graphics) on the next controller. Override ALcdGXYChainableController.paintImpl(java.awt.Graphics) if you want to add your own behavior to this controller.

Specified by:

paint in interface ILcdGXYController

Overrides:

paint in class ALcdGXYChainableController

Parameters:

aGraphics - the Graphics on which the view was rendered.

See Also:

ALcdGXYChainableController.paintImpl(java.awt.Graphics)

setGXYView

protected void setGXYView(ILcdGXYView aGXYView)

Description copied from class: ALcdGXYController

Sets the ILcdGXYView the controller is interacting with.

This method is called when ILcdGXYView.setGXYController is used to set an ILcdGXYController active on an ILcdGXYView.

Overrides:

setGXYView in class ALcdGXYController

Parameters:

aGXYView - the view the controller is interacting with

See Also:

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

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.

Parameters:

aEvent - The event to be handled.

setMoveThreshold

public void setMoveThreshold(int aMoveThreshold)

Sets the threshold for move events.

A move event will only be handled if the move exceeds the threshold in either the x or y direction.

Parameters:

aMoveThreshold - the move threshold

See Also:

getMoveThreshold()

getMoveThreshold

public int getMoveThreshold()

Returns the threshold for move events.

Returns:

the threshold for move events

See Also:

setMoveThreshold(int)