Package com.luciad.view.gxy.painter

Class TLcdGXYCompositeCurvePainter

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

Painting an ILcdCompositeCurve

Body

This painter provides support for painting an ILcdCompositeCurve object. For each curve of the composite curve, a painter is retrieved via the set painter provider. The retrieved painter is then used to discretize the corresponding ILcdCurve object.

Handles

This painter does not define a handle for ILcdCompositeCurve objects. However, the handles for each individual ILcdCurve object are defined by the corresponding painter for that curve.

Snap targets

This painter will process all ILcdCurve objects in the ILcdCompositeCurve object and tries to retrieve a snap target for each curve using the corresponding painter. The first snap target that is found, is used as snap target for this TLcdGXYCompositeCurvePainter.

Styling options

The visualization of the ILcdCompositeCurve object is governed by the painter provider set to this painter. The painter provider is responsible for providing a painter to be used for painting each of the individual ILcdCurve objects contained in the ILcdCompositeCurve object. Note that this implementation assumes that a painter can be provided for each curve of the composite curve.

Locating an ILcdCompositeCurve in a view

Anchor point of an ILcdCompositeCurve

When the ILcdCompositeCurve object only contains one ILcdCurve object, the anchor point of that object is used as anchor point for the composite curve. If more ILcdCurve objects are available, the center point of the bounds, calculated by boundsSFCT, is used.

When is an ILcdCompositeCurve touched

The ILcdCompositeCurve object is touched when one of the ILcdCurve objects in the composite curve is touched.

Visually editing and creating an ILcdCompositeCurve

Modifying an ILcdCompositeCurve

This implementation translates either the touched handle or the entire composite curve for ILcdGXYEditor.TRANSLATED, and translates the touched sub curve if the user drags with ILcdGXYEditor.RESHAPED. Note that this behavior relies on the sub curve painter's isTouched method to distinguish between touching the curve body and the handles. Other edit operations are passed onto the first touched sub curve that is successfully edited. For every shape that has to be edited, an editor is retrieved via the set setCurveGXYEditorProvider(com.luciad.view.gxy.ILcdGXYEditorProvider). The retrieved editor is then used to edit the corresponding ILcdCurve object.

Similarly to the painter provider, the editor provider is responsible for providing an editor to be used for editing the individual ILcdCurve objects contained in the ILcdCompositeCurve object. Note that this implementation assumes that an editor can be provided for each shape of the composite curve.

Creating an ILcdCompositeCurve

When initializing an ILcdCompositeCurve object via interaction through the view, only the last curve object is edited. The number of user interactions required to complete the initialization is defined by the editor corresponding to the last ILcdCurve object.

Accepted snap targets

This painter accepts a snap target if at least one of the curve editors returned by the curve editor provider accepts the snap target.

Since:
9.0
See Also:

  • Field Details

    • MIDDLE_OF_BOUNDS

      public static final int MIDDLE_OF_BOUNDS
      Constant value indicating that the anchor point should be chosen in the middle of the bounds, calculated by boundsSFCT.
      See Also:

    • FOCUS_POINT

      public static final int FOCUS_POINT
      Constant value indicating that the anchor point should be chosen as the focus point of the curve. This focus point is first retrieved in model coordinates, and then transformed to view coordinates. If this point cannot be retrieved, the MIDDLE_OF_BOUNDS method is used.
      See Also:

    • ONE_CURVE_ANCHOR_POINT

      public static final int ONE_CURVE_ANCHOR_POINT
      Constant value indicating that the anchor point should be chosen as the anchor point of the only curve in the composite curve. If more than one curve exists in the composite curve, the MIDDLE_OF_BOUNDS method is used.
      See Also:

    • FIRST_POSSIBLE_CURVE_ANCHOR_POINT

      public static final int FIRST_POSSIBLE_CURVE_ANCHOR_POINT
      Constant value indicating that the anchor point should be chosen at the anchor point of the first possible curve. If this point is invalid, then the second curve is used, and so on... If no valid anchor point can be found, the MIDDLE_OF_BOUNDS method is used.
      See Also:

    • START_OF_CURVE

      public static final int START_OF_CURVE
      Constant value indicating that the anchor point should be chosen at the start point of the curve. This start point is first retrieved in model coordinates, and then transformed to view coordinates. If this point cannot be retrieved, the MIDDLE_OF_BOUNDS method is used.
      See Also:

    • MIDDLE_OF_CURVE

      public static final int MIDDLE_OF_CURVE
      Constant value indicating that the anchor point should be chosen at the middle of the curve. The middle is first retrieved in model coordinates, and then transformed to view coordinates. If this point cannot be retrieved, the MIDDLE_OF_BOUNDS method is used.
      See Also:

    • END_OF_CURVE

      public static final int END_OF_CURVE
      Constant value indicating that the anchor point should be chosen at the end point of the curve. This end point is first retrieved in model coordinates, and then transformed to view coordinates. If this point cannot be retrieved, the MIDDLE_OF_BOUNDS method is used.
      See Also:

  • Constructor Details

  • Method Details

    • getAnchorPointLocation

      public int getAnchorPointLocation()
      Returns the location of the anchor point (by default: ONE_CURVE_ANCHOR_POINT).
      Returns:
      one of MIDDLE_OF_BOUNDS, FOCUS_POINT, ONE_CURVE_ANCHOR_POINT, FIRST_POSSIBLE_CURVE_ANCHOR_POINT, START_OF_CURVE, MIDDLE_OF_CURVE, END_OF_CURVE.

    • setAnchorPointLocation

      public void setAnchorPointLocation(int aAnchorPointLocation)
      Sets the preferred anchor point location.
      Parameters:
      aAnchorPointLocation - one of MIDDLE_OF_BOUNDS, FOCUS_POINT, ONE_CURVE_ANCHOR_POINT, FIRST_POSSIBLE_CURVE_ANCHOR_POINT, START_OF_CURVE, MIDDLE_OF_CURVE, END_OF_CURVE.

    • 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 retrieve a painter for all ILcdCurve objects inside the ILcdCompositeCurve object using the set painter provider and will use that painter to paint the corresponding shape.

      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.

    • 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.

    • setObject

      public void setObject(Object aObject)
      Description copied from interface: ILcdGXYPainter
      Sets the Object for which the representation shall be handled by this painter.

      Setting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.

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

      Specified by:
      setObject in interface ILcdGXYEditor
      Specified by:
      setObject in interface ILcdGXYPainter
      Parameters:
      aObject - the object for which the representation shall be handled by this painter.
      See Also:

    • setLineStyle

      public void setLineStyle(ILcdGXYPainterStyle aLineStyle)
      Sets the line style to use when painting the outline of the object. Note that this property can be set to null.
      Parameters:
      aLineStyle - the line style to use when painting the outline of the object.
      See Also:

    • getLineStyle

      public ILcdGXYPainterStyle getLineStyle()
      Returns the line style used for painting the outline of the object. Note that this method can return null.
      Returns:
      the line style used for painting the outline of the object.
      See Also:

    • setupGraphicsForLine

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

      Called just before painting the composite curve 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:
      aCurve - The curve to paint.
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • getObject

      public Object getObject()
      Description copied from interface: ILcdGXYPainter
      Returns the Object for which the representation is currently being handled by this painter.
      Specified by:
      getObject in interface ILcdGXYEditor
      Specified by:
      getObject in interface ILcdGXYPainter
      Returns:
      the Object for which the representation is currently being handled by this painter.
      See Also:

    • setCurveGXYPainterProvider

      public void setCurveGXYPainterProvider(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider)
      Sets the painter provider used to provide a painter for each shape inside the composite curve.
      Parameters:
      aCurveGXYPainterProvider - the painter provider for the ILcdCurve objects inside the ILcdCompositeCurve object.
      See Also:

    • getCurveGXYPainterProvider

      public ILcdGXYPainterProvider<ILcdGXYPathPainter> getCurveGXYPainterProvider()
      Returns the painter provider used to provide a painter for each shape inside the composite curve.
      Returns:
      the painter provider used to provide a painter for each shape inside the composite curve.
      See Also:

    • setCurveGXYEditorProvider

      public void setCurveGXYEditorProvider(ILcdGXYEditorProvider aCurveGXYEditorProvider)
      Sets the editor provider used to provide an editor for each shape inside the composite curve.
      Parameters:
      aCurveGXYEditorProvider - the editor provider for the ILcdCurve objects inside the ILcdCompositeCurve object.
      See Also:

    • getCurveGXYEditorProvider

      public ILcdGXYEditorProvider getCurveGXYEditorProvider()
      Returns the editor provider used to provide an editor for each shape inside the composite curve.
      Returns:
      the editor provider used to provide an editor for each shape inside the composite curve.
      See Also:

    • setCurveConnectorProvider

      public void setCurveConnectorProvider(ILcdCurveConnectorProvider aCurveConnectorProvider)
      Sets a connector provider to ensure connectivity during editing operations.
      Parameters:
      aCurveConnectorProvider - a connector provider that returns a connector for the curve types encountered in every composite curve.
      See Also:

    • getCurveConnectorProvider

      public ILcdCurveConnectorProvider getCurveConnectorProvider()
      Returns the curve provider used to provider a curve connector for each shape inside the composite curve.
      Returns:
      the curve provider used to provider a curve connector for each shape inside the composite curve.
      See Also:

    • anchorPointSFCT

      public void anchorPointSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, Point aPointSFCT) throws TLcdNoBoundsException

      Moves the specified aPointSFCT to the anchor point of the ILcdCompositeCurve object. If the composite curve only contains one object, the anchor point of that object is used. When more shapes are available in the composite curve, the center point of the bounds, calculated by boundsSFCT, is used

      Specified by:
      anchorPointSFCT in interface ILcdGXYPainter
      Overrides:
      anchorPointSFCT in class ALcdGXYPainter
      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.
      aPointSFCT - The point that needs to be updated.
      Throws:
      TLcdNoBoundsException - if the ILcdCompositeCurve object doesn't have a valid anchor point, e.g. if it is always invisible in the current projection.
      See Also:

    • supportSnap

      public boolean supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)

      Supports snapping when at least one of the painters of the shapes inside the ILcdCompositeCurve object supports snapping.

      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 if one of the painters for the shapes inside the ILcdCompositeCurve object supports snapping, false otherwise.

    • snapTarget

      public Object snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)

      Returns the first snap target that was found by the painters of the shapes inside the ILcdCompositeCurve object. 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:
      the first snap target that was found by the painters of the shapes inside the ILcdCompositeCurve object, null otherwise.
      See Also:

    • boundsSFCT

      public void boundsSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
      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 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 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:

    • 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.
      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.

    • edit

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

      This implementation translates either the touched handle or the entire composite curve for ILcdGXYEditor.TRANSLATED, and translates the touched sub curve if the user drags with ILcdGXYEditor.RESHAPED. Note that this behavior relies on the sub curve painter's isTouched method to distinguish between touching the curve body and the handles. Other edit operations are passed onto the first touched sub curve that is successfully edited. For every shape that has to be edited, an editor is retrieved via the set editor provider. The retrieved editor is then used to edit the corresponding ILcdCurve object.

      In the creation render modes, only the last ILcdCurve object is edited.

      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.
      See Also:

    • getCreationClickCount

      public int getCreationClickCount()
      Returns the number of user interactions required to complete the initialization of the ILcdCompositeCurve object set to this editor. This method will return the number of user interactions required by the editor corresponding to the last ILcdCurve object.
      Specified by:
      getCreationClickCount in interface ILcdGXYEditor
      Returns:
      the number of user interactions required by the editor corresponding to the last ILcdCurve object.

    • acceptSnapTarget

      public boolean acceptSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)

      Determines whether a snap target should be accepted or not. A snap target is accepted if at least one of the curve editors returned by the curve editor provider accepts the snap target.

      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 at least one of the curve editors returned by the curve editor provider accepts the snap target, false otherwise.
      See Also:

    • isTouched

      public boolean isTouched(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
      Returns whether one of the ILcdCurve objects inside the ILcdCompositeCurve object is touched.
      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 one of the ILcdCurve objects inside the ILcdCompositeCurve object is touched.
      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

    • clone

      public Object clone(Map aObjectDictionary)
      Description copied from interface: ILcdDeepCloneable
      Returns a deep clone of this Object.

      An object dictionary is used to keep track of all objects of the original Object graph, for which a clone has already been created. The dictionary should be a java.util.Map, using reference-equality instead of object-equality when comparing keys (such as the java.util.IdentityHashMap). It contains as keys the objects in the original object graph that have already been cloned, and as values their corresponding clone.

      The Object returned by this method should fulfill the following conditions, as specified in the general Object.clone() contract:

      • this.clone(aObjectDictionary) != this
      • this.clone(aObjectDictionary).getClass() == this.getClass()
      • this.clone(aObjectDictionary).equals(this)

      In addition, the following conditions should also hold:

      • If a clone of this Object already exists in the object dictionary before this clone method is called, this method shall return that clone: 
        aObjectDictionary.get(this) == null || aObjectDictionary.get(this) == this.clone(aObjectDictionary)
      • The object dictionary shall contain the resulting clone, after this clone method has completed: 
        this.clone(aObjectDictionary) == aObjectDictionary.get(this)
      Specified by:
      clone in interface ILcdDeepCloneable
      Parameters:
      aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.
      Returns:
      a deep clone of this Object that fulfills the conditions described above.

    • 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 ALcdGXYPainter
      Returns:
      a clone of this painter provider.
      See Also: