public class TLcdGXYInPathLabelingAlgorithm extends ALcdGXYDiscretePlacementsLabelingAlgorithm
Note that this implementation does not support "holes" in paths.
The used label painter must be an ILcdGXYLabelPainter2
. If not,
the label will be painted at an incorrect location.
The implementation of this labeling algorithm is thread-safe, as long as the set
ILcdGXYLabelingPathProvider
and label priority provider are thread-safe.
Constructor and Description |
---|
TLcdGXYInPathLabelingAlgorithm()
Creates a new
TLcdGXYInPathLabelingAlgorithm using TLcdGXYLabelingPathProvider as path provider. |
TLcdGXYInPathLabelingAlgorithm(ILcdGXYLabelingPathProvider aPathProvider)
Creates a new
TLcdGXYInPathLabelingAlgorithm using the given path provider. |
Modifier and Type | Method and Description |
---|---|
TLcdGXYInPathLabelingAlgorithm |
clone()
Makes
Object.clone() public. |
TLcdCollectedLabelInfoList |
collectLabelInfo(List<TLcdLabelIdentifier> aLabelsToCollect,
Graphics aGraphics,
ILcdGXYView aGXYView)
This method returns a
TLcdCollectedLabelInfoList object based
on the given list of TLcdLabelIdentifier s. |
protected Iterator<TLcdCollectedLabelInfo> |
createLabelIterator(TLcdCollectedLabelInfoList aLabelInfoList,
ILcdLabelConflictChecker aBoundsConflictChecker,
ILcdGXYView aView)
Creates a new
Iterator that iterates over the TLcdCollectedLabelInfo s. |
protected ILcdLabelPlacementEvaluator |
createLabelPlacementEvaluator(TLcdCollectedLabelInfoList aLabelInfoList,
ILcdLabelConflictChecker aBoundsConflictChecker,
ILcdGXYView aView)
Creates a new
ILcdLabelPlacementEvaluator using the given parameters. |
protected Iterator<TLcdLabelPlacement> |
createLabelPlacementIterator(TLcdCollectedLabelInfo aLabel,
TLcdCollectedLabelInfoList aLabelInfoList,
ILcdLabelConflictChecker aBoundsConflictChecker,
ILcdGXYView aView)
Creates a new
Iterator that iterates over the TLcdLabelPlacement s
for the given label. |
ILcdGXYMultiLabelPriorityProvider |
getLabelPriorityProvider()
Returns the label placing priority provider.
|
double |
getMinimumPathLength()
Returns the minimum contour length for a clipped polygon to contain a label.
|
ILcdGXYLabelingPathProvider |
getPathProvider()
Returns the path provider used by this path labeling algorithm.
|
void |
setLabelPriorityProvider(ILcdGXYMultiLabelPriorityProvider aLabelPriorityProvider)
Sets the label placing priority provider, specifying the priority for individual
labels.
|
void |
setMinimumPathLength(double aMinimumPathLength)
Sets the minimum outline length for a clipped polygon to contain a label.
|
void |
setPathProvider(ILcdGXYLabelingPathProvider aPathProvider)
Sets the path provider to be used by this path labeling algorithm.
|
computeLabelPlacements
public TLcdGXYInPathLabelingAlgorithm()
TLcdGXYInPathLabelingAlgorithm
using TLcdGXYLabelingPathProvider
as path provider.public TLcdGXYInPathLabelingAlgorithm(ILcdGXYLabelingPathProvider aPathProvider)
TLcdGXYInPathLabelingAlgorithm
using the given path provider.aPathProvider
- a path provider.public double getMinimumPathLength()
setMinimumPathLength(double)
public void setMinimumPathLength(double aMinimumPathLength)
The default value is 0 pixels, i.e. no clipped polygon will be excluded from being labeled.
aMinimumPathLength
- the minimal length for a clipped polygon to contain a label.public ILcdGXYLabelingPathProvider getPathProvider()
public void setPathProvider(ILcdGXYLabelingPathProvider aPathProvider)
aPathProvider
- the path provider to be used by this path labeling algorithm.public ILcdGXYMultiLabelPriorityProvider getLabelPriorityProvider()
setLabelPriorityProvider(com.luciad.view.gxy.ILcdGXYMultiLabelPriorityProvider)
public void setLabelPriorityProvider(ILcdGXYMultiLabelPriorityProvider aLabelPriorityProvider)
When no label priority provider is set, a default label priority provider is used
which returns Integer.MAX_VALUE
for all labels.
The priority provider is used to sort the list of labels before their placements are computed.
aLabelPriorityProvider
- The priority provider to set.public TLcdGXYInPathLabelingAlgorithm 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
Object.clone()
protected Iterator<TLcdCollectedLabelInfo> createLabelIterator(TLcdCollectedLabelInfoList aLabelInfoList, ILcdLabelConflictChecker aBoundsConflictChecker, ILcdGXYView aView)
ALcdGXYDiscretePlacementsLabelingAlgorithm
Iterator
that iterates over the TLcdCollectedLabelInfo
s.
The abstract labeling algorithm will continue iterating over TLcdCollectedLabelInfo
s
as long as Iterator.hasNext()
returns true
. When it returns false
,
no more labels will be tried, and computeLabelPlacements
returns.
Iterator.hasNext()
should always be called before calling Iterator.next()
, and
if it returns true
, Iterator.next()
should never return null
.
The implementation of this method should be as independent as possible. It should not rely on
createLabelPlacementIterator
or
createLabelPlacementEvaluator
.
Not respecting this might result in unexpected behaviour when wrapping or extending this class.
The returned TLcdCollectedLabelInfo
should be correctly initialized, i.e. it should
contain all information needed to create valid TLcdLabelPlacement
s using
createLabelPlacementIterator
. It should also always point
to its corresponding TLcdCollectedLabeledObjectInfo
.
Override this method to provide a custom implementation.
createLabelIterator
in class ALcdGXYDiscretePlacementsLabelingAlgorithm
aLabelInfoList
- the label infos object that contains all information needed to place the labels.aBoundsConflictChecker
- the bounds conflict checker to be used when evaluating label placements.aView
- the view.Iterator
that iterates over TLcdCollectedLabelInfo
s.protected Iterator<TLcdLabelPlacement> createLabelPlacementIterator(TLcdCollectedLabelInfo aLabel, TLcdCollectedLabelInfoList aLabelInfoList, ILcdLabelConflictChecker aBoundsConflictChecker, ILcdGXYView aView)
ALcdGXYDiscretePlacementsLabelingAlgorithm
Iterator
that iterates over the TLcdLabelPlacement
s
for the given label. The abstract labeling algorithm will continue iterating over
TLcdLabelPlacement
s as long as Iterator.hasNext()
returns true
.
When it returns false
, a new label will be tried. Iterator.hasNext()
should
always be called before calling Iterator.next()
, and if it returns true
,
Iterator.next()
should never return null
.
The implementation of this method should be as independent as possible. It should not rely on
createLabelIterator
or createLabelPlacementEvaluator
.
Not respecting this might result in unexpected behaviour when wrapping or extending this class.
The returned TLcdLabelPlacement
should be correctly initialized, i.e. it should at
least be able to return a valid label location, bounds rectangle and bounds rotation. It should
also reference its corresponding TLcdCollectedLabelInfo
.
Override this method to provide a custom implementation.
createLabelPlacementIterator
in class ALcdGXYDiscretePlacementsLabelingAlgorithm
aLabel
- the label for which an iterator should be created.aLabelInfoList
- the info object that contains all information needed to place the labels.aBoundsConflictChecker
- the bounds conflict checker to be used when evaluating label placements.aView
- the view.Iterator
that iterates over TLcdLabelPlacement
s.protected ILcdLabelPlacementEvaluator createLabelPlacementEvaluator(TLcdCollectedLabelInfoList aLabelInfoList, ILcdLabelConflictChecker aBoundsConflictChecker, ILcdGXYView aView)
ALcdGXYDiscretePlacementsLabelingAlgorithm
ILcdLabelPlacementEvaluator
using the given parameters. It evaluates
the placements returned by createLabelPlacementIterator
,
and returns a PlacementResult
to denote if the placement should be used for its
label or not.
The following actions are undertaken for the following placement results :
PlacementResult.SUCCESS
:
the given label placement will be used for its label, it will be added to the list of placed
labels, and it will be added to the given ILcdLabelConflictChecker
. After that,
ILcdLabelPlacementEvaluator.placementApplied
will be called and no more placements are tried for the label.PlacementResult.FALLBACK
:
the abstract algorithm will try to find an other placements which returns
PlacementResult.SUCCESS
.
When no such placement is found, this placement will be added to the list of placed labels,
and it will be added to the given ILcdLabelConflictChecker
. After that,
ILcdLabelPlacementEvaluator.placementApplied
will be called.PlacementResult.TRY_NEW_PLACEMENT
:
the abstract algorithm will try to find an other placement which returns
PlacementResult.SUCCESS
or
PlacementResult.FALLBACK
.
When no such placement is found, ILcdLabelPlacementEvaluator.noPlacementApplied
is called.PlacementResult.FAILED
: the
abstract algorithm will immediately call ILcdLabelPlacementEvaluator.noPlacementApplied
and will not try to find other placements for the label.Override this method to provide a custom implementation.
createLabelPlacementEvaluator
in class ALcdGXYDiscretePlacementsLabelingAlgorithm
aLabelInfoList
- the info object that contains all information needed to place the labels.aBoundsConflictChecker
- the bounds conflict checker to be used when evaluating label placements.aView
- the viewILcdLabelPlacementEvaluator
public TLcdCollectedLabelInfoList collectLabelInfo(List<TLcdLabelIdentifier> aLabelsToCollect, Graphics aGraphics, ILcdGXYView aGXYView)
ILcdGXYLabelingAlgorithm
TLcdCollectedLabelInfoList
object based
on the given list of TLcdLabelIdentifier
s. The returned
TLcdCollectedLabelInfoList
should contain a TLcdCollectedLabelInfo
object for each label that should be placed.
Each TLcdCollectedLabelInfo
should also contain all information needed by
computeLabelPlacements
to place the labels. In order to enable
correct asynchronous label placing, all calls to the layer and the (label) painters should be
done in this method. The results should then be stored in the info objects.
It is possible that the returned TLcdCollectedLabelInfoList
doesn't contain a
TLcdCollectedLabelInfo
object for every given TLcdLabelIdentifier
.
In that case the missing labels are not placed.
collectLabelInfo
in interface ILcdGXYLabelingAlgorithm
aLabelsToCollect
- the labels for which a TLcdCollectedLabelInfoList
should
be created.aGraphics
- the graphics.aGXYView
- the view.TLcdCollectedLabelInfoList
which contains all the information needed to
place the labels.