com.luciad.view.lightspeed.label.algorithm.discrete

LuciadLightspeedInterface ILspLabelPlacementEvaluator

public interface ILspLabelPlacementEvaluator

Interface that allows to evaluate a placement for a label.

Since:

2012.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
ILspLabelPlacementEvaluator.PlacementResult	evaluatePlacement(TLspLabelPlacement aPlacement, ILspLabelConflictChecker.Conflict aConflict, List<TLspLabelPlacement> aPlacements, ALspLabelLocations aCurrentLabelLocations) This method evaluates the given label placement and returns a PlacementResult to determine if the placement can be used for its label or not.
void	noPlacementApplied(TLspLabelID aLabel, List<TLspLabelPlacement> aPlacements, ALspLabelLocations aCurrentLabelLocations) This method can be called to notify that no TLspLabelPlacement is chosen as placement for the given label.
void	placementApplied(TLspLabelPlacement aPlacement, List<TLspLabelPlacement> aPlacements, ALspLabelLocations aCurrentLabelLocations) This method can be called to notify that a given TLspLabelPlacement is chosen as the placement for a label.

Method Detail

evaluatePlacement

ILspLabelPlacementEvaluator.PlacementResult evaluatePlacement(TLspLabelPlacement aPlacement,
                                                              ILspLabelConflictChecker.Conflict aConflict,
                                                              List<TLspLabelPlacement> aPlacements,
                                                              ALspLabelLocations aCurrentLabelLocations)

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

Parameters:

aPlacement - the placement to evaluate.

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

aPlacements - a list of already placed labels.

aCurrentLabelLocations - an ALspLabelLocations object containing locations for the currently placed labels.

Returns:

a PlacementResult.

placementApplied

void placementApplied(TLspLabelPlacement aPlacement,
                      List<TLspLabelPlacement> aPlacements,
                      ALspLabelLocations aCurrentLabelLocations)

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

Parameters:

aPlacement - the applied placement.

aPlacements - the list of currently placed labels.

aCurrentLabelLocations - an ALspLabelLocations object containing locations for the currently placed labels.

noPlacementApplied

void noPlacementApplied(TLspLabelID aLabel,
                        List<TLspLabelPlacement> aPlacements,
                        ALspLabelLocations aCurrentLabelLocations)

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

Parameters:

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

aPlacements - the list of currently placed labels.

aCurrentLabelLocations - an ALspLabelLocations object containing locations for the currently placed labels.