com.luciad.view.lightspeed.label.algorithm

LuciadLightspeedClass ILspLabelingAlgorithm.LabelContext

java.lang.Object

com.luciad.view.lightspeed.label.algorithm.ILspLabelingAlgorithm.LabelContext

Enclosing interface:

ILspLabelingAlgorithm

public abstract static class ILspLabelingAlgorithm.LabelContext
extends Object

This object as passed to placeLabels and can be used to retrieve and store 'context' information.

Since:

2012.0

Constructor Summary

Constructors

Constructor and Description
LabelContext()

Method Summary

Modifier and Type	Method and Description
abstract TLspContext	getContext(ILspLayer aLayer, ILspView aView) Returns a context for the given label.
ILspWorldElevationStyle.ElevationMode	getElevationMode(TLspLabelID aLabel, ILspView aView) Returns the elevation mode of the anchor object of the given label.
abstract TLspPaintState	getPaintState(TLspLabelID aLabel, ILspView aView) Returns the paint state to be used for the given label.
abstract ALspLabelLocations.LocationInfo	getPreviousLocation(TLspLabelID aLabel, ILspView aView) Returns the previous label location and visibility of the given label.
abstract int	getPriority(TLspLabelID aLabel, ILspView aView) This method returns the priority for the given label.
abstract Map<String,Object>	getProperties() Returns a custom properties mapping.
abstract Map<String,Object>	getProperties(TLspLabelID aLabel) Returns a custom properties mapping for the given label.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelContext

public LabelContext()

Method Detail

getContext

public abstract TLspContext getContext(ILspLayer aLayer,
                                       ILspView aView)

Returns a context for the given label.

Parameters:

aLayer - a layer.

aView - the view.

Returns:

a context for the given label.

getPriority

public abstract int getPriority(TLspLabelID aLabel,
                                ILspView aView)

This method returns the priority for the given label.

Parameters:

aLabel - a label.

aView - the view.

Returns:

the priority for the given label

See Also:

ILspLabelPriorityProvider.getPriority

getPreviousLocation

public abstract ALspLabelLocations.LocationInfo getPreviousLocation(TLspLabelID aLabel,
                                                                    ILspView aView)

Returns the previous label location and visibility of the given label.

Parameters:

aLabel - an identifier for a label.

aView - the view.

Returns:

the previous label location and visibility.

See Also:

ALspLabelLocations.getLabelLocation(com.luciad.view.lightspeed.ILspView, com.luciad.view.lightspeed.painter.label.TLspLabelID)

getPaintState

public abstract TLspPaintState getPaintState(TLspLabelID aLabel,
                                             ILspView aView)

Returns the paint state to be used for the given label.

Parameters:

aLabel - an identifier for a label.

aView - the view.

Returns:

the paint state to be used.

getElevationMode

public ILspWorldElevationStyle.ElevationMode getElevationMode(TLspLabelID aLabel,
                                                              ILspView aView)

Returns the elevation mode of the anchor object of the given label.

Parameters:

aLabel - an identifier for a label.

aView - the view.

Returns:

the elevation mode of the anchor object of the given label.

getProperties

public abstract Map<String,Object> getProperties()

Returns a custom properties mapping.

Returns:

a custom properties mapping.

getProperties

public abstract Map<String,Object> getProperties(TLspLabelID aLabel)

Returns a custom properties mapping for the given label.

Parameters:

aLabel - an identifier for a label.

Returns:

a custom properties mapping.