public class TLcdShadedRasterPainter extends Object implements ILcdRasterPainter, ILcdGXYPainterProvider
BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING| Constructor and Description |
|---|
TLcdShadedRasterPainter(ILcdBuffer aBuffer)
Creates a shaded raster painter with a buffer for caching the shaded
rasters.
|
TLcdShadedRasterPainter(ILcdRasterPainter aRasterPainter,
ILcdBuffer aBuffer)
Creates a shaded raster painter with a buffer for caching the shaded
rasters and a painter for painting them.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)
Registers the given
PropertyChangeListener to be notified when this object's
properties change. |
void |
anchorPointSFCT(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext,
Point aPointSFCT)
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 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. |
float |
getBrightness() |
ColorModel |
getColorModel() |
Cursor |
getCursor(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Returns a cursor that clarifies the mode and context the painter is operating in.
|
String |
getDisplayName()
Returns a textual representation of this painter.
|
double |
getElevationExaggeration()
Returns the elevation exaggeration.
|
ILcdGXYPainter |
getGXYPainter(Object aObject)
Finds an
ILcdGXYPainter that can be used to paint or locate the object passed. |
int |
getMaxNoOfOutlineTiles() |
int |
getMaxNumberOfOutlineTiles() |
Object |
getObject()
Returns the Object for which the representation is currently being handled by this painter.
|
Color |
getOutlineColor() |
double |
getStartResolutionFactor() |
double |
getStopResolutionFactor() |
ILcdPoint |
getSunPosition()
Returns the direction of the sun.
|
float |
getTransparency() |
boolean |
isForcePainting() |
boolean |
isPaintOutline() |
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 |
removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)
De-registers the given
PropertyChangeListener from receiving property change events
for this object. |
void |
setBrightness(float aBrightness)
Sets the brightness factor that is applied to painted rasters.
|
void |
setColorModel(ColorModel aColorModel)
Sets the color model for the shaded raster.
|
void |
setElevationExaggeration(double aElevationExaggeration)
Sets the elevation exaggeration.
|
void |
setForcePainting(boolean aForcePainting)
Specifies whether the visible portion of the raster should always be
painted, irrespective of the startResolutionFactor and
stopResolutionFactor.
|
void |
setMaxNoOfOutlineTiles(int aMaxNumberOfOutlineTiles) |
void |
setMaxNumberOfOutlineTiles(int aMaxNumberOfOutlineTiles)
Sets the maximum number of outlines of individual tiles to paint when
the pixel density (number of raster pixels per screen pixel) of the raster
to be painted is higher than the startResolutionFactor.
|
void |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
void |
setOutlineColor(Color aColor)
Sets the line color used to paint the raster outlines and tile outlines
when the pixel density (number of raster pixels per screen pixel) of the
raster to be painted is higher than the startResolutionFactor.
|
void |
setPaintOutline(boolean aPaintOutline)
Specifies whether the raster outlines and tile outlines should be painted
when the pixel density (number of raster pixels per screen pixel) of the
raster to be painted is higher than the startResolutionFactor.
|
void |
setStartResolutionFactor(double aFactor)
Sets the highest pixel density (number of raster pixels per screen pixel)
at which a raster is painted.
|
void |
setStopResolutionFactor(double aFactor)
Sets the lowest pixel density (number of raster pixels per screen pixel)
at which a raster is painted.
|
void |
setSunPosition(ILcdPoint aPoint)
Sets the direction of the sun.
|
void |
setTransparency(float aTransparency)
Sets the transparency factor that is applied to painted rasters.
|
Object |
snapTarget(Graphics aGraphics,
ILcdGXYContext aGXYContext)
Returns an object that can be used as snapping target when graphically editing an object.
|
boolean |
supportSnap(Graphics aGraphics,
ILcdGXYContext aGXYContext)
Returns whether the painter can provide a snap target based on the representation of the object in the given
context.
|
public TLcdShadedRasterPainter(ILcdBuffer aBuffer)
public TLcdShadedRasterPainter(ILcdRasterPainter aRasterPainter, ILcdBuffer aBuffer)
public void setElevationExaggeration(double aElevationExaggeration)
public double getElevationExaggeration()
public void setSunPosition(ILcdPoint aPoint)
public ILcdPoint getSunPosition()
public void setStartResolutionFactor(double aFactor)
ILcdRasterPaintersetStartResolutionFactor in interface ILcdRasterPainterpublic double getStartResolutionFactor()
getStartResolutionFactor in interface ILcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double)public void setStopResolutionFactor(double aFactor)
ILcdRasterPaintersetStopResolutionFactor in interface ILcdRasterPainterpublic double getStopResolutionFactor()
getStopResolutionFactor in interface ILcdRasterPainterILcdRasterPainter.setStopResolutionFactor(double)public void setForcePainting(boolean aForcePainting)
ILcdRasterPaintersetForcePainting in interface ILcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double),
ILcdRasterPainter.setStopResolutionFactor(double)public boolean isForcePainting()
isForcePainting in interface ILcdRasterPainterILcdRasterPainter.setForcePainting(boolean)public void setPaintOutline(boolean aPaintOutline)
ILcdRasterPaintersetPaintOutline in interface ILcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double)public boolean isPaintOutline()
isPaintOutline in interface ILcdRasterPainterILcdRasterPainter.setPaintOutline(boolean)public void setOutlineColor(Color aColor)
ILcdRasterPaintersetOutlineColor in interface ILcdRasterPainterILcdRasterPainter.setPaintOutline(boolean),
ILcdRasterPainter.setStartResolutionFactor(double)public Color getOutlineColor()
getOutlineColor in interface ILcdRasterPainterILcdRasterPainter.setOutlineColor(java.awt.Color)public void setMaxNumberOfOutlineTiles(int aMaxNumberOfOutlineTiles)
ILcdRasterPaintersetMaxNumberOfOutlineTiles in interface ILcdRasterPainterILcdRasterPainter.setStartResolutionFactor(double)public int getMaxNumberOfOutlineTiles()
getMaxNumberOfOutlineTiles in interface ILcdRasterPainterILcdRasterPainter.setMaxNumberOfOutlineTiles(int)public void setMaxNoOfOutlineTiles(int aMaxNumberOfOutlineTiles)
setMaxNoOfOutlineTiles in interface ILcdRasterPainterpublic int getMaxNoOfOutlineTiles()
getMaxNoOfOutlineTiles in interface ILcdRasterPainterpublic void setColorModel(ColorModel aColorModel)
setColorModel in interface ILcdRasterPainterpublic ColorModel getColorModel()
getColorModel in interface ILcdRasterPainterILcdRasterPainter.setColorModel(java.awt.image.ColorModel)public void setBrightness(float aBrightness)
ILcdRasterPaintersetBrightness in interface ILcdRasterPainterALcdRasterPainter.setContrast(float)public float getBrightness()
getBrightness in interface ILcdRasterPainterILcdRasterPainter.setBrightness(float)public void setTransparency(float aTransparency)
ILcdRasterPaintersetTransparency in interface ILcdRasterPainterpublic float getTransparency()
getTransparency in interface ILcdRasterPainterILcdRasterPainter.setTransparency(float)public void setObject(Object aObject)
ILcdGXYPainterSetting 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 ILcdGXYPainteraObject - the object for which the representation shall be handled by this painter.ILcdGXYPainter.getObject()public Object getObject()
ILcdGXYPaintergetObject in interface ILcdGXYPainterILcdGXYPainter.setObject(Object)public void paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainterThe 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:
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.
paint in interface ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaMode - the mode the object is represented in (see class documentation).aGXYContext - the ILcdGXYContext the drawing depends on.public void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
ILcdGXYPainterIf 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 ILcdGXYPainteraGraphics - 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.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.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.isTouchedpublic 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 ILcdGXYPainteraGraphics - 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 coordinatesboundsSFCTpublic void anchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT) throws TLcdNoBoundsException
ILcdGXYPainter
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.
anchorPointSFCT in interface ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaMode - 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.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.paintpublic boolean supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)
ILcdGXYPaintersupportSnap in interface ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaGXYContext - the context in which this object is represented and in which the editing of an object occurs.public Object snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)
ILcdGXYPainter
This method must only be called when supportSnap
returns true for the given context.
snapTarget in interface ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaGXYContext - the context in which this object is represented and in which the editing of an object occurs.supportSnappublic Cursor getCursor(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainterTRANSLATING, the cursor could be the MOVE cursor.
When no specific cursor is required implementations must return null.getCursor in interface ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaMode - the rendering mode to return the cursor for.aGXYContext - the context in which the rendering occurs.Cursor to indicate the type of operating
aMode and aGXYContext. Returns
null if no particular Cursor is required.public String getDisplayName()
ILcdGXYPaintergetDisplayName in interface ILcdGXYPainterpublic void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)
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.
addPropertyChangeListener in interface ILcdPropertyChangeSourceaPropertyChangeListener - The listener to be notifiedALcdWeakPropertyChangeListener,
ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)
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.
removePropertyChangeListener in interface ILcdPropertyChangeSourceaPropertyChangeListener - the listener that should no longer be notified of changes of
this object's propertiesILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)public ILcdGXYPainter getGXYPainter(Object aObject)
ILcdGXYPainterProviderILcdGXYPainter 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;
}
getGXYPainter in interface ILcdGXYPainterProvideraObject - the object to find a painter forpublic Object clone()
ILcdCloneableMakes 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 ILcdCloneableclone in interface ILcdGXYPainterProviderclone in class ObjectObject.clone()