com.luciad.view.gxy.painter

LuciadFusionClass TLcdGXYEllipsePainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYPainter

com.luciad.view.gxy.painter.ALcdGXYAreaPainter

com.luciad.view.gxy.painter.TLcdGXYEllipsePainter

All Implemented Interfaces:

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

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

Paints and locates ILcdEllipse objects and enables visual editing of ILcd2DEditableEllipse objects in an ILcdGXYView.

Painting an ILcdEllipse

Body

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

An outlined ellipse (OUTLINED)		A filled ellipse (FILLED)		A filled and outlined ellipse (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 defines the four axis points of the ILcdEllipse object as a handle of the ellipse. The following image clarifies the handle location, the axis points are represented by red points.

Note that the center point of the ellipse 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 ILcdEllipse 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 ILcdEllipse in a view

Anchor point of an ILcdEllipse

The anchor point of the ILcdEllipse object is located at the center point of the bounds, calculated by boundsSFCT. Note that the center point of the ILcdEllipse object is not taken into account.

When is an ILcdEllipse touched

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

Visually editing and creating an ILcd2DEditableEllipse

Modifying an ILcd2DEditableEllipse

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

• RESHAPED: the ellipse is reshaped, depending on whether one of the axis handles is touched. The image below illustrate the editing behavior. The small black arrow indicates the path of the mouse cursor while reshaping the ellipse.
  
  

  Moving an axis point.



• TRANSLATED: the whole ellipse 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 ellipse.
  
  

  Moving the contour.		Moving the interior.

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

Creating an ILcd2DEditableEllipse

When initializing an ellipse via interaction through the view, a number of user interactions are required to complete the initialization. This number depends on the creation mode and it is either 2 or 3 for the modes TWO_CLICK or THREE_CLICK.

Accepted snap targets

All points are accepted as snap target as long as:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BODY Constant value indicating that the body of the ellipse is touched.
static int	CENTER Constant value indicating that the center point of the ellipse is touched.
static int	CENTER_POINT Constant value indicating that the anchor point should be chosen as the center point of the ellipse.
static int	DEFAULT Constant for editing and selection painting modes, indicating that the painting mode for default (not selected and not edited) objects should be copied.
static int	FILLED Draw the ILcdEllipse object as a filled ellipse, only the area of the ellipse defined by the ILcdEllipse is painted.
static int	FOCUS_POINT Constant value indicating that the anchor point should be chosen as the focus point of the ellipse.
static int	MAJOR_RADIUS_CORNER Constant value indicating that the end point of the major axis of the ellipse is touched.
static int	MAJOR_RADIUS_OPPOSITE_CORNER Constant value indicating that the opposite end point of the major axis of the ellipse is touched.
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	MINOR_RADIUS_CORNER Constant value indicating that the end point of the minor axis of the ellipse is touched.
static int	MINOR_RADIUS_OPPOSITE_CORNER Constant value indicating that the opposite end point of the minor axis of the ellipse is touched.
static int	NOT_TOUCHED Constant value indicating that the ellipse is not touched.
static int	OUTLINED Draw the ILcdEllipse object as an outlined ellipse, only the contour of the ellipse defined by the ILcdEllipse is painted.
static int	OUTLINED_FILLED Draw the ILcdEllipse object as an outlined and filled ellipse, both the area and the contour of the ellipse defined by the ILcdEllipse are painted.
static int	THREE_CLICK Constant for the three click creation mode.
static int	TWO_CLICK Constant for the two click creation mode.

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

defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBounds

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

CREATING, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

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

CREATING, END_CREATION, RESHAPED, START_CREATION, TRANSLATED

Constructor Summary

Constructors

Constructor and Description
TLcdGXYEllipsePainter() Constructs a default TLcdGXYEllipsePainter and sets the display name to "Ellipse".

Method Summary

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.
protected void	boundsOfEditingLabelsSFCT(Graphics aGraphics, ILcdEllipse aEllipse, int aTouchedLocation, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) Called by the boundsSFCT method when editing an ILcd2DEditableEllipse.
void	boundsSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) Computes the bounds of the representation of an ILcdEllipse in AWT coordinates.
Object	clone() Makes Object.clone() public.
boolean	edit(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext) This implementation edits the ILcdEllipse object set to the painter.
int	getAnchorPointLocation() Returns the location of the anchor point (by default: MIDDLE_OF_BOUNDS).
int	getCreationClickCount() Returns either 2 or 3 depending on the creation mode (TWO_CLICK or THREE_CLICK) 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.
int	getEditingMode() Deprecated. Use ALcdGXYAreaPainter.getEditMode() instead.
ILcdGXYEditor	getGXYEditor(Object aObject) Returns this instance as editor for editing the specified Object.
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.
ILcdIcon	getSnapIcon() Returns the icon that is used to paint snap target points of the object set to this painter.
boolean	isDrawCenter() Returns whether the center point of the ellipse should be displayed.
boolean	isDrawCenterWhenSelected() Returns whether the center point of the ellipse should be displayed when it is painted in selected mode.
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 axis handles or the center point of the ellipse 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.
protected void	paintEditingLabels(Graphics aGraphics, ILcdEllipse aEllipse, int aTouchedLocation, ILcdGXYContext aGXYContext) Called by the paint method when editing an ILcd2DEditableEllipse.
void	setAnchorPointLocation(int aAnchorPointLocation) Sets the preferred anchor point location.
void	setCreationMode(int aCreationMode) Sets the mode to decide how to create an ILcdEllipse object.
void	setDrawCenter(boolean aDrawCenter) Sets whether the center point of the ellipse should be displayed or not.
void	setDrawCenterWhenSelected(boolean aDrawCenterWhenSelected) Sets whether the center point of the ellipse should be displayed when it is painted in selected mode or not.
void	setEditingMode(int aEditingMode) Deprecated. Use ALcdGXYAreaPainter.setEditMode(int) instead.
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	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, Object aObject, int aRenderMode, ILcdGXYContext aGXYContext) Called just before filling ellipses on the specified Graphics object.
protected void	setupGraphicsForLine(Graphics aGraphics, Object aObject, 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 ILcdEllipse 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.ILcdGXYPainter

getDisplayName

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

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

getDisplayName

Field Detail

OUTLINED

public static final int OUTLINED

Draw the ILcdEllipse object as an outlined ellipse, only the contour of the ellipse defined by the ILcdEllipse is painted.

See Also:

Constant Field Values

FILLED

public static final int FILLED

Draw the ILcdEllipse object as a filled ellipse, only the area of the ellipse defined by the ILcdEllipse is painted.

See Also:

Constant Field Values

OUTLINED_FILLED

public static final int OUTLINED_FILLED

Draw the ILcdEllipse object as an outlined and filled ellipse, both the area and the contour of the ellipse defined by the ILcdEllipse are painted.

See Also:

Constant Field Values

DEFAULT

public static final int DEFAULT

Constant for editing and selection painting modes, indicating that the painting mode for default (not selected and not edited) objects should be copied. This avoids having to set all modes separately.

See Also:

Constant Field Values

NOT_TOUCHED

public static final int NOT_TOUCHED

Constant value indicating that the ellipse is not touched.

See Also:

Constant Field Values

CENTER

public static final int CENTER

Constant value indicating that the center point of the ellipse is touched.

See Also:

Constant Field Values

BODY

public static final int BODY

Constant value indicating that the body of the ellipse is touched.

See Also:

Constant Field Values

MAJOR_RADIUS_CORNER

public static final int MAJOR_RADIUS_CORNER

Constant value indicating that the end point of the major axis of the ellipse is touched.

See Also:

ILcdEllipse.MAJOR_RADIUS_CORNER, Constant Field Values

MINOR_RADIUS_CORNER

public static final int MINOR_RADIUS_CORNER

Constant value indicating that the end point of the minor axis of the ellipse is touched.

See Also:

ILcdEllipse.MINOR_RADIUS_CORNER, Constant Field Values

MAJOR_RADIUS_OPPOSITE_CORNER

public static final int MAJOR_RADIUS_OPPOSITE_CORNER

Constant value indicating that the opposite end point of the major axis of the ellipse is touched.

See Also:

ILcdEllipse.MAJOR_RADIUS_OPPOSITE_CORNER, Constant Field Values

MINOR_RADIUS_OPPOSITE_CORNER

public static final int MINOR_RADIUS_OPPOSITE_CORNER

Constant value indicating that the opposite end point of the minor axis of the ellipse is touched.

See Also:

ILcdEllipse.MINOR_RADIUS_OPPOSITE_CORNER, Constant Field Values

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 ellipse. 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 ellipse. If this point cannot be calculated, the MIDDLE_OF_BOUNDS method is used to calculate the anchor point.

See Also:

Constant Field Values

TWO_CLICK

public static final int TWO_CLICK

Constant for the two click creation mode. The clicks define:

1. the position of the center point, and
2. the semi-major axis, semi-minor axis length and the rotation angle of the ellipse.

The semi-major and semi-minor axes are equal.

See Also:

setCreationMode(int), Constant Field Values

THREE_CLICK

public static final int THREE_CLICK

Constant for the three click creation mode. The clicks define:

1. the position of the center point,
2. the semi-major axis length and the rotation angle of the ellipse, and
3. the semi-minor axis length.

See Also:

setCreationMode(int), Constant Field Values

Constructor Detail

TLcdGXYEllipsePainter

public TLcdGXYEllipsePainter()

Constructs a default TLcdGXYEllipsePainter and sets the display name to "Ellipse".

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 ILcdEllipse for painting and an instance of ILcd2DEditableEllipse 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 ILcdEllipse 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 ILcd2DEditableEllipse, 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 ILcdEllipse.

See Also:

getObject()

getObject

public 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)

setEditingMode

public void setEditingMode(int aEditingMode)

Deprecated. Use ALcdGXYAreaPainter.setEditMode(int) instead.

getEditingMode

public int getEditingMode()

Deprecated. Use ALcdGXYAreaPainter.getEditMode() instead.

setCreationMode

public void setCreationMode(int aCreationMode)

Sets the mode to decide how to create an ILcdEllipse object. An ellipse can be created in the following modes. The default value is TWO_CLICK.

• TWO_CLICK, which enables setting the center point, the axis length and the rotation angle, or
• THREE_CLICK, which enables setting the center point, the semi-major axis length and the rotation angle, and the semi-minor axis length.

Parameters:

aCreationMode - The mode deciding how to create an ILcdEllipse 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)

setDrawCenter

public void setDrawCenter(boolean aDrawCenter)

Sets whether the center point of the ellipse 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 ellipse should be displayed.

Returns:

whether the center point of the ellipse should be displayed.

See Also:

setDrawCenter(boolean)

setDrawCenterWhenSelected

public void setDrawCenterWhenSelected(boolean aDrawCenterWhenSelected)

Sets whether the center point of the ellipse 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 ellipse should be displayed when it is painted in selected mode.

Returns:

whether the center point of the ellipse should be displayed when it is painted in selected mode.

See Also:

setDrawCenterWhenSelected(boolean)

setSnapToInvisiblePoints

public void setSnapToInvisiblePoints(boolean aSnapToInvisiblePoints)

Sets whether the other shapes can snap to invisible points of this shape. For an ILcdEllipse object, there's only one invisible point, being the center point of the ellipse 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)

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,
                                    Object aObject,
                                    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.

aObject - The object to paint.

aRenderMode - The mode to render the object in.

aGXYContext - The context to render the object in.

setupGraphicsForFill

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

Called just before filling ellipses 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.

aObject - The object to paint.

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. The object is rendered as shown in the images of the class documentation.

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

paintEditingLabels

protected void paintEditingLabels(Graphics aGraphics,
                                  ILcdEllipse aEllipse,
                                  int aTouchedLocation,
                                  ILcdGXYContext aGXYContext)

Called by the paint method when editing an ILcd2DEditableEllipse. It draws labels indicating the values of properties being changed. For example, the coordinates of the center point of the ellipse, the major or minor axis extent, the rotation angle, etc ... This method is empty and therefore does not draw the labels but it can be redefined for specific needs.

The aTouchedLocation argument indicates which part of the ellipse is being edited. For example, MAJOR_RADIUS_CORNER corresponds to the end point of the major axis of the ellipse. It should be one of the following constants: CENTER, BODY, MAJOR_RADIUS_CORNER, MINOR_RADIUS_CORNER, MAJOR_RADIUS_OPPOSITE_CORNER, MINOR_RADIUS_OPPOSITE_CORNER

Parameters:

aGraphics - The graphics to paint the object on.

aEllipse - The ellipse that is being edited.

aTouchedLocation - The part of the ellipse that is being edited.

aGXYContext - The context to render the object in.

boundsSFCT

public void boundsSFCT(Graphics aGraphics,
                       int aRenderMode,
                       ILcdGXYContext aGXYContext,
                       ILcd2DEditableBounds aBoundsSFCT)
                throws TLcdNoBoundsException

Computes the bounds of the representation of an ILcdEllipse 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

boundsOfEditingLabelsSFCT

protected void boundsOfEditingLabelsSFCT(Graphics aGraphics,
                                         ILcdEllipse aEllipse,
                                         int aTouchedLocation,
                                         ILcdGXYContext aGXYContext,
                                         ILcd2DEditableBounds aBoundsSFCT)

Called by the boundsSFCT method when editing an ILcd2DEditableEllipse. It calculates the bounds of the labels indicating the values of properties being changed. For example, the coordinates of the center point of the ellipse, the major or minor axis extent, the rotation angle, etc ... Since by default, no labels are painted, this implementation is empty and the aBoundsSFCT argument remains unchanged.

Note that the ILcd2DEditableBounds object already contains the bounds of the edited object. Upon exit of this method, this object should be set to the union of the bounds of the edited object and the labels painted while editing.

The aTouchedLocation argument indicates which part of the ellipse is being edited. For example, MAJOR_RADIUS_CORNER corresponds to the end point of the major axis of the ellipse. It should be one of the following constants: CENTER, BODY, MAJOR_RADIUS_CORNER, MINOR_RADIUS_CORNER, MAJOR_RADIUS_OPPOSITE_CORNER, MINOR_RADIUS_OPPOSITE_CORNER

Parameters:

aGraphics - The graphics to paint the object on.

aEllipse - The ellipse that is being edited.

aTouchedLocation - The part of the ellipse that is being edited.

aGXYContext - The context to render the object in.

aBoundsSFCT - The bounds in view coordinates to be updated.

isTouched

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

Depending on the rendering mode, returns whether the contour, the axis handles or the center point of the ellipse is touched. Note that the center point can only be touched if it is painted. 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, the axis handles or the center point of the ellipse is touched.

See Also:

boundsSFCT

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

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.

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.

edit

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

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

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

• While touching an axis handle, the object gets translated as a whole.
• While touching the center point, the object gets translated as a whole.
• While touching the contour, the object gets translated as a whole.

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

• While touching an axis handle, the length of the corresponding axis will change. Also the rotation angle of the axis will be affected.

The creation render mode behavior is defined by the creation mode. Further changes have to be done within edition mode.

• In the TWO_CLICK mode, the first point determines the center point of the ellipse and the second the axis length and the rotation angle of the ellipse.
• In the THREE_CLICK mode, the first point determines the center point of the ellipse, the second the semi-major axis length and the rotation angle of the ellipse, and the third the length of the semi-minor axis of the ellipse.

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

See Also:

ILcdGXYContext, acceptSnapTarget

getCreationClickCount

public int getCreationClickCount()

Returns either 2 or 3 depending on the creation mode (TWO_CLICK or THREE_CLICK) as the number of required user interactions.

Specified by:

getCreationClickCount in interface ILcdGXYEditor

Returns:

either 2 or 3 depending on the creation mode.

See Also:

setCreationMode(int)

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 ILcd2DEditableEllipse.
• 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.
• One of the axis corner points or the center point is touched or when both minor and major axis are 0. This enables snapping when creating an ellipse.

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)

snapTarget

public Object snapTarget(Graphics aGraphics,
                         ILcdGXYContext aGXYContext)

Returns the center point of the ILcdEllipse 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 ILcdEllipse if it is touched, null otherwise.

See Also:

supportSnap

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.

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()