Package com.luciad.layers.features

Class FeaturePainterContext

java.lang.Object

com.luciad.layers.features.FeaturePainterContext

All Implemented Interfaces:

AutoCloseable

public final class FeaturePainterContext
extends Object
implements AutoCloseable

FeaturePainterContext provides information for use during feature painting.

IFeaturePainter implementations can use it to find out the applicable detail level, feature state and so on to determine how to paint the current feature.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
long	getDetailLevel()	Returns the current detail level for the currently painted Feature.
long	getLayerId()	Returns the layer id of the Feature that is being painted.
IFeatureModel	getModel()	Returns the IFeatureModel of the Feature that is being painted.
boolean	is3D()	Returns whether the Map that the Feature is being painted on is 3D.
boolean	isDependentOnFeatureState(FeatureState featureState)	Returns whether this IFeaturePainter is dependent on the given FeatureState.
boolean	isFeatureStateEnabled(FeatureState featureState)	Returns if the given FeatureState is enabled for the Feature that is currently being painted.

Methods inherited from class java.lang.Object

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

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

getDetailLevel

public long getDetailLevel()

Returns the current detail level for the currently painted Feature.

See FeaturePainterMetadata#detailLevelScales on how to define detail levels.

Returns:

the current detail level for the currently painted Feature.

isDependentOnFeatureState

public boolean isDependentOnFeatureState(@NotNull
 FeatureState featureState)

Returns whether this IFeaturePainter is dependent on the given FeatureState.

Parameters:

featureState - a given FeatureState

Returns:

whether this IFeaturePainter is dependent on the given FeatureState.

Since:

2024.1

isFeatureStateEnabled

public boolean isFeatureStateEnabled(@NotNull
 FeatureState featureState)
                              throws RuntimeException

Returns if the given FeatureState is enabled for the Feature that is currently being painted.

Parameters:

featureState - a given FeatureState

Returns:

if the given FeatureState is enabled for the Feature that is currently being painted.

Throws:

RuntimeException - if this IFeaturePainter does not depend on the given FeatureState.

See Also:

• isDependentOnFeatureState

getModel

@NotNull
public IFeatureModel getModel()

Returns the IFeatureModel of the Feature that is being painted.

Returns:

the IFeatureModel of the Feature that is being painted.

getLayerId

public long getLayerId()

Returns the layer id of the Feature that is being painted.

Returns:

the layer id of the Feature that is being painted.

is3D

public boolean is3D()

Returns whether the Map that the Feature is being painted on is 3D.

Returns:

whether the Map that the Feature is being painted on is 3D.

Since:

2024.1