com.luciad.view.labeling.algorithm.discrete

LuciadLightspeedInterface ILcdLabelPlacementEvaluator

public interface ILcdLabelPlacementEvaluator

Interface that allows to evaluate a placement for a label.

Since:

10.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILcdLabelPlacementEvaluator.PlacementResult Placement result for a label.

Method Summary

Modifier and Type	Method and Description
ILcdLabelPlacementEvaluator.PlacementResult	evaluatePlacement(TLcdLabelPlacement aLabelPlacement, ILcdLabelConflictChecker.Conflict aConflict, List<TLcdLabelPlacement> aPlacedLabels) This method evaluates the given label placement and returns a PlacementResult to denote if the placement can be used for its label or not.
void	noPlacementApplied(TLcdCollectedLabelInfo aLabel, List<TLcdLabelPlacement> aPlacedLabels) This method can be called to notify that no TLcdLabelPlacement is chosen as placement for the given label.
void	placementApplied(TLcdLabelPlacement aLabelPlacement, List<TLcdLabelPlacement> aPlacedLabels) This method can be called to notify that a given TLcdLabelPlacement is chosen as the placement for the given label.

Method Detail

evaluatePlacement

ILcdLabelPlacementEvaluator.PlacementResult evaluatePlacement(TLcdLabelPlacement aLabelPlacement,
                                                              ILcdLabelConflictChecker.Conflict aConflict,
                                                              List<TLcdLabelPlacement> aPlacedLabels)

This method evaluates the given label placement and returns a PlacementResult to denote if the placement can be used for its label or not. It can make this decision based on a Conflict returned by an ILcdLabelConflictChecker and a list of already placed labels.

Parameters:

aLabelPlacement - the label placement to evaluate.

aConflict - a Conflict returned by an ILcdLabelConflictChecker, can be null.

aPlacedLabels - a list of already placed labels.

Returns:

a ILcdLabelPlacementEvaluator.PlacementResult.

placementApplied

void placementApplied(TLcdLabelPlacement aLabelPlacement,
                      List<TLcdLabelPlacement> aPlacedLabels)

This method can be called to notify that a given TLcdLabelPlacement is chosen as the placement for the given label.

Parameters:

aLabelPlacement - the applied label placement.

aPlacedLabels - the list of currently placed labels.

noPlacementApplied

void noPlacementApplied(TLcdCollectedLabelInfo aLabel,
                        List<TLcdLabelPlacement> aPlacedLabels)

This method can be called to notify that no TLcdLabelPlacement is chosen as placement for the given label.

Parameters:

aLabel - the label for which no valid placement was found.

aPlacedLabels - the list of currently placed labels.