A layer for feature models. More...

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

Inheritance diagram for luciad::FeatureLayer:

Classes
class	Builder
	Builder for the luciad::FeatureLayer class. More...

Public Member Functions
	~FeatureLayer () override

void	addObserver (std::shared_ptr< ILayerObserver > layerObserver) override
	Adds an observer that allows to receive change events from this layer. More...

Builder	asBuilder () const
	Returns a new builder based on this layer instance. More...

const std::optional< DensitySettings > &	getDensitySettings () const
	Returns the currently set density settings, or `std::nullopt` if density painting is not active. More...

std::shared_ptr< IFeatureEditConfiguration >	getEditConfiguration () const
	Returns the edit configuration if editing is supported, or `nullptr`. More...

std::shared_ptr< IFeatureGeometryProvider >	getEditCreateGeometryProvider () const
	Returns the edit/create geometry provider for a Feature. More...

FeatureLayerLoadingStrategy	getLoadingStrategy () const
	Returns the loading strategy that is used. More...

const std::shared_ptr< IFeatureModel > &	getModel () const
	Returns the layer's model, which provides the features to present. More...

const std::shared_ptr< IFeaturePainter > &	getPainter () const
	Returns the layer's painter, which determines how the features are presented. More...

const std::shared_ptr< FeatureQueryConfiguration > &	getQueryConfiguration () const
	Returns the query configuration, which specifies which feature to present at different map scales. More...

const std::string &	getTitle () const override
	Returns the layer's title. More...

bool	isBusy () const override
	Returns whether this layer is busy loading data, rendering, loading attributions, or anything else. More...

bool	isEditable () const
	Returns whether this layer is editable. More...

bool	isLabeled () const
	Returns whether this layer displays labels. More...

bool	isQueryable () const
	Returns whether the features of this layer can be returned in the `Map::queryFeatures` method. More...

bool	isVisible () const override
	Returns whether this layer is visible. More...

void	removeObserver (const std::shared_ptr< ILayerObserver > &layerObserver) override
	Removes the given observer. More...

void	setDensitySettings (std::optional< DensitySettings > densitySettings)
	Sets the layer's density settings. More...

void	setEditable (bool editable)
	Sets whether this layer is editable. More...

void	setLabeled (bool labeled)
	Sets whether this layer displays labels. More...

void	setPainter (std::shared_ptr< IFeaturePainter > featurePainter)
	Sets the layer's painter, which determines how the features are presented. More...

void	setQueryable (bool queryable)
	Sets whether the features of this layer can be returned in the `Map::queryFeatures` method. More...

void	setTitle (std::string title) override
	Sets the layer's title. More...

void	setVisible (bool visible) override
	Sets whether this layer is visible. More...

Public Member Functions inherited from luciad::Layer
	Layer ()
	Default constructor. More...

virtual	~Layer ()=default

virtual void	addObserver (std::shared_ptr< ILayerObserver > layerObserver)=0
	Adds an observer that allows to receive change events from this layer. More...

virtual LayerId	getId () const
	Returns the layer's unique id. More...

virtual const std::string &	getTitle () const =0
	Returns the layer's title. More...

virtual bool	isBusy () const =0
	Returns whether this layer is busy loading data, rendering, loading attributions, or anything else. More...

virtual bool	isVisible () const =0
	Returns whether this layer is visible. More...

virtual void	removeObserver (const std::shared_ptr< ILayerObserver > &layerObserver)=0
	Removes the given observer. More...

virtual void	setTitle (std::string title)=0
	Sets the layer's title. More...

virtual void	setVisible (bool visible)=0
	Sets whether this layer is visible. More...

Static Public Member Functions
static Builder	newBuilder ()
	Returns a new builder for creating a FeatureLayer. More...

static const std::string &	propertyDensitySettings ()
	Returns the property name for the LayerEvent that is fired as a result of changing the layer's `DensitySettings`. More...

static const std::string &	propertyEditable ()
	Returns the property name for the LayerEvent that is fired as a result of changing the layer's editable flag. More...

static const std::string &	propertyLabeled ()
	Returns the property name for the LayerEvent that is fired as a result of changing the layer's labeled flag. More...

static const std::string &	propertyPainter ()
	Returns the property name for the LayerEvent that is fired as a result of changing the layer's `IFeaturePainter`. More...

static const std::string &	propertyQueryable ()
	Returns the property name for the LayerEvent that is fired as a result of changing the layer's queryable flag. More...

Static Public Member Functions inherited from luciad::Layer
static const std::string &	propertyBusy ()
	Property name for the LayerEvent that is fired as a result of the layer's busy flag changing. More...

static const std::string &	propertyTitle ()
	Property name for the LayerEvent that is fired as a result of changing the layer's title. More...

static const std::string &	propertyVisible ()
	Property name for the LayerEvent that is fired as a result of changing the layer's visible flag. More...

Detailed Description

A layer for feature models.

Use luciad::FeatureLayer::newBuilder to create a feature layer instance.

Constructor & Destructor Documentation

◆ ~FeatureLayer()

luciad::FeatureLayer::~FeatureLayer ( )

override

Member Function Documentation

◆ addObserver()

void luciad::FeatureLayer::addObserver ( std::shared_ptr< ILayerObserver > layerObserver )

overridevirtual

Adds an observer that allows to receive change events from this layer.

Adding the same observer twice is forbidden, and will cause an exception to be thrown.

Parameters

layerObserver an observer.

Exceptions

luciad::InvalidArgumentException	when the observer was already added.
luciad::NullArgumentException	when the observer is `nullptr`.

Implements luciad::Layer.

◆ asBuilder()

Builder luciad::FeatureLayer::asBuilder ( ) const

Returns a new builder based on this layer instance.

You can use this builder, for example, to create a copy of this layer.

Note that this function will not make copies of the used IFeatureModel or IFeaturePainter, but use the same instances that are present on this layer. You need to make sure that these are thread-safe and can handle concurrent usage.

Also note that observers will not be transferred to a new layer.

Returns: a new builder based on this layer instance.

Since: 2024.1.03

◆ getDensitySettings()

const std::optional< DensitySettings > & luciad::FeatureLayer::getDensitySettings ( ) const

Returns the currently set density settings, or std::nullopt if density painting is not active.

Returns: the currently set density settings, or std::nullopt if density painting is not active.

Since: 2024.1

◆ getEditConfiguration()

std::shared_ptr< IFeatureEditConfiguration > luciad::FeatureLayer::getEditConfiguration ( ) const

Returns the edit configuration if editing is supported, or nullptr.

Whether or not the layer can be edited by the user is controlled using setEditable.

Returns: the edit configuration, if editing is supported.

See also: FeatureLayer::Builder::editConfiguration

Since: 2020.1

◆ getEditCreateGeometryProvider()

std::shared_ptr< IFeatureGeometryProvider > luciad::FeatureLayer::getEditCreateGeometryProvider ( ) const

Returns the edit/create geometry provider for a Feature.

Returns: the edit/create geometry provider for a Feature.

See also: FeatureLayer::Builder::editCreateGeometryProvider

Since: 2020.1

◆ getLoadingStrategy()

FeatureLayerLoadingStrategy luciad::FeatureLayer::getLoadingStrategy ( ) const

Returns the loading strategy that is used.

Returns: the loading strategy that is used.

See also: FeatureLayer::Builder::loadingStrategy

Since: 2023.0.02

◆ getModel()

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

Returns the layer's model, which provides the features to present.

Returns: the layer's model, which provides the features to present.

◆ getPainter()

const std::shared_ptr< IFeaturePainter > & luciad::FeatureLayer::getPainter ( ) const

Returns the layer's painter, which determines how the features are presented.

Returns: the layer's painter, which determines how the features are presented.

◆ getQueryConfiguration()

const std::shared_ptr< FeatureQueryConfiguration > & luciad::FeatureLayer::getQueryConfiguration ( ) const

Returns the query configuration, which specifies which feature to present at different map scales.

Returns: the query configuration, which specifies which feature to present at different map scales.

◆ getTitle()

const std::string & luciad::FeatureLayer::getTitle ( ) const

overridevirtual

Returns the layer's title.

Should be suitable for presenting to the user.

Returns: the layer's title, should be suitable for presenting to the user.

Implements luciad::Layer.

◆ isBusy()

bool luciad::FeatureLayer::isBusy ( ) const

overridevirtual

Returns whether this layer is busy loading data, rendering, loading attributions, or anything else.

When this property changes, a LayerEvent is delivered to the observers with the property name propertyBusy.

Note: when the map is moving around it can be that the layer is repeatedly loading new data, but does this fast enough that it is done by the time new data is needed, resulting in a repeatedly changing busyness state.

Returns: whether this layer is busy.

Since: 2024.1

Implements luciad::Layer.

◆ isEditable()

bool luciad::FeatureLayer::isEditable ( ) const

Returns whether this layer is editable.

A layer is editable if it has an IFeatureEditConfiguration and if the editable flag is set.

Returns: whether this layer is editable.

See also: setEditable

Since: 2020.1

◆ isLabeled()

bool luciad::FeatureLayer::isLabeled ( ) const

Returns whether this layer displays labels.

Returns: whether this layer displays labels.

Since: 2020.2

◆ isQueryable()

bool luciad::FeatureLayer::isQueryable ( ) const

Returns whether the features of this layer can be returned in the Map::queryFeatures method.

Returns: whether the features of this layer can be returned in the Map::queryFeatures method.

Since: 2023.1

◆ isVisible()

bool luciad::FeatureLayer::isVisible ( ) const

overridevirtual

Returns whether this layer is visible.

Returns: whether this layer is visible.

Implements luciad::Layer.

◆ newBuilder()

static Builder luciad::FeatureLayer::newBuilder ( )

static

Returns a new builder for creating a FeatureLayer.

Returns: a new builder for creating a FeatureLayer.

◆ propertyDensitySettings()

static const std::string & luciad::FeatureLayer::propertyDensitySettings ( )

static

Returns the property name for the LayerEvent that is fired as a result of changing the layer's DensitySettings.

Returns: the property name for the LayerEvent that is fired as a result of changing the layer's DensitySettings.

See also: luciad::FeatureLayer::setDensitySettings

Since: 2024.1

◆ propertyEditable()

static const std::string & luciad::FeatureLayer::propertyEditable ( )

static

Returns the property name for the LayerEvent that is fired as a result of changing the layer's editable flag.

Returns: the property name for the LayerEvent that is fired as a result of changing the layer's editable flag.

See also: setEditable

◆ propertyLabeled()

static const std::string & luciad::FeatureLayer::propertyLabeled ( )

static

Returns the property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.

Returns: the property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.

See also: setLabeled

Since: 2020.2

◆ propertyPainter()

static const std::string & luciad::FeatureLayer::propertyPainter ( )

static

Returns the property name for the LayerEvent that is fired as a result of changing the layer's IFeaturePainter.

Returns: the property name for the LayerEvent that is fired as a result of changing the layer's IFeaturePainter.

See also: setPainter

Since: 2023.1

◆ propertyQueryable()

static const std::string & luciad::FeatureLayer::propertyQueryable ( )

static

Returns the property name for the LayerEvent that is fired as a result of changing the layer's queryable flag.

Returns: the property name for the LayerEvent that is fired as a result of changing the layer's queryable flag.

See also: setQueryable

Since: 2023.1

◆ removeObserver()

void luciad::FeatureLayer::removeObserver ( const std::shared_ptr< ILayerObserver > & layerObserver )

overridevirtual

Removes the given observer.

If the given observer was never added, an exception is thrown.

Parameters

layerObserver an observer.

Exceptions

luciad::InvalidArgumentException	when the observer is not known.
luciad::NullArgumentException	when the observer is `nullptr`.

Implements luciad::Layer.

◆ setDensitySettings()

void luciad::FeatureLayer::setDensitySettings ( std::optional< DensitySettings > densitySettings )

Sets the layer's density settings.

Can be set to std::nullopt to deactivate density painting.

When density painting is active, the color map in the density settings is used to determine the colors of shapes drawn by the IFeaturePainter.

Parameters

densitySettings the density painting settings.

See also: DensitySettings documentation for more information.

Since: 2024.1

◆ setEditable()

void luciad::FeatureLayer::setEditable ( bool editable )

Sets whether this layer is editable.

If the new value is different from the old one, a LayerEvent is delivered to the observers with the property name FeatureLayer::propertyEditable.

This flag is checked by the Editor when receiving events from the IFeatureEditCandidateProvider in conjunction with the model's IFeatureModelUpdater and the layer's IFeatureEditConfiguration.

This flag is true by default. This flag has no effect if the layer does not contain an IFeatureEditConfiguration or if the model's IFeatureModelUpdater is missing.

Parameters

editable the new value for this property

Since: 2020.1

◆ setLabeled()

void luciad::FeatureLayer::setLabeled ( bool labeled )

Sets whether this layer displays labels.

Note that in order for the layer to display labels, its IFeaturePainter should also call the FeatureCanvas::drawLabel method for its features. If not, no labels will be displayed, regardless of this setting.

Parameters

labeled true to enable labels.

Since: 2020.2

◆ setPainter()

void luciad::FeatureLayer::setPainter ( std::shared_ptr< IFeaturePainter > featurePainter )

Sets the layer's painter, which determines how the features are presented.

It will replace the IFeaturePainter that was set using the FeatureLayer::Builder::painter method, or if that method was not called, it will replace the default feature painter.

Limitation: This method currently only supports setting a new IFeaturePainter with the exact same level of details as the previous painter. If this is not the case, this method will throw an exception.

Parameters

featurePainter the feature painter used to paint the feature model. Cannot be nullptr.

Exceptions

luciad::NullArgumentException	when the given feature painter is `nullptr`
luciad::InvalidArgumentException	when the new painter has different detail levels than the previous painter

Since: 2023.1

◆ setQueryable()

void luciad::FeatureLayer::setQueryable ( bool queryable )

Sets whether the features of this layer can be returned in the Map::queryFeatures method.

The default is true.

It is useful to set this property to false when:

you don't want features to be selected or set to the hovered state by the luciad::SelectEventHandler or luciad::HoverEventHandler classes.
there is a performance issue with the Map::queryFeatures method, for example for a layer with many features that don't need to be selected.

Parameters

queryable whether the features of this layer can be returned in the Map::queryFeatures method

Since: 2023.1

◆ setTitle()

void luciad::FeatureLayer::setTitle ( std::string title )

overridevirtual

Sets the layer's title.

Should be suitable for presenting to the user.

If the new title is indeed different from the old one, a LayerEvent is delivered to the observers with the property name PropertyTitle.

Parameters

title the new title.

Implements luciad::Layer.

◆ setVisible()

void luciad::FeatureLayer::setVisible ( bool visible )

overridevirtual

Sets whether this layer is visible.

Changes this layer's visibility. If the new visibility is different from the old one, a LayerEvent is delivered to the observers with the property name PropertyVisible.

Parameters

visible the new visibility.

Implements luciad::Layer.

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~FeatureLayer()

Member Function Documentation

◆ addObserver()

◆ asBuilder()

◆ getDensitySettings()

◆ getEditConfiguration()

◆ getEditCreateGeometryProvider()

◆ getLoadingStrategy()

◆ getModel()

◆ getPainter()

◆ getQueryConfiguration()

◆ getTitle()

◆ isBusy()

◆ isEditable()

◆ isLabeled()

◆ isQueryable()

◆ isVisible()

◆ newBuilder()

◆ propertyDensitySettings()

◆ propertyEditable()

◆ propertyLabeled()

◆ propertyPainter()

◆ propertyQueryable()

◆ removeObserver()

◆ setDensitySettings()

◆ setEditable()

◆ setLabeled()

◆ setPainter()

◆ setQueryable()

◆ setTitle()

◆ setVisible()