Package com.luciad.view.gxy.painter

Class TLcdGXYBoundsPainter

java.lang.Object
com.luciad.view.gxy.ALcdGXYPainter
com.luciad.view.gxy.painter.ALcdGXYAreaPainter
com.luciad.view.gxy.painter.TLcdGXYBoundsPainter
All Implemented Interfaces:
ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYEditor, ILcdGXYEditorProvider, ILcdGXYPainter, ILcdGXYPainterProvider, ILcdGXYPathPainter, Serializable, Cloneable
public class TLcdGXYBoundsPainter extends ALcdGXYAreaPainter implements ILcdGXYPainter, ILcdGXYEditor, ILcdGXYEditorProvider, ILcdGXYPathPainter
Paints and locates ILcdBounds objects and enables visual editing of ILcd2DEditableBounds objects in an ILcdGXYView.

Painting an ILcdBounds

Body

This painter provides three paint modes to paint the body of an ILcdBounds object. The mode property can be set using the method setMode and allows the bounds to be painted as:


A bounds
A filled bounds
A filled and outlined bounds
An outlined bounds (OUTLINED)
A filled bounds (FILLED)
A filled and outlined bounds (OUTLINED_FILLED)

Handles

This painter defines the four corner points of the ILcdBounds object as a handle of the bounds. The following image clarifies the handle location, the corner points are represented by red points.

The different handles

Snap targets

One of the four corner points of the ILcdBounds object can be returned on the condition that it is touched. The point returned as a snap target is highlighted with the snapIcon.

Styling options

The visualization of the ILcdBounds object is governed by the line style and fill style set to this painter. Depending on the paint mode chosen one or both of these will be taken into account.

Locating an ILcdBounds in a view

Anchor point of an ILcdBounds

The anchor point of the ILcdBounds object is located at the center point of the bounds, calculated by boundsSFCT.

When is an ILcdBounds touched

Depending on the paint mode, a bounds is touched when either the contour, one of the corner points, or the internal area (when filled) of the bounds is touched.

Visually editing an ILcd2DEditableBounds

Modifying an ILcd2DEditableBounds

This editor provides the following edit functionality for the different render modes:

  • RESHAPED: a contour edge or a corner point is reshaped, depending on whether they are touched. The images below illustrate the editing behavior. The small black arrow indicates the path of the mouse cursor while reshaping the bounds.

    Moving a corner point
    		Moving a contour edge
    Moving a corner point.
    		Moving a contour edge.

  • TRANSLATED: a corner point or the whole bounds is translated, depending on whether a corner point, the contour or the interior is touched. The images below illustrate the editing behavior. The small black arrow indicates the path of the mouse cursor while translating the bounds.

    Moving a corner point
    		Moving the contour
    		Moving the interior
    Moving a corner point.
    		Moving the contour.
    		Moving the interior.

Initializing an ILcd2DEditableBounds

When initializing a bounds via interaction through the view, 2 user interactions are required to complete the initialization. The first will define the first corner point of the bounds and the second will define the opposite corner point.

Accepted snap targets

All points are accepted as snap target as long as:

  • the point can be transformed to the reference of the ILcdBounds object with the model to model transformation,
  • the point is not one of the corner points of the ILcdBounds object set to this painter.

Additional properties

Caching

This painter implementation supports caching for objects implementing ILcdCache. Caching can be turned on/off with the setPaintCache method.

See Also:

  • Field Details

    • CORNER_LOWER_LEFT

      public static final int CORNER_LOWER_LEFT
      Constant value indicating the lower left corner of the ILcdBounds.
      See Also:

    • CORNER_UPPER_LEFT

      public static final int CORNER_UPPER_LEFT
      Constant value indicating the upper left corner of the ILcdBounds.
      See Also:

    • CORNER_UPPER_RIGHT

      public static final int CORNER_UPPER_RIGHT
      Constant value indicating the upper right corner of the ILcdBounds.
      See Also:

    • CORNER_LOWER_RIGHT

      public static final int CORNER_LOWER_RIGHT
      Constant value indicating the lower right corner of the ILcdBounds.
      See Also:

    • OUTLINED

      public static final int OUTLINED
      Draw the ILcdBounds object as an outlined bounds, only the contour of the bounds defined by the ILcdBounds is painted.
      See Also:

    • FILLED

      public static final int FILLED
      Draw the ILcdBounds object as a filled bounds, only the area of the bounds defined by the ILcdBounds is painted.
      See Also:

    • OUTLINED_FILLED

      public static final int OUTLINED_FILLED
      Draw the ILcdBounds object as an outlined and filled bounds, both the area and the contour of the bounds defined by the ILcdBounds are painted.
      See Also:

  • Constructor Details

    • TLcdGXYBoundsPainter

      public TLcdGXYBoundsPainter()
      Constructs a default TLcdGXYBoundsPainter in the default mode OUTLINED and sets the display name to "Bounds".

  • Method Details

    • setTraceOn

      public void setTraceOn(boolean aTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.
      Overrides:
      setTraceOn in class ALcdGXYPainter
      Parameters:
      aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

    • isTraceOn

      public boolean isTraceOn()
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Returns true if tracing is enabled for this class.
      Overrides:
      isTraceOn in class ALcdGXYPainter
      Returns:
      true if tracing is enabled for this class, false otherwise.

    • setObject

      public void setObject(Object aObject)

      Sets the object to paint and edit. The object should be an instance of ILcdBounds for painting and an instance of ILcd2DEditableBounds for editing.

      This painter/editor can be used to paint the object without using the edit functionality. This method shall therefore only check if the object implements ILcdBounds and shall throw a ClassCastException if it does not.

      When this painter is used as editor with an object that does not implement the interface ILcd2DEditableBounds, the edit method shall throw the necessary exception.

      Specified by:
      setObject in interface ILcdGXYEditor
      Specified by:
      setObject in interface ILcdGXYPainter
      Parameters:
      aObject - The object to paint and edit.
      Throws:
      ClassCastException - when the object does not implement ILcdBounds.
      See Also:

    • getObject

      public final Object getObject()
      Returns the object that can currently be painted or edited by this painter/editor.
      Specified by:
      getObject in interface ILcdGXYEditor
      Specified by:
      getObject in interface ILcdGXYPainter
      Returns:
      the object that can currently be painted or edited by this painter/editor.
      See Also:

    • setPaintCache

      public void setPaintCache(boolean aPaintCache)
      Turns caching of the representation of the object on or off. Caching greatly reduces the time to paint an object but requires more memory. The representation of an object can only be cached for objects which implement ILcdCache. By default, caching is turned on.
      Parameters:
      aPaintCache - A flag indicating whether to use caching when painting an object.
      See Also:

    • getPaintCache

      public boolean getPaintCache()
      Returns whether caching is used when painting this painter's object.
      Returns:
      true if caching is used to paint this painter's object, false otherwise.
      See Also:

    • setFillSelection

      public void setFillSelection(boolean aFillSelection)
      Deprecated.
      use ALcdGXYAreaPainter.setSelectionMode(int) instead.
      Determines whether the painter will fill the bounds when it is selected. This property is only valid when the default paint mode property is either OUTLINED, FILLED or OUTLINED_FILLED. The default is false.
      Parameters:
      aFillSelection - A flag indicating whether to paint the object filled when selected.
      See Also:

    • getFillSelection

      public boolean getFillSelection()
      Deprecated.
      use ALcdGXYAreaPainter.getSelectionMode() instead.
      Returns whether the object is painted filled in the render mode ILcdGXYPainter.SELECTED.
      Returns:
      whether the object is painted filled in the render mode ILcdGXYPainter.SELECTED.
      See Also:

    • setSnapIcon

      public void setSnapIcon(ILcdIcon aSnapIcon)
      Sets the icon that marks snap targets of the object currently set to this painter. This icon is painted when the paint method is called with the render mode ILcdGXYPainter.SNAPS.
      Parameters:
      aSnapIcon - The icon that should be used to paint snap target points.
      See Also:

    • getSnapIcon

      public ILcdIcon getSnapIcon()
      Returns the icon that is used to paint snap target points of the object set to this painter.
      Returns:
      the icon that is used to paint snap target points of the object set to this painter.
      See Also:

    • setMinimumEditDelta

      public void setMinimumEditDelta(int aDelta)
      Sets the minimum pixel distance the input device (a mouse, for example) must move before editing the shape. A larger value ensures that the object easily "snaps" back in place, a small value allows fine editing.
      Parameters:
      aDelta - the minimum pixel distance the input device should move in either the X or Y direction

    • getMinimumEditDelta

      public int getMinimumEditDelta()
      Returns the minimum pixel distance the input device (a mouse, for example) must move before editing the shape. A larger value ensures that the object easily "snaps" back in place, a small value allows fine editing. The default value is 3 pixels.
      Returns:
      the minimum pixel distance the input device should move in either the X or Y direction

    • getCursor

      public Cursor getCursor(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      Returns a Cursor that clarifies the render mode and context this painter is operating in. When no specific Cursor is required, null is returned.

      If one of the corner points is touched, the cursor reshaping is returned. In reshaping mode and if none of the corner points is touched but one of the sides is touched a resizing cursor is returned. Otherwise the default cursor is returned (translating).

      Specified by:
      getCursor in interface ILcdGXYPainter
      Overrides:
      getCursor in class ALcdGXYPainter
      Parameters:
      aGraphics - The graphics on which the object is painted.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context in which the object is rendered.
      Returns:
      a cursor to indicate the type of operating mode and context. Returns null if no particular cursor is required.

    • getGXYEditor

      public ILcdGXYEditor getGXYEditor(Object aObject)
      Returns this instance as editor for editing the specified Object. If this Object is not the same as the Object set to this painter, the setObject(Object) method is called to update the object set to the painter.
      Specified by:
      getGXYEditor in interface ILcdGXYEditorProvider
      Parameters:
      aObject - the object to be edited.
      Returns:
      this instance as editor for editing the specified Object.

    • getCreationClickCount

      public int getCreationClickCount()
      Returns 2 as the number of required user interactions.
      Specified by:
      getCreationClickCount in interface ILcdGXYEditor
      Returns:
      2.

    • isTouched

      public boolean isTouched(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
      Depending on the rendering mode, returns whether the contour, one of the corner points, or the interior of the bounds is touched.

      This implementation will use the specified paint mode to determine how the object is represented. Depending on the representation of the ILcdBounds object, the object is touched if the contour, one of the corner points, or its interior space (when it is painted filled) is touched. The coordinate for which the check is done is derived from the context passed as argument.

      Specified by:
      isTouched in interface ILcdGXYPainter
      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context in which the object is rendered.
      Returns:
      whether the contour, one of the corner points, or the interior of the bounds is touched.
      See Also:

    • paint

      public void paint(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
      Displays the representation of the object in the given mode on the Graphics passed, taking into account the context passed.

      This implementation will use the specified render mode to determine how the object needs to be rendered. In ILcdGXYPainter.CREATING, ILcdGXYPainter.RESHAPING and ILcdGXYPainter.TRANSLATING mode, the object is painted using the edit paint mode (ALcdGXYAreaPainter.getEditMode()). The object is rendered as shown in the images of the class documentation.

      In the render mode ILcdGXYPainter.SELECTED, the object is painted using the selection paint mode (ALcdGXYAreaPainter.getSelectionMode()). In all other render modes, the paint mode (ALcdGXYAreaPainter.getMode()) is used.

      Specified by:
      paint in interface ILcdGXYPainter
      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • edit

      public boolean edit(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      This implementation edits the ILcdBounds object set to the painter. The object needs to implement the interface ILcd2DEditableBounds otherwise a ClassCastException will be thrown.

      In ILcdGXYEditor.TRANSLATED render mode, the ILcdBounds object is edited as follows:

      • While touching a corner point, the corner point gets translated.
      • While touching the contour, the object gets translated as a whole.
      • While touching the interior and the selected object is painted as filled, the object gets translated as a whole.

      In ILcdGXYEditor.RESHAPED render mode, the ILcdBounds object is edited as follows:

      • While touching a corner point, the corner point will move while enlarging or reducing the width and height of the bounds.
      • While touching the contour, the edge line will move while enlarging or reducing the width or height of the bounds.

      In the creation render modes, two user interactions are required. The first will define the first corner point of the bounds and the second will define the opposite corner point.

      If, in all render modes, a snap target is found for a moved or created point, the snap target location is used for the moved/created point.

      Specified by:
      edit in interface ILcdGXYEditor
      Parameters:
      aGraphics - The graphics to edit the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.
      Returns:
      true if the object has changed when this method returns, false otherwise.
      Throws:
      ClassCastException - if the painter's object does not implement ILcd2DEditableBounds.
      See Also:

    • boundsSFCT

      public void boundsSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
      Computes the bounds of the representation of an ILcdBounds in AWT coordinates. The bounds will include the corner handles depending on the painter mode passed.
      Specified by:
      boundsSFCT in interface ILcdGXYPainter
      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.
      aBoundsSFCT - The bounds to update.
      Throws:
      TLcdNoBoundsException - if no bounds 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:

    • supportSnap

      public boolean supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)
      This implementation supports snapping, always returns true.
      Specified by:
      supportSnap in interface ILcdGXYPainter
      Overrides:
      supportSnap in class ALcdGXYPainter
      Parameters:
      aGraphics - the graphics on which is worked.
      aGXYContext - the context of the snapping.
      Returns:
      true.

    • snapTarget

      public Object snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)

      Returns one of the bounds points of the ILcdBounds object if it is touched. If no point was touched, null will be returned.

      Specified by:
      snapTarget in interface ILcdGXYPainter
      Overrides:
      snapTarget in class ALcdGXYPainter
      Parameters:
      aGraphics - the graphics on which is worked.
      aGXYContext - the context of the snapping.
      Returns:
      one of the bounds points of the ILcdBounds object if it is touched, null otherwise.
      See Also:

    • appendAWTPath

      public boolean appendAWTPath(ILcdGXYContext aGXYContext, int aRenderMode, ILcdAWTPath aAWTPathSFCT)
      Description copied from interface: ILcdGXYPathPainter
      Appends a discretized representation in view coordinates to the given path.
      Specified by:
      appendAWTPath in interface ILcdGXYPathPainter
      Parameters:
      aGXYContext - the graphics context
      aRenderMode - the rendering mode
      aAWTPathSFCT - the path to append to
      Returns:
      true if a discretization of the shape could be successfully appended to the path

    • appendGeneralPath

      public boolean appendGeneralPath(ILcdGXYContext aGXYContext, int aRenderMode, ILcdGeneralPath aGeneralPathSFCT)
      Description copied from interface: ILcdGXYPathPainter
      Appends a discretized representation in world coordinates to the given path.
      Specified by:
      appendGeneralPath in interface ILcdGXYPathPainter
      Parameters:
      aGXYContext - the graphics context
      aRenderMode - the rendering mode
      aGeneralPathSFCT - the path to append to
      Returns:
      true if a discretization of the shape could be successfully appended to the path

    • setModelModelTransformationClass

      public void setModelModelTransformationClass(Class aModel2ModelTransformationClass)

      Sets the transformation class that should be used when snapping to points that are defined in a different reference than the reference of this painter's object. The transformation will be instantiated and setup to transform points from the model of the snap layer to points in the model which contains the current object of this painter. The default value is the TLcdGeoReference2GeoReference class.

      This property allows the painter to snap to points defined in a different model reference.

      Instances of this specified class should implement ILcdModelModelTransformation, otherwise the snapping functionality to different model references will not work.

      Parameters:
      aModel2ModelTransformationClass - the transformation used as described above.

    • acceptSnapTarget

      public boolean acceptSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)

      Determines whether a snap target should be accepted or not. A snap target is accepted if the following conditions are met:

      • The current object is an ILcd2DEditableBounds.
      • The snap target is an ILcdPoint whose coordinates are expressed in the same coordinate system as the current objects coordinate system or the model to model transformation can transform the point to a point in the objects coordinate system.
      • The snap object is not one of the corner points of the current object. If this is wanted, override the function and return true if the snap object is one of the corner points.
      • One of the corner points is touched or the width and the height of the bounds are 0. This enables snapping when creating a bounds.

      Specified by:
      acceptSnapTarget in interface ILcdGXYEditor
      Parameters:
      aGraphics - the graphics on which the snap target should be checked.
      aGXYContext - the context in which the snap target should be checked.
      Returns:
      true if the above conditions are met, false otherwise.
      See Also:

    • setupGraphicsForLine

      protected void setupGraphicsForLine(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      Called just before painting a line on the specified Graphics object. It can be redefined in order to set specific Graphics properties like Color, etc...

      This implementation calls ILcdGXYPainterStyle.setupGraphics(java.awt.Graphics, java.lang.Object, int, com.luciad.view.gxy.ILcdGXYContext) on the lineStyle property if a line style has been set to this instance.

      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • setupGraphicsForFill

      protected void setupGraphicsForFill(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      Called just before filling bounds on the specified Graphics object. It can be redefined in order to set specific Graphics properties like Color, etc...

      This implementation calls ILcdGXYPainterStyle.setupGraphics(java.awt.Graphics, java.lang.Object, int, com.luciad.view.gxy.ILcdGXYContext) on the fillStyle property if a fill style has been set to this instance.

      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • linkToSnapTarget

      protected boolean linkToSnapTarget(Graphics aGraphics, ILcd2DEditableBounds a2DEditableBoundsSFCT, int aCornerIndex, int aRenderMode, ILcdGXYContext aGXYContext)
      Sets the specified corner point at the given snap target, if the snap target is accepted. The corner index should be is one of the predefined constants (CORNER_LOWER_LEFT, CORNER_LOWER_RIGHT,CORNER_UPPER_LEFT,CORNER_UPPER_RIGHT).
      Parameters:
      aGraphics - The graphics to paint the object on.
      a2DEditableBoundsSFCT - The bounds objects to be edited.
      aCornerIndex - The corner index to set at the snap target.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.
      Returns:
      whether the corner was successfully linked to the snap target.
      See Also:

    • 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 ILcdGXYEditorProvider
      Specified by:
      clone in interface ILcdGXYPainterProvider
      Overrides:
      clone in class ALcdGXYAreaPainter
      Returns:
      a clone of this painter provider.
      See Also: