Class TLcdGXYClippingPainterWrapper
- All Implemented Interfaces:
ILcdCloneable
,ILcdPropertyChangeSource
,ILcdGXYPainter
,ILcdGXYPainterProvider
,Serializable
,Cloneable
painter
which limits the painted region to an area delimited by a certain
set of shapes. Two modes are supported, configurable through setClipMode(ClipMode)
:
- An inclusive mode (default): only content inside the clipping shapes gets painted.
- An exclusive mode: only content outside the clipping shapes gets painted.
Clipping shapes are combined using the even-odd rule, which allows you to create holes and islands in clipping shapes.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The clipping mode, which indicates how the clipping shapes are used to determine the region to be painted. -
Field Summary
Fields inherited from interface com.luciad.view.gxy.ILcdGXYPainter
BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING
-
Constructor Summary
ConstructorDescriptionTLcdGXYClippingPainterWrapper
(ILcdGXYPainterProvider aGXYPainterProvider, ILcdModel aClipModel) Creates a new painter that clips the content of the painters provided by the given painter provider to the given model.TLcdGXYClippingPainterWrapper
(ILcdGXYPainter aDelegate, ILcdModel aClipModel) Creates a new painter that clips the content of the given painter to the given model. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPropertyChangeListener
(PropertyChangeListener aPropertyChangeListener) Registers the givenPropertyChangeListener
to be notified when this object's properties change.void
anchorPointSFCT
(Graphics aGraphics, int i, ILcdGXYContext aILcdGXYContext, Point aPoint) Moves the Point passed to the location (in view coordinates, pixels) of the anchor point of the representation of the object in the given mode taking into account the given context.void
boundsSFCT
(Graphics aGraphics, int aMode, ILcdGXYContext aILcdGXYContext, ILcd2DEditableBounds aILcd2DEditableBounds) 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.clone()
MakesObject.clone()
public.Returns the clip mode.Returns the model that is used for clipping the painted region.Returns the pen that is used for transforming the elements of the clip model.getCursor
(Graphics aGraphics, int i, ILcdGXYContext aILcdGXYContext) Returns a cursor that clarifies the mode and context the painter is operating in.Returns theILcdGXYPainter
to which the object rendering is delegated.Returns theILcdGXYPainterProvider
which is used to retrieve painters to delegate the object rendering to.Returns a textual representation of this painter.Finds anILcdGXYPainter
that can be used to paint or locate the object passed.Returns the Object for which the representation is currently being handled by this painter.boolean
isTouched
(Graphics aGraphics, int i, ILcdGXYContext aILcdGXYContext) 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 aMode, ILcdGXYContext aILcdGXYContext) Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.void
removePropertyChangeListener
(PropertyChangeListener aPropertyChangeListener) De-registers the givenPropertyChangeListener
from receiving property change events for this object.void
Sets the clip mode, which indicates how the clipping shapes are used to determine the region to be painted.void
setClipPen
(ILcdGXYPen aClipPen) Sets the pen that is used for transforming the elements of the clip model.void
Sets the Object for which the representation shall be handled by this painter.snapTarget
(Graphics aGraphics, ILcdGXYContext aILcdGXYContext) Returns an object that can be used as snapping target when graphically editing an object.boolean
supportSnap
(Graphics aGraphics, ILcdGXYContext aILcdGXYContext) Returns whether the painter can provide a snap target based on the representation of the object in the given context.
-
Constructor Details
-
TLcdGXYClippingPainterWrapper
Creates a new painter that clips the content of the given painter to the given model.Only the supported objects of the given model will be used for clipping.
By default, only content inside the clipping shapes gets painted. This behavior can be changed using
setClipMode(ClipMode)
.- Parameters:
aDelegate
- the painter whose content should be clippedaClipModel
- the model of the clip region(s)
-
TLcdGXYClippingPainterWrapper
public TLcdGXYClippingPainterWrapper(ILcdGXYPainterProvider aGXYPainterProvider, ILcdModel aClipModel) Creates a new painter that clips the content of the painters provided by the given painter provider to the given model.Only the supported objects of the given model will be used for clipping.
By default, only content inside the clipping shapes gets painted. This behavior can be changed using
setClipMode(ClipMode)
.- Parameters:
aGXYPainterProvider
- a painter provideraClipModel
- the model of the clip region(s)
-
-
Method Details
-
getClipModel
Returns the model that is used for clipping the painted region.- Returns:
- the model
-
getClipPen
Returns the pen that is used for transforming the elements of the clip model. The default pen does not use a straight line approximation (seeTLcdGeodeticPen.isStraightLineMode()
andTLcdGridPen.isStraightLineMode()
). Using a pen that does use such an approximation can improve the clipping performance (seeTLcdGXYPen
).- Returns:
- the pen
- See Also:
-
setClipPen
Sets the pen that is used for transforming the elements of the clip model.- Parameters:
aClipPen
- the pen
-
getClipMode
Returns the clip mode. By default,TLcdGXYClippingPainterWrapper.ClipMode.INCLUSIVE
is returned.- Returns:
- the clip mode that is used for the clipping shapes
- Since:
- 2023.1
- See Also:
-
setClipMode
Sets the clip mode, which indicates how the clipping shapes are used to determine the region to be painted.- Parameters:
aClipMode
- the clip mode to be used for the clipping shapes- Since:
- 2023.1
- See Also:
-
getDelegatePainter
Returns theILcdGXYPainter
to which the object rendering is delegated.- Returns:
- the
ILcdGXYPainter
to which the object rendering is delegated.
-
getDelegatePainterProvider
Returns theILcdGXYPainterProvider
which is used to retrieve painters to delegate the object rendering to.- Returns:
- the
ILcdGXYPainterProvider
which is used to retrieve painters to delegate the object rendering to.
-
setObject
Description copied from interface:ILcdGXYPainter
Sets the Object for which the representation shall be handled by this painter.Setting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.
When the object is set to a painter, the context parameter in subsequent calls to methods in this class must contain a layer that contains this object and for which the painter for this object is this painter.
- Specified by:
setObject
in interfaceILcdGXYPainter
- Parameters:
aObject
- the object for which the representation shall be handled by this painter.- See Also:
-
getObject
Description copied from interface:ILcdGXYPainter
Returns the Object for which the representation is currently being handled by this painter.- Specified by:
getObject
in interfaceILcdGXYPainter
- Returns:
- the Object for which the representation is currently being handled by this painter.
- See Also:
-
paint
Description copied from interface:ILcdGXYPainter
Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.The visual representation of an object depends on the context. Depending on the context (e.g. is the location covered by the view), an object may or may not have a representation. The context contains:
- transformations which allow to compute the location in view space of points and bounds given in model, space
- a pen which can connect points with a line or create arcs around a point,
- the view for which the object's representation must be painted. This can be useful when the painted object depends on the scale of the view, or the presence of other layers in the view.
- the current location(s) of the mouse or input device and the last location(s) the mouse or input device was pressed.
The mode passed in this method indicates what part of the object must be painted, whether it should be painted as selected or not, and whether user interaction (via mouse movements) must be taken into account.
When the mode passed contains either TRANSLATING, RESHAPING or CREATING, this method is also responsible for interpreting interaction on the representation of an object and modifying the representation of the object accordingly. The painter is not responsible for modifying the object itself, this is done by a corresponding
ILcdGXYEditor
. Implementations ofILcdGXYPainter
andILcdGXYEditor
interfaces must be consistent for an object: the painter must display the result of the user interaction on the object, while the editor is responsible for modifying the object as a result of the user interaction. A good practice to ensure a consistent implementation is to implement both theILcdGXYPainter
andILcdGXYEditor
interfaces in a single class.When the mode passed includes SNAPS, the part of the representation which corresponds to the object returned as snap target by the method
snapTarget
must be painted in order to provide the user with a visual indication of the snap target.The Graphics passed in this method can be different from the Graphics returned by a view due to techniques such as double buffering (as applied in Swing). Basic drawing operations must always be performed on the Graphics passed as an argument in this method.
- Specified by:
paint
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedaMode
- the mode the object is represented in (see class documentation).aILcdGXYContext
- theILcdGXYContext
the drawing depends on.
-
boundsSFCT
public void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aILcdGXYContext, ILcd2DEditableBounds aILcd2DEditableBounds) throws TLcdNoBoundsException Description copied from interface:ILcdGXYPainter
Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object in the given mode taking into account the given context.If this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.
The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model space for
ILcdBounded
objects.- Specified by:
boundsSFCT
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedaMode
- the mode the object is represented in (see class documentation). For example, an object may be represented differently in SELECTED mode compared to DEFAULT mode. The returned bounds of the representation must take this different representation into account.aILcdGXYContext
- 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.aILcd2DEditableBounds
- the bounds that must be adapted to encompass the representation of the object in the given mode and context. These bounds must not be taken into account when the method has thrown an exception.- Throws:
TLcdNoBoundsException
- if no bounds can be determined for the representation of the object. This can happen when the object does not have a representation in the given context, for example when it is located in a part of the world which is not visible in the current view.- See Also:
-
isTouched
Description copied from interface:ILcdGXYPainter
Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.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()
andILcdGXYContext.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 methodsILcdGXYContext.getDeltaX()
andILcdGXYContext.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:- transform the location of the interaction back to model space and compare the coordinates with the object in model space.
- transform the location to world space and compare with a world representation of the object. This forces the painter into caching a world representation of the object. Caching a view representation of an object is not very practical as it would have to change whenever the view's scale changes or when it is panned. A world representation of an object only changes when the view's XYWorldReference changes, which happens less frequently.
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.
- Specified by:
isTouched
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedi
- the mode the object is represented inaILcdGXYContext
- contains the location of the interaction and the transformations to convert this location into model coordinates- Returns:
- true if the representation of the object in the given mode is touched by the location as defined in the context passed, false otherwise
- See Also:
-
anchorPointSFCT
public void anchorPointSFCT(Graphics aGraphics, int i, ILcdGXYContext aILcdGXYContext, Point aPoint) throws TLcdNoBoundsException Description copied from interface:ILcdGXYPainter
Moves the Point passed to the location (in view coordinates, pixels) of the anchor point of the representation of the object in the given mode taking into account the given context.The anchor point is an important point of the representation, typically the point which would be used when the object would be represented as a single point. The anchor point is mostly used to attach extra information to the representation of an object, for example, using labels. A typical implementation of this method for painters which can handle
ILcdShape
objects is the location of the focus point of the shape.- Specified by:
anchorPointSFCT
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedi
- the mode the object is painted in (see class documentation)aILcdGXYContext
- 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.aPoint
- 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:
-
supportSnap
Description copied from interface:ILcdGXYPainter
Returns whether the painter can provide a snap target based on the representation of the object in the given context.- Specified by:
supportSnap
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedaILcdGXYContext
- the context in which this object is represented and in which the editing of an object occurs.- Returns:
- true if an object can be returned that can be used to snap to in the given context, false otherwise.
-
snapTarget
Description copied from interface:ILcdGXYPainter
Returns an object that can be used as snapping target when graphically editing an object. For example, an object which is beneath the current mouse position (as given in the context).This method must only be called when
supportSnap
returns true for the given context.- Specified by:
snapTarget
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedaILcdGXYContext
- the context in which this object is represented and in which the editing of an object occurs.- Returns:
- an object that can be used as snapping target when graphically editing an object. It must be defined in the same model reference as the object set to this painter.
- See Also:
-
getCursor
Description copied from interface:ILcdGXYPainter
Returns a cursor that clarifies the mode and context the painter is operating in. For example, when the mode isTRANSLATING
, the cursor could be the MOVE cursor. When no specific cursor is required implementations must return null.- Specified by:
getCursor
in interfaceILcdGXYPainter
- Parameters:
aGraphics
- the Graphics on which the representation of the object is paintedi
- the rendering mode to return the cursor for.aILcdGXYContext
- the context in which the rendering occurs.- Returns:
- a
Cursor
to indicate the type of operatingaMode
andaGXYContext
. Returnsnull
if no particularCursor
is required.
-
getDisplayName
Description copied from interface:ILcdGXYPainter
Returns a textual representation of this painter. This can be useful when different representations of an object are handled by different painter implementations. Having a textual representation can facilitate choosing between different painter implementations.- Specified by:
getDisplayName
in interfaceILcdGXYPainter
- Returns:
- a textual representation of this painter.
-
addPropertyChangeListener
Description copied from interface:ILcdPropertyChangeSource
Registers the given
PropertyChangeListener
to be notified when this object's properties change.In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a
ALcdWeakPropertyChangeListener
instance as property change listener.- Specified by:
addPropertyChangeListener
in interfaceILcdPropertyChangeSource
- Parameters:
aPropertyChangeListener
- The listener to be notified- See Also:
-
removePropertyChangeListener
Description copied from interface:ILcdPropertyChangeSource
De-registers the given
PropertyChangeListener
from receiving property change events for this object.If the listener was added more than once, it will be notified one less time after being removed. If the listener is
null
, or was never added, no exception is thrown and no action is taken.- Specified by:
removePropertyChangeListener
in interfaceILcdPropertyChangeSource
- Parameters:
aPropertyChangeListener
- the listener that should no longer be notified of changes of this object's properties- See Also:
-
clone
Description copied from interface:ILcdCloneable
Makes
When for example extending fromObject.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 ); } }
- Specified by:
clone
in interfaceILcdCloneable
- Specified by:
clone
in interfaceILcdGXYPainterProvider
- Overrides:
clone
in classObject
- Returns:
- a clone of this painter provider.
- See Also:
-
getGXYPainter
Description copied from interface:ILcdGXYPainterProvider
Finds anILcdGXYPainter
that can be used to paint or locate the object passed.The painter provider is responsible for setting the object to the painter before returning the painter. An implementation should therefore have the following structure:
public ILcdGXYPainter getGXYPainter(Object aObject) { ILcdGXYPainter painter = ... // find the painter for the object if (painter != null) { painter.setObject(aObject); } return painter; }
- Specified by:
getGXYPainter
in interfaceILcdGXYPainterProvider
- Parameters:
o
- the object to find a painter for- Returns:
- a painter that can be used to paint or locate the object; or null if no painter could be found for the given object, or the object could not be set on the retrieved painter.
-