com.luciad.ais.view.gxy.painter

Aviation StandardsClass TLcdGXYProcedureTrajectoryPainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYPainter

com.luciad.ais.view.gxy.painter.TLcdGXYProcedureTrajectoryPainter

All Implemented Interfaces:

ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYEditor, ILcdGXYPainter, ILcdGXYPainterProvider, Serializable, Cloneable

public class TLcdGXYProcedureTrajectoryPainter
extends ALcdGXYPainter
implements ILcdGXYEditor

A painter for TLcdProcedureTrajectory objects. The painter supports separate paint styles for the different procedure geometry types (normal, connector, error and decoration). The normal paint style can also be overridden for missed approaches. Painting of the decorations is optional.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DECORATION_ONLY Use this mode to paint the decorations, but not the procedure.
static int	PROCEDURE_AFTER_DECORATION Use this mode to paint all the decorations first, then the procedure.
static int	PROCEDURE_AND_DECORATION Use this mode to paint both the procedure and the decorations, in whatever order they are received from the procedure geometry calculator.
static int	PROCEDURE_ONLY Use this mode to paint the procedure without decorations.

Fields inherited from class com.luciad.view.gxy.ALcdGXYPainter

defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBounds

Fields inherited from interface com.luciad.view.gxy.ILcdGXYEditor

CREATING, END_CREATION, RESHAPED, START_CREATION, TRANSLATED

Fields inherited from interface com.luciad.view.gxy.ILcdGXYPainter

BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

Constructor Summary

Constructors

Constructor and Description
TLcdGXYProcedureTrajectoryPainter()

Method Summary

Modifier and Type	Method and Description
boolean	acceptSnapTarget(Graphics aGraphics, ILcdGXYContext aContext) Returns whether the object set to the editor can be edited so that (part of) the object snaps to the object passed as snap target in the context.
void	anchorPointSFCT(Graphics aGraphics, int i, ILcdGXYContext aContext, Point aPoint) Implements ILcdGXYPainter.anchorPointSFCT.
void	boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds a2DEditableBounds) Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object in the given mode taking into account the given context.
Object	clone() Makes Object.clone() public.
boolean	edit(Graphics aGraphics, int i, ILcdGXYContext aContext) Defines how an object shall be edited by this editor, taking into account the mode and the context passed.
ILcdGXYPainterStyle	getConnectorPainterStyle() Returns the ILcdGXYPainterStyle to be used for connector procedure geometry.
int	getCreationClickCount() Returns the number user interactions required to complete the initialization of an object set to this editor.
ILcdGXYPainterStyle	getDecorationPainterStyle() Returns the ILcdGXYPainterStyle to be used for decoration procedure geometry.
ILcdGXYPainterStyle	getErrorPainterStyle() Returns the ILcdGXYPainterStyle to be used for erroneous procedure geometry.
ILcdGXYPainterStyle	getMissedApproachPainterStyle() Returns the ILcdGXYPainterStyle to be used for normal procedure geometry that comes after the missed approach point.
ILcdGXYPainterStyle	getNormalPainterStyle() Returns the ILcdGXYPainterStyle to be used for normal procedure geometry.
Object	getObject() Returns the object this editor is currently set to edit.
int	getPaintMode() Returns the current paint mode.
ILcdGXYPainterProvider	getPointPainterProvider() Returns the painter provider to be used for drawing points that are output with the procedure geometry.
boolean	isTouched(Graphics aGraphics, int aMode, ILcdGXYContext aILcdGXYContext) Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.
void	paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.
void	setConnectorPainterStyle(ILcdGXYPainterStyle aConnectorPainterStyle) Sets the ILcdGXYPainterStyle to be used for connector procedure geometry.
void	setDecorationPainterStyle(ILcdGXYPainterStyle aDecorationPainterStyle) Sets the ILcdGXYPainterStyle to be used for decoration procedure geometry.
void	setErrorPainterStyle(ILcdGXYPainterStyle aErrorPainterStyle) Sets the ILcdGXYPainterStyle to be used for erroneous procedure geometry.
void	setMissedApproachPainterStyle(ILcdGXYPainterStyle aMissedApproachPainterStyle) Sets the ILcdGXYPainterStyle to be used for normal procedure geometry that comes after the missed approach point.
void	setNormalPainterStyle(ILcdGXYPainterStyle aNormalPainterStyle) Sets the ILcdGXYPainterStyle to be used for normal procedure geometry.
void	setObject(Object o) Sets the object which may be edited by this editor.
void	setPaintMode(int aPaintMode) Sets the paint mode, which determines if the procedure and its decorations are displayed or not.
void	setPointPainterProvider(ILcdGXYPainterProvider aPointPainterProvider) Sets the painter provider to be used for drawing points that are output with the procedure geometry.

Methods inherited from class com.luciad.view.gxy.ALcdGXYPainter

addPropertyChangeListener, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, getGXYPainter, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOn, snapTarget, supportSnap

Methods inherited from class java.lang.Object

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

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

getDisplayName

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

Field Detail

PROCEDURE_ONLY

public static final int PROCEDURE_ONLY

Use this mode to paint the procedure without decorations.

See Also:

Constant Field Values

DECORATION_ONLY

public static final int DECORATION_ONLY

Use this mode to paint the decorations, but not the procedure.

See Also:

Constant Field Values

PROCEDURE_AND_DECORATION

public static final int PROCEDURE_AND_DECORATION

Use this mode to paint both the procedure and the decorations, in whatever order they are received from the procedure geometry calculator.

See Also:

Constant Field Values

PROCEDURE_AFTER_DECORATION

public static final int PROCEDURE_AFTER_DECORATION

Use this mode to paint all the decorations first, then the procedure. This ensures that the decorations do not get in the way of a clear view on the procedure.

See Also:

Constant Field Values

Constructor Detail

TLcdGXYProcedureTrajectoryPainter

public TLcdGXYProcedureTrajectoryPainter()

Method Detail

clone

public Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Specified by:

clone in interface ILcdGXYPainterProvider

Overrides:

clone in class ALcdGXYPainter

Returns:

a clone of this painter provider.

See Also:

Object.clone()

setPaintMode

public void setPaintMode(int aPaintMode)

Sets the paint mode, which determines if the procedure and its decorations are displayed or not.

Parameters:

aPaintMode - One of PROCEDURE_ONLY, DECORATION_ONLY, PROCEDURE_AND_DECORATION or PROCEDURE_AFTER_DECORATION.

getPaintMode

public int getPaintMode()

Returns the current paint mode. The default is PROCEDURE_AND_DECORATION.

setNormalPainterStyle

public void setNormalPainterStyle(ILcdGXYPainterStyle aNormalPainterStyle)

Sets the ILcdGXYPainterStyle to be used for normal procedure geometry.

getNormalPainterStyle

public ILcdGXYPainterStyle getNormalPainterStyle()

Returns the ILcdGXYPainterStyle to be used for normal procedure geometry.

setMissedApproachPainterStyle

public void setMissedApproachPainterStyle(ILcdGXYPainterStyle aMissedApproachPainterStyle)

Sets the ILcdGXYPainterStyle to be used for normal procedure geometry that comes after the missed approach point. Only applicable to IAP procedures.

getMissedApproachPainterStyle

public ILcdGXYPainterStyle getMissedApproachPainterStyle()

Returns the ILcdGXYPainterStyle to be used for normal procedure geometry that comes after the missed approach point. Only applicable to IAP procedures.

setErrorPainterStyle

public void setErrorPainterStyle(ILcdGXYPainterStyle aErrorPainterStyle)

Sets the ILcdGXYPainterStyle to be used for erroneous procedure geometry.

getErrorPainterStyle

public ILcdGXYPainterStyle getErrorPainterStyle()

Returns the ILcdGXYPainterStyle to be used for erroneous procedure geometry.

setDecorationPainterStyle

public void setDecorationPainterStyle(ILcdGXYPainterStyle aDecorationPainterStyle)

Sets the ILcdGXYPainterStyle to be used for decoration procedure geometry.

getDecorationPainterStyle

public ILcdGXYPainterStyle getDecorationPainterStyle()

Returns the ILcdGXYPainterStyle to be used for decoration procedure geometry.

setConnectorPainterStyle

public void setConnectorPainterStyle(ILcdGXYPainterStyle aConnectorPainterStyle)

Sets the ILcdGXYPainterStyle to be used for connector procedure geometry.

getConnectorPainterStyle

public ILcdGXYPainterStyle getConnectorPainterStyle()

Returns the ILcdGXYPainterStyle to be used for connector procedure geometry.

setPointPainterProvider

public void setPointPainterProvider(ILcdGXYPainterProvider aPointPainterProvider)

Sets the painter provider to be used for drawing points that are output with the procedure geometry.

getPointPainterProvider

public ILcdGXYPainterProvider getPointPainterProvider()

Returns the painter provider to be used for drawing points that are output with the procedure geometry.

isTouched

public boolean isTouched(Graphics aGraphics,
                         int aMode,
                         ILcdGXYContext aILcdGXYContext)

Description copied from interface: ILcdGXYPainter

Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.

The location that must be taken into account to check whether the representation is touched can be retrieved from the context passed with the methods ILcdGXYContext.getX() and ILcdGXYContext.getY(). If the check is part of an ongoing operation of user interaction, for example, when the mouse is being dragged, the location of the start of the operation can also be taken into account using the methods ILcdGXYContext.getDeltaX() and ILcdGXYContext.getDeltaY(). The context contains the transformations required to convert this location into the equivalent location in model space. Implementations of this interface usually follow either of the following patterns:

• transform the location of the interaction back to model space and compare the coordinates with the object in model space.
• transform the location to world space and compare with a world representation of the object. This forces the painter into caching a world representation of the object. Caching a view representation of an object is not very practical as it would have to change whenever the view's scale changes or when it is panned. A world representation of an object only changes when the view's XYWorldReference changes, which happens less frequently.

As the mode influences the way an object is represented, it must also be taken into account when checking whether that representation is being touched. When the mode contains CREATING, RESHAPING or TRANSLATING which indicate that the object must be represented in a state for an ongoing operation, the location of the start of the operation may be taken into account as mentioned above. The painting result can take into account multiple locations, to respond to, for example, multi-touch input. When the mode contains SELECTED, the painter should also check if the non-selected representation is touched, since these are always painted on top of each other.

The boundsSFCT is often used to speed up the performance of this method as a location outside these bounds can never touch the representation of the object.

Note that this method does not give an indication of what part of the object is touched. It is up to the painter implementations to provide methods to make this distinction. The method does also not indicate what sensitivity must be applied when checking if an object is touched. It is up to the implementation to decide what should be the maximum distance between the location given in the context and the closest relevant point or area of the representation of the object.

Specified by:

isTouched in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in

aILcdGXYContext - contains the location of the interaction and the transformations to convert this location into model coordinates

Returns:

true if the representation of the object in the given mode is touched by the location as defined in the context passed, false otherwise

See Also:

boundsSFCT

boundsSFCT

public void boundsSFCT(Graphics aGraphics,
                       int aMode,
                       ILcdGXYContext aGXYContext,
                       ILcd2DEditableBounds a2DEditableBounds)
                throws TLcdNoBoundsException

Description copied from interface: ILcdGXYPainter

Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object in the given mode taking into account the given context.

If this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.

The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model space for ILcdBounded objects.

Specified by:

boundsSFCT in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in (see class documentation). For example, an object may be represented differently in SELECTED mode compared to DEFAULT mode. The returned bounds of the representation must take this different representation into account.

aGXYContext - the context for which the representation of the object is painted. It contains amongst others the transformations from model to world and world to view.

a2DEditableBounds - the bounds that must be adapted to encompass the representation of the object in the given mode and context. These bounds must not be taken into account when the method has thrown an exception.

Throws:

TLcdNoBoundsException - if no bounds can be determined for the representation of the object. This can happen when the object does not have a representation in the given context, for example when it is located in a part of the world which is not visible in the current view.

See Also:

isTouched

paint

public void paint(Graphics aGraphics,
                  int aMode,
                  ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYPainter

Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.

The visual representation of an object depends on the context. Depending on the context (e.g. is the location covered by the view), an object may or may not have a representation. The context contains:

• transformations which allow to compute the location in view space of points and bounds given in model, space
• a pen which can connect points with a line or create arcs around a point,
• the view for which the object's representation must be painted. This can be useful when the painted object depends on the scale of the view, or the presence of other layers in the view.
• the current location(s) of the mouse or input device and the last location(s) the mouse or input device was pressed.

The mode passed in this method indicates what part of the object must be painted, whether it should be painted as selected or not, and whether user interaction (via mouse movements) must be taken into account.

When the mode passed contains either TRANSLATING, RESHAPING or CREATING, this method is also responsible for interpreting interaction on the representation of an object and modifying the representation of the object accordingly. The painter is not responsible for modifying the object itself, this is done by a corresponding ILcdGXYEditor . Implementations of ILcdGXYPainter and ILcdGXYEditor interfaces must be consistent for an object: the painter must display the result of the user interaction on the object, while the editor is responsible for modifying the object as a result of the user interaction. A good practice to ensure a consistent implementation is to implement both the ILcdGXYPainter and ILcdGXYEditor interfaces in a single class.

When the mode passed includes SNAPS, the part of the representation which corresponds to the object returned as snap target by the method snapTarget must be painted in order to provide the user with a visual indication of the snap target.

The Graphics passed in this method can be different from the Graphics returned by a view due to techniques such as double buffering (as applied in Swing). Basic drawing operations must always be performed on the Graphics passed as an argument in this method.

Specified by:

paint in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in (see class documentation).

aGXYContext - the ILcdGXYContext the drawing depends on.

getObject

public Object getObject()

Description copied from interface: ILcdGXYEditor

Returns the object this editor is currently set to edit.

Specified by:

getObject in interface ILcdGXYEditor

Specified by:

getObject in interface ILcdGXYPainter

Returns:

the object this editor is currently set to edit.

See Also:

ILcdGXYPainter.setObject(Object)

setObject

public void setObject(Object o)

Description copied from interface: ILcdGXYEditor

Sets the object which may be edited by this editor.

When the object is set to an editor, the context parameter in subsequent calls to methods in this class should contain a layer that contains this object and for which the editor for this object is this editor.

Specified by:

setObject in interface ILcdGXYEditor

Specified by:

setObject in interface ILcdGXYPainter

Parameters:

o - the object for which the editing shall be handled by this editor.

See Also:

ILcdGXYEditor.getObject()

edit

public boolean edit(Graphics aGraphics,
                    int i,
                    ILcdGXYContext aContext)

Description copied from interface: ILcdGXYEditor

Defines how an object shall be edited by this editor, taking into account the mode and the context passed.

The mode passed indicates how the interaction should be interpreted. It can be one of the following:

• TRANSLATED
• RESHAPED

• START_CREATION
• CREATING
• END_CREATION

The first two modes designate that the object should be modified, the last three modes are passed when initializing an object. From an implementation point of view there is no difference between TRANSLATED and RESHAPED. These constants only differ in semantics. For ILcdShape objects TRANSLATED can be seen as the mode that will be passed when the shape as a whole is moved. RESHAPED is used more often for moving part of a shape.

The context contains information on the user interaction at hand. The methods getX and getY contain the location(s) of the user interaction. The methods getDeltaX and getDeltaY contain the distance(s) over which the user interaction is taking place. For example, getX and getY may contain the current mouse location while getDeltaX and getDeltaY contain the distance over which the mouse has been dragged. The editing behavior can take into account multiple locations, to respond to, for example, multi-touch input.

When a snap target is accepted, the implementation of this method should take that fact into account when editing or initializing an object.

Specified by:

edit in interface ILcdGXYEditor

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

i - indicates how the user interaction should be interpreted. Is one of the following:

• TRANSLATED,
• RESHAPED,
• START_CREATION,
• CREATING,
• END_CREATION.

aContext - contains information on the user interaction and the transformations to transform from view space to the object model space.

Returns:

true if the object has changed when this method returns, false otherwise.

See Also:

ILcdGXYContext, acceptSnapTarget

getCreationClickCount

public int getCreationClickCount()

Description copied from interface: ILcdGXYEditor

Returns the number user interactions required to complete the initialization of an object set to this editor. For example, for a circle this can be two: one to determine the center point of the circle and one to determine the radius of the circle. A negative number indicates that there is no upper limit to the number of user interactions. For example, for a polyline this could be -2: it requires a minimum of two clicks to establish a polyline, but there is no upper limit on the number of polyline points.

Specified by:

getCreationClickCount in interface ILcdGXYEditor

Returns:

the number of user interactions required to initialize the object set to this editor.

acceptSnapTarget

public boolean acceptSnapTarget(Graphics aGraphics,
                                ILcdGXYContext aContext)

Description copied from interface: ILcdGXYEditor

Returns whether the object set to the editor can be edited so that (part of) the object snaps to the object passed as snap target in the context. If the snap target is accepted, a call to the edit method with this context passed should edit the object so that (part of) the object snaps to the object passed as snap target in the context.

The context contains information on the user interaction at hand: the current location of the user interaction, given by its X and Y coordinates, and the distance in X direction and distance in Y direction over which the user interaction is taking place. For example, getX and getY may contain the current mouse location while getDeltaX and getDeltaY contain the distance over which the mouse has been dragged. The context also contains the candidate snap target and the layer the snap target is contained in.

Specified by:

acceptSnapTarget in interface ILcdGXYEditor

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aContext - the context containing the information on the user interaction and the snap target.

Returns:

whether the object set to the editor can be edited so that (part of) the object snaps to the object passed as snap target in the context.

See Also:

ILcdGXYContext.getSnapTarget()

anchorPointSFCT

public void anchorPointSFCT(Graphics aGraphics,
                            int i,
                            ILcdGXYContext aContext,
                            Point aPoint)
                     throws TLcdNoBoundsException

Description copied from class: ALcdGXYPainter

Implements ILcdGXYPainter.anchorPointSFCT. aPointSFCT will be set to the center of the bounds calculated by boundsSFCT.

Specified by:

anchorPointSFCT in interface ILcdGXYPainter

Overrides:

anchorPointSFCT in class ALcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

i - the mode the object is painted in (see class documentation)

aContext - the context for which the representation of the object is painted. It contains amongst others the transformations from model to world and world to view.

aPoint - the point that has to be moved to the location of the anchor point of the representation of the object. This point must not be taken into account when the method has thrown a TLcdNoBoundsException.

Throws:

TLcdNoBoundsException - if no anchor point can be determined for the representation of the object. This can be when the object does not have a representation in the given context, for example when it is located in a part of the world which is not visible in the projection as set in the views world reference.

See Also:

paint