luciad::FeaturePainterContext Class Reference

FeaturePainterContext provides information for use during feature painting. More...

#include <luciad/layers/features/FeaturePainterContext.h>

Public Member Functions
virtual	~FeaturePainterContext ()=default
virtual size_t	getDetailLevel () const =0
	Returns the current detail level for the currently painted Feature. More...
virtual LayerId	getLayerId () const =0
	Returns the layer id of the Feature that is being painted. More...
virtual const std::shared_ptr< IFeatureModel > &	getModel () const =0
	Returns the IFeatureModel of the Feature that is being painted. More...
virtual bool	is3D () const =0
	Returns whether the Map that the Feature is being painted on is 3D. More...
virtual bool	isDependentOnFeatureState (const FeatureState &featureState) const =0
	Returns whether this IFeaturePainter is dependent on the given FeatureState. More...
virtual bool	isFeatureStateEnabled (const FeatureState &featureState) const =0
	Returns if the given FeatureState is enabled for the Feature that is currently being painted. More...

Detailed Description

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.

Constructor & Destructor Documentation

~FeaturePainterContext()

virtual luciad::FeaturePainterContext::~FeaturePainterContext ( )

virtualdefault

Member Function Documentation

getDetailLevel()

virtual size_t luciad::FeaturePainterContext::getDetailLevel ( ) const

pure virtual

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.

getLayerId()

virtual LayerId luciad::FeaturePainterContext::getLayerId ( ) const

pure virtual

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

Returns

the layer id of the Feature that is being painted.

getModel()

virtual const std::shared_ptr< IFeatureModel > & luciad::FeaturePainterContext::getModel ( ) const

pure virtual

Returns the IFeatureModel of the Feature that is being painted.

Returns

the IFeatureModel of the Feature that is being painted.

is3D()

virtual bool luciad::FeaturePainterContext::is3D ( ) const

pure virtual

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

isDependentOnFeatureState()

virtual bool luciad::FeaturePainterContext::isDependentOnFeatureState ( const FeatureState &  featureState ) const

pure virtual

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()

virtual bool luciad::FeaturePainterContext::isFeatureStateEnabled ( const FeatureState &  featureState ) const

pure virtual

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.

Exceptions

RuntimeException

if this IFeaturePainter does not depend on the given FeatureState.

See also

isDependentOnFeatureState