TLcdGXYCirclePainter (LuciadFusion API documentation)

java.lang.Object
- com.luciad.view.gxy.ALcdGXYPainter
- - com.luciad.view.gxy.painter.ALcdGXYAreaPainter
  - - com.luciad.view.gxy.painter.TLcdGXYCirclePainter

All Implemented Interfaces:: ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYEditor, ILcdGXYEditorProvider, ILcdGXYPainter, ILcdGXYPainterProvider, ILcdGXYPathPainter, Serializable, Cloneable

public class TLcdGXYCirclePainter
extends ALcdGXYAreaPainter
implements ILcdGXYPainter, ILcdGXYEditor, ILcdGXYEditorProvider, ILcdGXYPathPainter

Paints and locates ILcdCircle objects and enables visual editing of ILcd2DEditableCircle objects in an ILcdGXYView.

Painting an ILcdCircle

Body

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



An outlined circle (`OUTLINED`)	A filled circle (`FILLED`)	A filled and outlined circle (`OUTLINED_FILLED`)

Objects that are selected or that are being edited, are painted as defined by the selectionMode and editMode properties, respectively. The same values as above can be used for both mode properties.

Handles

This painter does not define a handle for ILcdCircle objects. Note that the center point of the circle is painted in BODY mode depending on the drawCenter property. When painted, it can be used as a handle to edit the object.

Snap targets

If the center point is painted (see isDrawCenter()) or when snapping to invisible points is enabled (see isSnapToInvisiblePoints()), the center point can also be returned. The point returned as a snap target is highlighted with the snapIcon.

Styling options

The visualization of the ILcdCircle 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 ILcdCircle in a view

Anchor point of an ILcdCircle

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

When is an ILcdCircle touched

Depending on the paint mode, a circle is touched when either the contour, the center point, or the internal area (when filled) of the circle is touched. Note that the center point can only be touched if it is painted.

Visually editing and creating an ILcd2DEditableCircle

Modifying an ILcd2DEditableCircle

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

RESHAPED: the contour of the circle is reshaped, depending on whether it is touched. The image below illustrates the editing behavior. The small black arrow indicates the path of the mouse cursor while reshaping the circle.

Moving the contour.

TRANSLATED: the whole circle is translated, depending on whether 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 circle.

Moving the contour.
Moving the interior.

Note that, if the center point of the circle is touched (and painted), the whole circle can be translated as if the contour was touched.

Creating an ILcd2DEditableCircle

When initializing a circle via interaction through the view, 2 user interactions are required to complete the initialization. The first point defines the center point of the circle and the second the radius of the circle.

Accepted snap targets

All points are accepted as snap target as long as:

the point can be transformed to the reference of the ILcdCircle object with the model to model transformation,
the point is not the center point of the ILcdCircle 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.

Drawing the center point

The drawCenter and drawCenterWhenSelected properties define when the center point needs to be painted. If the center point is painted, it can be touched, moved,...

Drawing the editing labels

A number of properties can be set to configure the representation of the editing labels. The editing labels are drawn depending on the property editingLabel and on the rendering mode specified in the paint method. The labels display the location of the center point of the circle when it is dragged, or the radius of circle when its size is changed.

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CENTER_POINT` Constant value indicating that the anchor point should be chosen as the center point of the circle.
`static int`	`FILLED` Draw the `ILcdCircle` object as a filled circle, only the area of the circle defined by the `ILcdCircle` is painted.
`static int`	`FOCUS_POINT` Constant value indicating that the anchor point should be chosen as the focus point of the circle.
`static int`	`MIDDLE_OF_BOUNDS` Constant value indicating that the anchor point should be chosen in the middle of the bounds, calculated by `boundsSFCT`.
`static int`	`OUTLINED` Draw the `ILcdCircle` object as an outlined circle, only the contour of the circle defined by the `ILcdCircle` is painted.
`static int`	`OUTLINED_FILLED` Draw the `ILcdCircle` object as an outlined and filled circle, both the area and the contour of the circle defined by the `ILcdCircle` are painted.
`static Cursor[]`	`sCursorResizing` Cursor to return to indicate the object will be reshaped.
`static Cursor`	`sCursorTranslating` Cursor to return to indicate the object will be translated.

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
DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

Constructor Summary

Constructors
Constructor and Description

TLcdGXYCirclePainter()
Constructs a default TLcdGXYCirclePainter in the default mode OUTLINED and sets the display name to "Circle".

Constructors
Constructor and Description
`TLcdGXYCirclePainter()` Constructs a default `TLcdGXYCirclePainter` in the default mode `OUTLINED` and sets the display name to "Circle".

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`acceptSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)` Determines whether a snap target should be accepted or not.
`void`	`anchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT)` Implements `ILcdGXYPainter.anchorPointSFCT`.
`boolean`	`appendAWTPath(ILcdGXYContext aGXYContext, int aRenderMode, ILcdAWTPath aAWTPathSFCT)` Appends a discretized representation in view coordinates to the given path.
`boolean`	`appendGeneralPath(ILcdGXYContext aGXYContext, int aRenderMode, ILcdGeneralPath aGeneralPathSFCT)` Appends a discretized representation in world coordinates to the given path.
`void`	`boundsSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT)` Computes the bounds of the representation of an `ILcdCircle` in AWT coordinates.
`Object`	`clone()` Makes `Object.clone()` public.
`boolean`	`edit(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)` This implementation edits the `ILcdCircle` object set to the painter.
`int`	`getAnchorPointLocation()` Returns the location of the anchor point (by default: MIDDLE_OF_BOUNDS).
`ILcdIcon`	`getCenterIcon()` Returns the icon for the center point's default representation, used if `isDrawCenter()` returns true.
`ILcdIcon`	`getCenterIconWhenSelected()` Returns the icon for the center point's selected representation, used if `isDrawCenterWhenSelected()` returns true.
`int`	`getCreationClickCount()` Returns `2` as the number of required user interactions.
`Cursor`	`getCursor(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)` Returns a `Cursor` that clarifies the render mode and context this painter is operating in.
`Format`	`getDistanceFormat()` Returns the format used when displaying the circle radius while it is being reshaped.
`Color`	`getEditingLabelBackground()` Returns the background color used when displaying the editing labels.
`Font`	`getEditingLabelFont()` Returns the font used when displaying the editing labels.
`Color`	`getEditingLabelForeground()` Returns the foreground color (text color) used when displaying the editing labels.
`ILcdGXYEditor`	`getGXYEditor(Object aObject)` Returns this instance as editor for editing the specified `Object`.
`int`	`getMinimumEditDelta()` Returns the minimum pixel distance the input device (a mouse, for example) must move before editing the shape.
`Object`	`getObject()` Returns the object that can currently be painted or edited by this painter/editor.
`boolean`	`getPaintCache()` Returns whether caching is used when painting this painter's object.
`Format`	`getPointFormat()` Returns the format used when displaying the center point while it is being moved.
`ILcdIcon`	`getSnapIcon()` Returns the icon that is used to paint snap target points of the object set to this painter.
`boolean`	`isDisplayCenter()` Deprecated. Use `isDrawCenter()` instead.
`boolean`	`isDisplayCenterOnSelection()` Deprecated. Use `isDrawCenterWhenSelected()` instead.
`boolean`	`isDrawCenter()` Returns whether the center point of the circle should be displayed.
`boolean`	`isDrawCenterWhenSelected()` Returns whether the center point of the circle should be displayed when it is painted in selected mode.
`boolean`	`isEditingLabel()` Returns whether the editing labels are drawn or not.
`boolean`	`isEditingLabelFilled()` Returns whether the frame around an editing label is filled or not.
`boolean`	`isEditingLabelFrame()` Returns whether the frame around an editing label is drawn or not.
`boolean`	`isSnapToInvisiblePoints()` Returns whether the painter allows snapping to the invisible points of the shape.
`boolean`	`isTouched(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)` Depending on the rendering mode, returns whether the contour, the center point, or the interior of the circle is touched.
`boolean`	`isTraceOn()` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`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.
`void`	`paintEditingLabels(Graphics aGraphics, ILcdCircle aCircle, int aRenderMode, ILcdGXYContext aGXYContext)` Called by the `paint` method when editing an `ILcd2DEditableCircle`.
`void`	`setAnchorPointLocation(int aAnchorPointLocation)` Sets the preferred anchor point location.
`void`	`setCenterIcon(ILcdIcon aIcon)` Sets the icon for the center point's default representation, if `isDrawCenter()` returns true.
`void`	`setCenterIconWhenSelected(ILcdIcon aIcon)` Sets the icon for the center point's selected representation, if `isDrawCenterWhenSelected()` returns true.
`void`	`setDisplayCenter(boolean aDrawCenter)` Deprecated. Use `setDrawCenter(boolean)` instead.
`void`	`setDisplayCenterOnSelection(boolean aDrawCenterWhenSelected)` Deprecated. Use `setDrawCenterWhenSelected(boolean)` instead.
`void`	`setDistanceFormat(Format aDistanceFormat)` Set the distance `Format` to use for formatting the circle radius in the editing label.
`void`	`setDrawCenter(boolean aDrawCenter)` Sets whether the center point of the circle should be displayed or not.
`void`	`setDrawCenterWhenSelected(boolean aDrawCenterWhenSelected)` Sets whether the center point of the circle should be displayed when it is painted in selected mode or not.
`void`	`setEditingLabel(boolean aEditingLabel)` Sets whether the editing labels should be drawn or not.
`void`	`setEditingLabelBackground(Color aEditingLabelBackground)` Sets the background color that will be used to display the editing labels.
`void`	`setEditingLabelFilled(boolean aEditingLabelFilled)` Sets whether the frame around an editing labels needs to be filled or not.
`void`	`setEditingLabelFont(Font aEditingLabelFont)` Sets the font that will be used to display the editing labels.
`void`	`setEditingLabelForeground(Color aEditingLabelForeground)` Sets the foreground color (text color) that will be used to display the editing labels.
`void`	`setEditingLabelFrame(boolean aEditingLabelFrame)` Sets whether the frame around an editing labels needs to be drawn or not.
`void`	`setMinimumEditDelta(int aDelta)` Sets the minimum pixel distance the input device (a mouse, for example) must move before editing the shape.
`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.
`void`	`setObject(Object aObject)` Sets the object to paint and edit.
`void`	`setPaintCache(boolean aPaintCache)` Turns caching of the representation of the object on or off.
`void`	`setPointFormat(Format aPointFormat)` Set the `Format` used for formatting the coordinates of the center point as a `String`.
`void`	`setSnapIcon(ILcdIcon aSnapIcon)` Sets the icon that marks snap targets of the object currently set to this painter.
`void`	`setSnapToInvisiblePoints(boolean aSnapToInvisiblePoints)` Sets whether the other shapes can snap to invisible points of this shape.
`void`	`setTraceOn(boolean aTraceOn)` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`protected void`	`setupGraphicsForFill(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)` Called just before filling circles on the specified `Graphics` object.
`protected void`	`setupGraphicsForLine(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)` Called just before painting a line on the specified `Graphics` object.
`Object`	`snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)` Returns the center point of the `ILcdCircle` if it is touched.
`boolean`	`supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)` This implementation supports snapping, always returns `true`.

Methods inherited from class com.luciad.view.gxy.painter.ALcdGXYAreaPainter
getEditMode, getFillStyle, getLineStyle, getMode, getSelectionMode, setEditMode, setFillStyle, setLineStyle, setMode, setSelectionMode

Methods inherited from class com.luciad.view.gxy.ALcdGXYPainter
addPropertyChangeListener, firePropertyChangeEvent, firePropertyChangeEvent, getDisplayName, getGXYPainter, removePropertyChangeListener, setClassTraceOn, setDisplayName

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.view.gxy.ILcdGXYPainter
getDisplayName

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource
addPropertyChangeListener, removePropertyChangeListener

- Field Detail
  - OUTLINED
```
public static final int OUTLINED
```
    Draw the ILcdCircle object as an outlined circle, only the contour of the circle defined by the ILcdCircle is painted.
    
    See Also:
    
    Constant Field Values
  - FILLED
```
public static final int FILLED
```
    Draw the ILcdCircle object as a filled circle, only the area of the circle defined by the ILcdCircle is painted.
    
    See Also:
    
    Constant Field Values
  - OUTLINED_FILLED
```
public static final int OUTLINED_FILLED
```
    Draw the ILcdCircle object as an outlined and filled circle, both the area and the contour of the circle defined by the ILcdCircle are painted.
    
    See Also:
    
    Constant Field Values
  - sCursorTranslating
```
public static volatile Cursor sCursorTranslating
```
    Cursor to return to indicate the object will be translated.
  - sCursorResizing
```
public static Cursor[] sCursorResizing
```
    Cursor to return to indicate the object will be reshaped. Direction depends on the shape of the object.
  - 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:
    
    Constant Field Values
  - FOCUS_POINT
```
public static final int FOCUS_POINT
```
    Constant value indicating that the anchor point should be chosen as the focus point of the circle. If this point cannot be calculated, the MIDDLE_OF_BOUNDS method is used to calculate the anchor point.
    
    See Also:
    
    Constant Field Values
  - CENTER_POINT
```
public static final int CENTER_POINT
```
    Constant value indicating that the anchor point should be chosen as the center point of the circle. If this point cannot be calculated, the MIDDLE_OF_BOUNDS method is used to calculate the anchor point.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TLcdGXYCirclePainter
```
public TLcdGXYCirclePainter()
```
    Constructs a default TLcdGXYCirclePainter in the default mode OUTLINED and sets the display name to "Circle".
- Method Detail
  - 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 ILcdCircle for painting and an instance of ILcd2DEditableCircle 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 ILcdCircle 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 ILcd2DEditableCircle, 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 ILcdCircle.
    
    See Also:
    
    getObject()
  - 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:
    
    setObject(Object)
  - 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()
  - 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:
    
    setPaintCache(boolean)
  - setDisplayCenter
```
public void setDisplayCenter(boolean aDrawCenter)
```
    Deprecated. Use setDrawCenter(boolean) instead.
  - isDisplayCenter
```
public boolean isDisplayCenter()
```
    Deprecated. Use isDrawCenter() instead.
  - setDisplayCenterOnSelection
```
public void setDisplayCenterOnSelection(boolean aDrawCenterWhenSelected)
```
    Deprecated. Use setDrawCenterWhenSelected(boolean) instead.
  - isDisplayCenterOnSelection
```
public boolean isDisplayCenterOnSelection()
```
    Deprecated. Use isDrawCenterWhenSelected() instead.
  - setDrawCenter
```
public void setDrawCenter(boolean aDrawCenter)
```
    Sets whether the center point of the circle should be displayed or not. The default value of this property is false. This setting has an influence on the methods boundsSFCT, isTouched and snapping. Regardless of this setting, the center point is always displayed as a handle in HANDLES mode to allow editing.
    
    Parameters:
    
    aDrawCenter - A flag indicating whether the center point should be displayed or not.
    
    See Also:
    
    isDrawCenter(), setDrawCenterWhenSelected(boolean)
  - isDrawCenter
```
public boolean isDrawCenter()
```
    Returns whether the center point of the circle should be displayed.
    
    Returns:
    
    whether the center point of the circle should be displayed.
    
    See Also:
    
    setDrawCenter(boolean)
  - setDrawCenterWhenSelected
```
public void setDrawCenterWhenSelected(boolean aDrawCenterWhenSelected)
```
    Sets whether the center point of the circle should be displayed when it is painted in selected mode or not. The default value of this property is true. This setting has an influence on the methods boundsSFCT, isTouched and snapping. Regardless of this setting, the center point is always displayed as a handle in HANDLES mode to allow editing.
    
    Parameters:
    
    aDrawCenterWhenSelected - A flag indicating whether the center point should be displayed when it is painted in selected mode or not.
    
    See Also:
    
    isDrawCenterWhenSelected(), setDrawCenter(boolean)
  - isDrawCenterWhenSelected
```
public boolean isDrawCenterWhenSelected()
```
    Returns whether the center point of the circle should be displayed when it is painted in selected mode.
    
    Returns:
    
    whether the center point of the circle should be displayed when it is painted in selected mode.
    
    See Also:
    
    setDrawCenterWhenSelected(boolean)
  - setCenterIcon
```
public void setCenterIcon(ILcdIcon aIcon)
```
    Sets the icon for the center point's default representation, if isDrawCenter() returns true.
    
    Parameters:
    
    aIcon - the icon for the center point's default representation
    
    See Also:
    
    setDrawCenter(boolean), setCenterIconWhenSelected(com.luciad.gui.ILcdIcon)
  - getCenterIcon
```
public ILcdIcon getCenterIcon()
```
    Returns the icon for the center point's default representation, used if isDrawCenter() returns true.
    
    Returns:
    
    the icon for the center point's default representation
  - setCenterIconWhenSelected
```
public void setCenterIconWhenSelected(ILcdIcon aIcon)
```
    Sets the icon for the center point's selected representation, if isDrawCenterWhenSelected() returns true.
    
    Parameters:
    
    aIcon - the icon for the center point's selected representation
    
    See Also:
    
    setDrawCenterWhenSelected(boolean), setCenterIcon(com.luciad.gui.ILcdIcon)
  - getCenterIconWhenSelected
```
public ILcdIcon getCenterIconWhenSelected()
```
    Returns the icon for the center point's selected representation, used if isDrawCenterWhenSelected() returns true.
    
    Returns:
    
    the icon for the center point's selected representation
  - setSnapToInvisiblePoints
```
public void setSnapToInvisiblePoints(boolean aSnapToInvisiblePoints)
```
    Sets whether the other shapes can snap to invisible points of this shape. For an ILcdCircle object, there's only one invisible point, being the center point of the circle when it is not drawn. The default value is false.
    
    Parameters:
    
    aSnapToInvisiblePoints - A flag indicating whether snapping to the invisible points is allowed.
    
    See Also:
    
    isSnapToInvisiblePoints()
  - isSnapToInvisiblePoints
```
public boolean isSnapToInvisiblePoints()
```
    Returns whether the painter allows snapping to the invisible points of the shape.
    
    Returns:
    
    whether the painter allows snapping to the invisible points of the shape.
    
    See Also:
    
    setSnapToInvisiblePoints(boolean)
  - 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()
  - 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:
    
    setSnapIcon(ILcdIcon)
  - 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
  - getAnchorPointLocation
```
public int getAnchorPointLocation()
```
    Returns the location of the anchor point (by default: MIDDLE_OF_BOUNDS).
    
    Returns:
    
    one of MIDDLE_OF_BOUNDS, FOCUS_POINT, CENTER_POINT.
  - setAnchorPointLocation
```
public void setAnchorPointLocation(int aAnchorPointLocation)
```
    Sets the preferred anchor point location.
    
    Parameters:
    
    aAnchorPointLocation - one of MIDDLE_OF_BOUNDS, FOCUS_POINT, CENTER_POINT.
  - 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 circles 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.
  - 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.
  - 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
  - edit
```
public boolean edit(Graphics aGraphics,
                    int aRenderMode,
                    ILcdGXYContext aGXYContext)
```
    This implementation edits the ILcdCircle object set to the painter. The object needs to implement the interface ILcd2DEditableCircle otherwise a ClassCastException will be thrown.
    
    In ILcdGXYEditor.TRANSLATED render mode, the ILcdCircle object is edited as follows:
    - While touching the center point, the object gets translated as a whole.
    - 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 ILcdCircle object is edited as follows:
    - While touching the contour, the contour will move while enlarging or reducing the radius of the circle.
    In the creation render modes, the first action defines the center point of the circle and the second the radius of the circle.
    
    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 ILcd2DEditableCircle.
    
    See Also:
    
    ILcdGXYContext, acceptSnapTarget
  - paintEditingLabels
```
public void paintEditingLabels(Graphics aGraphics,
                               ILcdCircle aCircle,
                               int aRenderMode,
                               ILcdGXYContext aGXYContext)
```
    Called by the paint method when editing an ILcd2DEditableCircle. It draws labels indicating the values of properties being changed. For example, the coordinates of the center point or the radius of the circle. This method draws the default labels but it can be redefined for specific needs.
    
    Parameters:
    
    aGraphics - The graphics to paint the object on.
    
    aCircle - The circle that is being edited.
    
    aRenderMode - The mode to render the object in.
    
    aGXYContext - The context to render the object in.
  - 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, the center point, or the interior of the circle is touched. Note that the center point can only be touched if it is painted.
    This implementation will use the specified paint mode to determine how the object is represented. Depending on the representation of the ILcdCircle object, the object is touched if the contour, the center point (when painted) 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:
    
    the contour, the center point, or the interior of the circle is touched.
    
    See Also:
    
    boundsSFCT
  - boundsSFCT
```
public void boundsSFCT(Graphics aGraphics,
                       int aRenderMode,
                       ILcdGXYContext aGXYContext,
                       ILcd2DEditableBounds aBoundsSFCT)
                throws TLcdNoBoundsException
```
    Computes the bounds of the representation of an ILcdCircle in AWT coordinates.
    
    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:
    
    isTouched
  - 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 ILcd2DEditableCircle.
    - 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 the center point of the current object. If this is wanted, override the function and return true if the snap object is the center point.
    - The center point is touched or the radius is 0. This enables snapping when creating a circle.
    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:
    
    setModelModelTransformationClass(Class)
  - 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 the center point of the ILcdCircle if it is touched. If it was not touched, null will be returned. Note that the center point is only returned if the center point is drawn (see isDrawCenter()) or when snapping to invisible points is enabled (see isSnapToInvisiblePoints()).
    
    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 center point of the ILcdCircle if it is touched, null otherwise.
    
    See Also:
    
    supportSnap
  - 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.
  - anchorPointSFCT
```
public void anchorPointSFCT(Graphics aGraphics,
                            int aMode,
                            ILcdGXYContext aGXYContext,
                            Point aPointSFCT)
                     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
    
    aMode - the mode the object is painted in (see class documentation)
    
    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.
    
    aPointSFCT - 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
  - 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.
  - setPointFormat
```
public void setPointFormat(Format aPointFormat)
```
    Set the Format used for formatting the coordinates of the center point as a String. An ILcdPoint representing the center of the circle is given to one of the format methods of the java.text.Format, which then converts it to a String that is displayed on the map during translate operations.
    
    By default, a Format that uses the toString method is used.
    
    Parameters:
    
    aPointFormat - the Format used for formatting the coordinates of the center point as a String.
    
    See Also:
    
    getPointFormat()
  - getPointFormat
```
public Format getPointFormat()
```
    Returns the format used when displaying the center point while it is being moved.
    
    Returns:
    
    the format used when displaying the center point while it is being moved.
    
    See Also:
    
    setPointFormat(java.text.Format)
  - setDistanceFormat
```
public void setDistanceFormat(Format aDistanceFormat)
```
    Set the distance Format to use for formatting the circle radius in the editing label. A Number representing the length of the radius (same unit as ILcdCircle.getRadius) is given to one of the format methods of the java.text.Format, which then converts it to a String that is displayed on the map during edit operations that change the radius.
    
    By default, a distance format is used that assumes the radius is in meters.
    
    Parameters:
    
    aDistanceFormat - the distance format to use for formatting the circle radius in the editing label.
    
    See Also:
    
    getDistanceFormat(), TLcdDistanceFormat
  - getDistanceFormat
```
public Format getDistanceFormat()
```
    Returns the format used when displaying the circle radius while it is being reshaped.
    
    Returns:
    
    the format used when displaying the circle radius while it is being reshaped.
    
    See Also:
    
    setDistanceFormat(java.text.Format)
  - setEditingLabelFont
```
public void setEditingLabelFont(Font aEditingLabelFont)
```
    Sets the font that will be used to display the editing labels. By default, the font family is "Dialog" with a size of 10 pixels.
    
    Parameters:
    
    aEditingLabelFont - the font used to display the editing labels.
    
    See Also:
    
    getEditingLabelFont()
  - getEditingLabelFont
```
public Font getEditingLabelFont()
```
    Returns the font used when displaying the editing labels.
    
    Returns:
    
    the font used when displaying the editing labels.
    
    See Also:
    
    setEditingLabelFont(java.awt.Font)
  - setEditingLabelForeground
```
public void setEditingLabelForeground(Color aEditingLabelForeground)
```
    Sets the foreground color (text color) that will be used to display the editing labels. The default value of this property is Color.black.
    
    Parameters:
    
    aEditingLabelForeground - the foreground color (text color) used to display the editing labels.
    
    See Also:
    
    getEditingLabelForeground()
  - getEditingLabelForeground
```
public Color getEditingLabelForeground()
```
    Returns the foreground color (text color) used when displaying the editing labels.
    
    Returns:
    
    the foreground color (text color) used when displaying the editing labels.
    
    See Also:
    
    setEditingLabelForeground(java.awt.Color)
  - setEditingLabelBackground
```
public void setEditingLabelBackground(Color aEditingLabelBackground)
```
    Sets the background color that will be used to display the editing labels. The default value of this property is Color.lightGray.
    
    Parameters:
    
    aEditingLabelBackground - the background color used to display the editing labels.
    
    See Also:
    
    getEditingLabelBackground()
  - getEditingLabelBackground
```
public Color getEditingLabelBackground()
```
    Returns the background color used when displaying the editing labels.
    
    Returns:
    
    the background color used when displaying the editing labels.
    
    See Also:
    
    setEditingLabelBackground(java.awt.Color)
  - setEditingLabelFilled
```
public void setEditingLabelFilled(boolean aEditingLabelFilled)
```
    Sets whether the frame around an editing labels needs to be filled or not. The default value of this property is false.
    
    Parameters:
    
    aEditingLabelFilled - the flag indicating whether the frame around an editing label is filled.
    
    See Also:
    
    isEditingLabelFilled()
  - isEditingLabelFilled
```
public boolean isEditingLabelFilled()
```
    Returns whether the frame around an editing label is filled or not.
    
    Returns:
    
    whether the frame around an editing label is filled or not.
    
    See Also:
    
    setEditingLabelFilled(boolean)
  - setEditingLabelFrame
```
public void setEditingLabelFrame(boolean aEditingLabelFrame)
```
    Sets whether the frame around an editing labels needs to be drawn or not. The default value of this property is false.
    
    Parameters:
    
    aEditingLabelFrame - the flag indicating whether the frame around an editing label is drawn.
    
    See Also:
    
    isEditingLabelFrame()
  - isEditingLabelFrame
```
public boolean isEditingLabelFrame()
```
    Returns whether the frame around an editing label is drawn or not.
    
    Returns:
    
    whether the frame around an editing label is drawn or not.
    
    See Also:
    
    setEditingLabelFrame(boolean)
  - setEditingLabel
```
public void setEditingLabel(boolean aEditingLabel)
```
    Sets whether the editing labels should be drawn or not. The labels display the location of the center point of the circle when dragging it, or the radius of circle when changing its size. The default value of this property is false.
    
    Parameters:
    
    aEditingLabel - the flag indicating whether the frame around an editing label is drawn.
    
    See Also:
    
    isEditingLabel()
  - isEditingLabel
```
public boolean isEditingLabel()
```
    Returns whether the editing labels are drawn or not.
    
    Returns:
    
    whether the editing labels are drawn or not.
    
    See Also:
    
    setEditingLabel(boolean)
  - 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:
    
    Object.clone()


Moving the contour.		Moving the interior.

LuciadFusionClass TLcdGXYCirclePainter

Painting an ILcdCircle

Body

Handles

Snap targets

Styling options

Locating an ILcdCircle in a view

Anchor point of an ILcdCircle

When is an ILcdCircle touched

Visually editing and creating an ILcd2DEditableCircle

Modifying an ILcd2DEditableCircle

Creating an ILcd2DEditableCircle

Accepted snap targets

Additional properties

Caching

Drawing the center point

Drawing the editing labels

Field Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class com.luciad.view.gxy.painter.ALcdGXYAreaPainter

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

Field Detail

OUTLINED

FILLED

OUTLINED_FILLED

sCursorTranslating

sCursorResizing

MIDDLE_OF_BOUNDS

FOCUS_POINT

CENTER_POINT

Constructor Detail

TLcdGXYCirclePainter

Method Detail

setTraceOn

isTraceOn

setObject

getObject

setPaintCache

getPaintCache

setDisplayCenter

isDisplayCenter

setDisplayCenterOnSelection

isDisplayCenterOnSelection

setDrawCenter

isDrawCenter

setDrawCenterWhenSelected

isDrawCenterWhenSelected

setCenterIcon

getCenterIcon

setCenterIconWhenSelected

getCenterIconWhenSelected

setSnapToInvisiblePoints

isSnapToInvisiblePoints

setSnapIcon

getSnapIcon

setMinimumEditDelta

getMinimumEditDelta

getAnchorPointLocation

setAnchorPointLocation

setupGraphicsForLine

setupGraphicsForFill

paint

appendAWTPath

appendGeneralPath

edit

paintEditingLabels

getCreationClickCount

isTouched

boundsSFCT

setModelModelTransformationClass

acceptSnapTarget

supportSnap