com.luciad.format.dgn.gxy

Infrastructure StandardsClass TLcdDGNCellGXYPainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYPainter

com.luciad.format.dgn.gxy.TLcdDGNCellGXYPainter

All Implemented Interfaces:

ILcdCloneable, ILcdDeepCloneable, ILcdPropertyChangeSource, ILcdGXYPainter, ILcdGXYPainterProvider, Serializable, Cloneable

public class TLcdDGNCellGXYPainter
extends ALcdGXYPainter
implements ILcdGXYPainter, ILcdDeepCloneable

This is an implementation of ILcdGXYPainter that accepts a TLcdDGNCell for painting on an ILcdGXYView.

The painter delegates the painting of the cell elements to painters returned by the shapeGXYPainterProvider.

If any cells contain holes, the painter paints these with the help of an internal buffer. This requires additional memory and computation time. If resources are scarce and holes may be filled, the handleHoles flag can be set to false. The default value is true.

Sometimes cells contain holes, but the cell elements aren't filled. The cells can then be painted quickly, without any special handling. If the internal buffer should be used anyway (e.g. because the shape painters wish to ignore the filled flags), the handleUnfilledHoles flag can be set to true. The default value is false. The flag is only taken into account if the basic handleHoles flag is set to true.

See Also:

Serialized Form

Field Summary

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

defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBounds

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

BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

Constructor Summary

Constructors

Constructor and Description
TLcdDGNCellGXYPainter() Creates an uninitialized TLcdDGNCellGXYPainter.
TLcdDGNCellGXYPainter(ILcdGXYPainterProvider aShapeGXYPainterProvider) Creates a TLcdDGNCellGXYPainter that delegates painting of the cell's shapes to the painters provided by the given painter provider.

Method Summary

Modifier and Type	Method and Description
void	anchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT) Implements ILcdGXYPainter.anchorPointSFCT.
void	boundsSFCT(Graphics aGraphics, int aMode, 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.
Cursor	getCursor(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Override this method to return a cursor.
Object	getObject() Returns the Object for which the representation is currently being handled by this painter.
ILcdGXYPainterProvider	getShapeGXYPainterProvider() Returns the painter provider whose painters are used for painting the cell's shapes.
boolean	isHandleHoles() Returns whether holes are painted.
boolean	isHandleUnfilledHoles() Returns whether unfilled holes are painted as holes.
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 aMode, ILcdGXYContext aGXYContext) Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.
void	setHandleHoles(boolean aHandleHoles) Specifies whether to paint holes.
void	setHandleUnfilledHoles(boolean aHandleUnfilledHoles) Specifies whether to paint holes, even if they are not filled.
void	setObject(Object aObject) Sets the Object for which the representation shall be handled by this painter.
void	setShapeGXYPainterProvider(ILcdGXYPainterProvider aShapeGXYPainterProvider) Sets the painter provider whose painters will be used for painting the cell's shapes.
Object	snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext) Override this method to support snapping.
boolean	supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext) Override this method to support snapping.

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

addPropertyChangeListener, firePropertyChangeEvent, firePropertyChangeEvent, getDisplayName, getGXYPainter, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOn

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

Constructor Detail

TLcdDGNCellGXYPainter

public TLcdDGNCellGXYPainter()

Creates an uninitialized TLcdDGNCellGXYPainter.

TLcdDGNCellGXYPainter

public TLcdDGNCellGXYPainter(ILcdGXYPainterProvider aShapeGXYPainterProvider)

Creates a TLcdDGNCellGXYPainter that delegates painting of the cell's shapes to the painters provided by the given painter provider.

Method Detail

setShapeGXYPainterProvider

public void setShapeGXYPainterProvider(ILcdGXYPainterProvider aShapeGXYPainterProvider)

Sets the painter provider whose painters will be used for painting the cell's shapes.

getShapeGXYPainterProvider

public ILcdGXYPainterProvider getShapeGXYPainterProvider()

Returns the painter provider whose painters are used for painting the cell's shapes.

setHandleHoles

public void setHandleHoles(boolean aHandleHoles)

Specifies whether to paint holes.

isHandleHoles

public boolean isHandleHoles()

Returns whether holes are painted. The default is true.

setHandleUnfilledHoles

public void setHandleUnfilledHoles(boolean aHandleUnfilledHoles)

Specifies whether to paint holes, even if they are not filled. This may be useful in the context of custom painter styles. The default is false.

isHandleUnfilledHoles

public boolean isHandleUnfilledHoles()

Returns whether unfilled holes are painted as holes.

setObject

public void setObject(Object aObject)

Description copied from interface: ILcdGXYPainter

Sets the Object for which the representation shall be handled by this painter.

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

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

Specified by:

setObject in interface ILcdGXYPainter

Parameters:

aObject - the object for which the representation shall be handled by this painter.

See Also:

ILcdGXYPainter.getObject()

getObject

public final Object getObject()

Description copied from interface: ILcdGXYPainter

Returns the Object for which the representation is currently being handled by this painter.

Specified by:

getObject in interface ILcdGXYPainter

Returns:

the Object for which the representation is currently being handled by this painter.

See Also:

ILcdGXYPainter.setObject(Object)

paint

public void paint(Graphics aGraphics,
                  int aMode,
                  ILcdGXYContext aGXYContext)

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 of ILcdGXYPainter and ILcdGXYEditor 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 the ILcdGXYPainter and ILcdGXYEditor 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 interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in (see class documentation).

aGXYContext - the ILcdGXYContext the drawing depends on.

isTouched

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

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

• 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 interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the mode the object is represented in

aGXYContext - 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:

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

supportSnap

public boolean supportSnap(Graphics aGraphics,
                           ILcdGXYContext aGXYContext)

Description copied from class: ALcdGXYPainter

Override this method to support snapping. This implementation does not support snapping.

Specified by:

supportSnap in interface ILcdGXYPainter

Overrides:

supportSnap in class ALcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aGXYContext - the context in which this object is represented and in which the editing of an object occurs.

Returns:

false.

snapTarget

public Object snapTarget(Graphics aGraphics,
                         ILcdGXYContext aGXYContext)

Description copied from class: ALcdGXYPainter

Override this method to support snapping. This implementation does not support snapping.

Specified by:

snapTarget in interface ILcdGXYPainter

Overrides:

snapTarget in class ALcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aGXYContext - the context in which this object is represented and in which the editing of an object occurs.

Returns:

null.

See Also:

supportSnap

boundsSFCT

public void boundsSFCT(Graphics aGraphics,
                       int aMode,
                       ILcdGXYContext aGXYContext,
                       ILcd2DEditableBounds aBoundsSFCT)
                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 interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

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

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.

aBoundsSFCT - 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

getCursor

public Cursor getCursor(Graphics aGraphics,
                        int aMode,
                        ILcdGXYContext aGXYContext)

Description copied from class: ALcdGXYPainter

Override this method to return a cursor. This implementation returns null.

Specified by:

getCursor in interface ILcdGXYPainter

Overrides:

getCursor in class ALcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aMode - the rendering mode to return the cursor for.

aGXYContext - the context in which the rendering occurs.

Returns:

null.

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 ILcdGXYPainterProvider

Overrides:

clone in class ALcdGXYPainter

Returns:

a clone of this painter provider.

See Also:

Object.clone()

clone

public Object clone(Map aObjectDictionary)

Description copied from interface: ILcdDeepCloneable

Returns a deep clone of this Object.

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

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

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

In addition, the following conditions should also hold:

• If a clone of this Object already exists in the object dictionary before this clone method is called, this method shall return that clone:

  aObjectDictionary.get(this) == null || aObjectDictionary.get(this) == this.clone(aObjectDictionary)

• The object dictionary shall contain the resulting clone, after this clone method has completed:

  this.clone(aObjectDictionary) == aObjectDictionary.get(this)

Specified by:

clone in interface ILcdDeepCloneable

Parameters:

aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.

Returns:

a deep clone of this Object that fulfills the conditions described above.