public class TLcdGXYCompositeRingPainter extends ALcdGXYAreaPainter implements ILcdGXYPathPainter, ILcdGXYEditor, ILcdGXYEditorProvider, ILcdDeepCloneable
ILcdCompositeCurve
and ILcdRing
,
and enables visual editing of editable composite ring objects, i.e. objects that are of type
ILcdEditableCompositeCurve
and
ILcdRing
, in an ILcdGXYView
.
This painter provides support for painting a composite ring object. For each curve of the composite ring,
a painter is retrieved via the set
painter provider
.. The retrieved painter is then used
to paint the corresponding ILcdCurve
object.
Note that this implementation assumes that a painter can be provided for each curve of the composite ring.
Also, the painter must implement ILcdGXYPathPainter
.
This painter does not define a handle for composite ring objects. However, the handles for
each individual ILcdCurve
object are defined by the corresponding painter for that curve.
This painter will process all ILcdCurve
objects in the composite ring object
and tries to retrieve a snap target for each curve using the corresponding painter. The first snap target
that is found, is used as snap target for this TLcdGXYCompositeRingPainter
.
The visualization of the composite ring object is governed by the line style, fill style,
and painter provider set to this painter. The painter provider
is responsible
for providing a painter
to be used for painting each of the individual
ILcdCurve
objects contained in the composite ring object.
When the composite ring object only contains one ILcdCurve
object, the anchor
point of that object is used as anchor point for the composite ring. If more ILcdCurve
objects
are available, the center point of the bounds, calculated by boundsSFCT
, is used.
The composite ring object is touched when one of the ILcdCurve
objects in the
composite ring is touched.
This implementation translates either the touched handle or the entire composite curve for
ILcdGXYEditor.TRANSLATED
, and translates the touched sub curve if the user drags with
ILcdGXYEditor.RESHAPED
. Note that this behavior relies on the sub curve painter's
isTouched
method to distinguish between touching
the curve body
and the handles
.
Other edit operations are passed onto the first touched sub curve that is successfully edited.
For every shape that has to be edited, an
editor is retrieved via the set editor provider
. The retrieved editor
is then used to edit the corresponding ILcdCurve
object.
Similarly to the painter provider, the editor provider
is responsible
for providing an editor
to be used for editing the individual
ILcdCurve
objects contained in the composite ring object.
Note that this implementation assumes that an editor can be provided for each shape of the composite ring.
When initializing an composite ring object via interaction through the view, only the last curve
object is edited. The number of user interactions required to complete the initialization is defined by the
editor corresponding to the last ILcdCurve
object.
This painter accepts a snap target if at least one of the curve editors returned by the curve editor provider accepts the snap target.
ILcdGXYPainter
,
ILcdGXYEditor
,
ALcdGXYPainter
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
FIRST_POSSIBLE_RING_ANCHOR_POINT
Constant value indicating that the anchor point should be chosen at the anchor point of the
first possible ring.
|
static int |
FOCUS_POINT
Constant value indicating that the anchor point should be chosen as the focus point of the
composite ring.
|
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 |
ONE_RING_ANCHOR_POINT
Constant value indicating that the anchor point should be chosen as the anchor point of the
only ring in the composite ring.
|
FILLED, OUTLINED, OUTLINED_FILLED
defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBounds
BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING
CREATING, END_CREATION, RESHAPED, START_CREATION, TRANSLATED
Constructor and Description |
---|
TLcdGXYCompositeRingPainter()
Constructs a default
TLcdGXYCompositeRingPainter and sets the display name to "CompositeRing". |
TLcdGXYCompositeRingPainter(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider,
ILcdGXYEditorProvider aCurveGXYEditorProvider)
Constructs a default
TLcdGXYCompositeRingPainter with the specified painter and editor,
and sets the display name to "CompositeRing". |
TLcdGXYCompositeRingPainter(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider,
ILcdGXYEditorProvider aCurveGXYEditorProvider,
ILcdCurveConnectorProvider aCurveConnectorProvider)
Constructs a default
TLcdGXYCompositeRingPainter with the specified painter, editor and
connector provider, and sets the display name to "CompositeRing". |
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 aRenderMode,
ILcdGXYContext aGXYContext,
Point aPointSFCT)
Moves the specified
aPointSFCT to the anchor point of the ILcdRing
object. |
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)
Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object
in the given mode taking into account the given context.
|
Object |
clone()
Makes
Object.clone() public. |
Object |
clone(Map aObjectDictionary)
Returns a deep clone of this Object.
|
boolean |
edit(Graphics aGraphics,
int aRenderMode,
ILcdGXYContext aGXYContext)
This implementation translates either the touched handle or the entire composite curve for
ILcdGXYEditor.TRANSLATED , and translates the touched sub curve if the user drags with
ILcdGXYEditor.RESHAPED . |
int |
getAnchorPointLocation()
Returns the location of the anchor point (by default: ONE_RING_ANCHOR_POINT).
|
int |
getCreationClickCount()
Returns the number of user interactions required to complete the initialization of the
ILcdRing object set to this editor. |
Cursor |
getCursor(Graphics aGraphics,
int aRenderMode,
ILcdGXYContext aGXYContext)
Returns a
Cursor that clarifies the render mode and context this painter is operating
in. |
ILcdCurveConnectorProvider |
getCurveConnectorProvider()
Returns the curve provider used to provider a curve connector for each shape inside the composite ring.
|
ILcdGXYEditorProvider |
getCurveGXYEditorProvider()
Returns the editor provider used to provide an editor for each shape inside the composite ring.
|
ILcdGXYPainterProvider<ILcdGXYPathPainter> |
getCurveGXYPainterProvider()
Returns the painter provider used to provide a painter for each shape inside the composite ring.
|
ILcdGXYEditor |
getGXYEditor(Object aObject)
Returns this instance as editor for editing the specified
Object . |
Object |
getObject()
Returns the Object for which the representation is currently being handled by this painter.
|
boolean |
getPaintCache()
Returns whether caching is used when painting this painter's object.
|
boolean |
isTouched(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Checks if the representation of the object in the given mode is touched at the location as defined in the
supplied context.
|
void |
paint(Graphics aGraphics,
int aRenderMode,
ILcdGXYContext aGXYContext)
Displays the representation of the object in the given mode on the Graphics passed, taking into
account the context passed.
|
void |
setAnchorPointLocation(int aAnchorPointLocation)
Sets the preferred anchor point location.
|
void |
setCurveConnectorProvider(ILcdCurveConnectorProvider aCurveConnectorProvider)
Sets a connector provider to ensure connectivity during editing operations.
|
void |
setCurveGXYEditorProvider(ILcdGXYEditorProvider aCurveGXYEditorProvider)
Sets the editor provider used to provide an editor for each shape inside the composite ring.
|
void |
setCurveGXYPainterProvider(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider)
Sets the painter provider used to provide a painter for each shape inside the composite ring.
|
void |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
void |
setPaintCache(boolean aPaintCache)
Turns caching of the representation of the object on or off.
|
Object |
snapTarget(Graphics aGraphics,
ILcdGXYContext aGXYContext)
Returns the first snap target that was found by the painters of the shapes inside the
composite ring object.
|
boolean |
supportSnap(Graphics aGraphics,
ILcdGXYContext aGXYContext)
Supports snapping when at least one of the painters of the shapes inside the composite ring
object supports snapping.
|
getEditMode, getFillStyle, getLineStyle, getMode, getSelectionMode, setEditMode, setFillStyle, setLineStyle, setMode, setSelectionMode
addPropertyChangeListener, firePropertyChangeEvent, firePropertyChangeEvent, getDisplayName, getGXYPainter, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOn
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDisplayName
addPropertyChangeListener, removePropertyChangeListener
getDisplayName
public static final int MIDDLE_OF_BOUNDS
boundsSFCT
.public static final int FOCUS_POINT
MIDDLE_OF_BOUNDS
method
is used.public static final int ONE_RING_ANCHOR_POINT
MIDDLE_OF_BOUNDS
method is used.public static final int FIRST_POSSIBLE_RING_ANCHOR_POINT
MIDDLE_OF_BOUNDS
method is used.public TLcdGXYCompositeRingPainter()
TLcdGXYCompositeRingPainter
and sets the display name to "CompositeRing".
The painter provider and the editor provider are not initialized and are required to be set using the
methods setCurveGXYPainterProvider(com.luciad.view.gxy.ILcdGXYPainterProvider)
and setCurveGXYEditorProvider(com.luciad.view.gxy.ILcdGXYEditorProvider)
respectively.
To ensure connectivity of the composite ring during editing operations,
an instance of TLcdDefaultCurveConnectorProvider
is used as ILcdCurveConnectorProvider
.
Custom implementations can be set through
setCurveConnectorProvider(com.luciad.shape.constraints.ILcdCurveConnectorProvider)
.
public TLcdGXYCompositeRingPainter(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider, ILcdGXYEditorProvider aCurveGXYEditorProvider)
TLcdGXYCompositeRingPainter
with the specified painter and editor,
and sets the display name to "CompositeRing".
To ensure connectivity of the composite ring during editing operations,
an instance of TLcdDefaultCurveConnectorProvider
is used as ILcdCurveConnectorProvider
.
Custom implementations can be set through
setCurveConnectorProvider(com.luciad.shape.constraints.ILcdCurveConnectorProvider)
.
aCurveGXYPainterProvider
- the painter provider for the ILcdCurve
objects
inside the composite ring object.aCurveGXYEditorProvider
- the editor provider for the ILcdCurve
objects
inside the composite ring object.public TLcdGXYCompositeRingPainter(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider, ILcdGXYEditorProvider aCurveGXYEditorProvider, ILcdCurveConnectorProvider aCurveConnectorProvider)
TLcdGXYCompositeRingPainter
with the specified painter, editor and
connector provider, and sets the display name to "CompositeRing".aCurveGXYPainterProvider
- the painter provider for the ILcdCurve
objects
inside the composite ring object.aCurveGXYEditorProvider
- the editor provider for the ILcdCurve
objects
inside the composite ring object.aCurveConnectorProvider
- the connector provider to ensure connectivity of the composite ring
during editing operations.public int getAnchorPointLocation()
MIDDLE_OF_BOUNDS
, FOCUS_POINT
, ONE_RING_ANCHOR_POINT
,
FIRST_POSSIBLE_RING_ANCHOR_POINT
.public void setAnchorPointLocation(int aAnchorPointLocation)
aAnchorPointLocation
- one of MIDDLE_OF_BOUNDS
, FOCUS_POINT
,
ONE_RING_ANCHOR_POINT
, FIRST_POSSIBLE_RING_ANCHOR_POINT
.public void paint(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
This implementation will retrieve a painter for all ILcdCurve
objects inside the
composite ring object using the set painter provider
and will use that painter to paint the corresponding shape.
paint
in interface ILcdGXYPainter
aGraphics
- The graphics to paint the object on.aRenderMode
- The mode to render the object in.aGXYContext
- The context to render the object in.public boolean isTouched(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainter
The location that must be taken into account to check whether the representation is touched can be retrieved from
the context passed with the methods
ILcdGXYContext.getX()
and ILcdGXYContext.getY()
.
If the check is part of an ongoing operation of
user interaction, for example, when the mouse is being dragged, the location of the start of the operation can also
be taken into account using the methods
ILcdGXYContext.getDeltaX()
and ILcdGXYContext.getDeltaY()
.
The context contains the transformations required to convert this location into the equivalent location in
model space. Implementations of this interface usually follow either of the following patterns:
As the mode influences the way an object is represented, it must also be taken into account when checking whether that representation is being touched. When the mode contains CREATING, RESHAPING or TRANSLATING which indicate that the object must be represented in a state for an ongoing operation, the location of the start of the operation may be taken into account as mentioned above. The painting result can take into account multiple locations, to respond to, for example, multi-touch input. When the mode contains SELECTED, the painter should also check if the non-selected representation is touched, since these are always painted on top of each other.
The boundsSFCT
is often used to speed up the performance of this method as a location outside these bounds can never
touch the representation of the object.
Note that this method does not give an indication of what part of the object is touched. It is up to the painter implementations to provide methods to make this distinction. The method does also not indicate what sensitivity must be applied when checking if an object is touched. It is up to the implementation to decide what should be the maximum distance between the location given in the context and the closest relevant point or area of the representation of the object.
isTouched
in interface ILcdGXYPainter
aGraphics
- the Graphics on which the representation of the object is paintedaMode
- the mode the object is represented inaGXYContext
- contains the location of the interaction and the transformations to convert this location into
model coordinatesboundsSFCT
public Cursor getCursor(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
Cursor
that clarifies the render mode and context this painter is operating
in. When no specific Cursor
is required, null
is returned.getCursor
in interface ILcdGXYPainter
getCursor
in class ALcdGXYPainter
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.null
if
no particular cursor is required.public ILcdGXYEditor getGXYEditor(Object aObject)
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.getGXYEditor
in interface ILcdGXYEditorProvider
aObject
- the object to be edited.Object
.public void setObject(Object aObject)
ILcdGXYPainter
Setting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.
When the object is set to a painter, the context parameter in subsequent calls to methods in this class must contain a layer that contains this object and for which the painter for this object is this painter.
setObject
in interface ILcdGXYEditor
setObject
in interface ILcdGXYPainter
aObject
- the object for which the representation shall be handled by this painter.ILcdGXYPainter.getObject()
public Object getObject()
ILcdGXYPainter
getObject
in interface ILcdGXYEditor
getObject
in interface ILcdGXYPainter
ILcdGXYPainter.setObject(Object)
public void setCurveGXYPainterProvider(ILcdGXYPainterProvider<ILcdGXYPathPainter> aCurveGXYPainterProvider)
aCurveGXYPainterProvider
- the painter provider for the ILcdCurve
objects
inside the composite ring object.getCurveGXYPainterProvider()
public ILcdGXYPainterProvider<ILcdGXYPathPainter> getCurveGXYPainterProvider()
setCurveGXYPainterProvider(com.luciad.view.gxy.ILcdGXYPainterProvider)
public void setCurveGXYEditorProvider(ILcdGXYEditorProvider aCurveGXYEditorProvider)
aCurveGXYEditorProvider
- the editor provider for the ILcdCurve
objects
inside the composite ring object.getCurveGXYEditorProvider()
public ILcdGXYEditorProvider getCurveGXYEditorProvider()
setCurveGXYEditorProvider(com.luciad.view.gxy.ILcdGXYEditorProvider)
public void setCurveConnectorProvider(ILcdCurveConnectorProvider aCurveConnectorProvider)
aCurveConnectorProvider
- a connector provider that returns a connector for the curve types encountered
in every composite ring.getCurveConnectorProvider()
public ILcdCurveConnectorProvider getCurveConnectorProvider()
setCurveConnectorProvider(com.luciad.shape.constraints.ILcdCurveConnectorProvider)
public void setPaintCache(boolean aPaintCache)
ILcdCache
. By default, caching
is turned on.aPaintCache
- A flag indicating whether to use caching when painting an object.getPaintCache()
public boolean getPaintCache()
true
if caching is used to paint this painter's object, false
otherwise.setPaintCache(boolean)
public boolean edit(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
This implementation translates either the touched handle or the entire composite curve for
ILcdGXYEditor.TRANSLATED
, and translates the touched sub curve if the user drags with
ILcdGXYEditor.RESHAPED
. Note that this behavior relies on the sub curve painter's
isTouched
method to distinguish between touching
the curve body
and the handles
.
Other edit operations are passed onto the first touched sub curve that is successfully edited.
For every shape that has to be edited, an
editor is retrieved via the set editor provider
. The retrieved editor
is then used to edit the corresponding ILcdCurve
object.
In the creation render modes, only the last ILcdCurve
object is edited.
edit
in interface ILcdGXYEditor
aGraphics
- The graphics to edit the object on.aRenderMode
- The mode to render the object in.aGXYContext
- The context to render the object in.ILcdGXYContext
,
acceptSnapTarget
public void anchorPointSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, Point aPointSFCT) throws TLcdNoBoundsException
Moves the specified aPointSFCT
to the anchor point of the ILcdRing
object. If the ring only contains one object, the anchor point of that object is used.
When more shapes are available in the composite ring, the center point of the bounds, calculated
by boundsSFCT
, is used
anchorPointSFCT
in interface ILcdGXYPainter
anchorPointSFCT
in class ALcdGXYPainter
aGraphics
- The graphics to paint the object on.aRenderMode
- The mode to render the object in.aGXYContext
- The context to render the object in.aPointSFCT
- The point that needs to be updated.TLcdNoBoundsException
- if the composite ring object doesn't have
a valid anchor point, e.g. if it is always invisible in the current projection.paint
public boolean supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)
Supports snapping when at least one of the painters of the shapes inside the composite ring object supports snapping.
supportSnap
in interface ILcdGXYPainter
supportSnap
in class ALcdGXYPainter
aGraphics
- the graphics on which is worked.aGXYContext
- the context of the snapping.true
if one of the painters for the shapes inside the composite ring
object supports snapping, false
otherwise.public Object snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)
Returns the first snap target that was found by the painters of the shapes inside the
composite ring object. If no point was touched, null
will be
returned.
snapTarget
in interface ILcdGXYPainter
snapTarget
in class ALcdGXYPainter
aGraphics
- the graphics on which is worked.aGXYContext
- the context of the snapping.null
otherwise.supportSnap
public void boundsSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
If this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.
The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model
space for ILcdBounded
objects.
boundsSFCT
in interface ILcdGXYPainter
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.TLcdNoBoundsException
- if no bounds can be determined for the representation of the object.
This can happen when the object does not have a representation in the given context, for example when it is located
in a part of the world which is not visible in the current view.isTouched
public int getCreationClickCount()
ILcdRing
object set to this editor. This method will return the number of user interactions
required by the editor corresponding to the last ILcdCurve
object.getCreationClickCount
in interface ILcdGXYEditor
ILcdCurve
object.public boolean acceptSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)
Determines whether a snap target should be accepted or not. A snap target is accepted if at least one of the curve editors returned by the curve editor provider accepts the snap target.
acceptSnapTarget
in interface ILcdGXYEditor
aGraphics
- the graphics on which the snap target should be checked.aGXYContext
- the context in which the snap target should be checked.true
if at least one of the curve editors returned by the curve editor provider
accepts the snap target, false
otherwise.ILcdGXYContext.getSnapTarget()
public boolean appendAWTPath(ILcdGXYContext aGXYContext, int aRenderMode, ILcdAWTPath aAWTPathSFCT)
ILcdGXYPathPainter
appendAWTPath
in interface ILcdGXYPathPainter
aGXYContext
- the graphics contextaRenderMode
- the rendering modeaAWTPathSFCT
- the path to append topublic boolean appendGeneralPath(ILcdGXYContext aGXYContext, int aRenderMode, ILcdGeneralPath aGeneralPathSFCT)
ILcdGXYPathPainter
appendGeneralPath
in interface ILcdGXYPathPainter
aGXYContext
- the graphics contextaRenderMode
- the rendering modeaGeneralPathSFCT
- the path to append topublic Object clone(Map aObjectDictionary)
ILcdDeepCloneable
java.util.Map
, using reference-equality instead of object-equality when
comparing keys (such as the java.util.IdentityHashMap
). It contains as keys the objects in the original
object graph that have already been cloned, and as values their corresponding clone.
The Object returned by this method should fulfill the following conditions, as specified in
the general Object.clone()
contract:
this.clone(aObjectDictionary) != this
this.clone(aObjectDictionary).getClass() == this.getClass()
this.clone(aObjectDictionary).equals(this)
clone
method is called,
this method shall return that clone:
aObjectDictionary.get(this) == null || aObjectDictionary.get(this) == this.clone(aObjectDictionary)
clone method has completed:
this.clone(aObjectDictionary) == aObjectDictionary.get(this)
clone
in interface ILcdDeepCloneable
aObjectDictionary
- the Object dictionary that keeps track of the objects for which a clone has already been made,
and their corresponding clone Object.public Object clone()
ILcdCloneable
Makes Object.clone()
public.
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 );
}
}
clone
in interface ILcdCloneable
clone
in interface ILcdGXYEditorProvider
clone
in interface ILcdGXYPainterProvider
clone
in class ALcdGXYAreaPainter
Object.clone()