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

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

Public Member Functions
	Builder (Builder &&other) noexcept

	Builder (const Builder &other)

	~Builder ()

std::shared_ptr< FeatureLayer >	build () const
	Returns a new layer, based on the properties set on this builder. More...

Builder &	editable (bool editable)
	Sets whether the layer should be editable initially. More...

Builder &	editConfiguration (std::shared_ptr< IFeatureEditConfiguration > editConfiguration)
	Enables editing capabilities using the given `IFeatureEditConfiguration`. More...

Builder &	editCreateGeometryProvider (std::shared_ptr< IFeatureGeometryProvider > geometryProvider)
	Provides the edit/create geometry provider for a Feature. More...

Builder &	labeled (bool labeled)
	Sets whether the layer should display labels initially. More...

Builder &	loadingStrategy (FeatureLayerLoadingStrategy loadingStrategy)
	Sets the `FeatureLayerLoadingStrategy` to use. More...

Builder &	model (std::shared_ptr< IFeatureModel > model)
	Sets the feature model of the layer. More...

Builder &	operator= (Builder other) noexcept

Builder &	painter (std::shared_ptr< IFeaturePainter > featurePainter)
	Sets the `IFeaturePainter` to use. More...

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

Builder &	queryConfiguration (std::shared_ptr< FeatureQueryConfiguration > configuration)
	Sets the query configuration to use. More...

Builder &	title (std::string title)
	Sets the title to use for the layer. More...

Builder &	visible (bool visible)
	Sets whether the layer should be visible initially. More...

Detailed Description

Builder for the luciad::FeatureLayer class.

Constructor & Destructor Documentation

◆ Builder() [1/2]

luciad::FeatureLayer::Builder::Builder ( const Builder & other )

◆ Builder() [2/2]

luciad::FeatureLayer::Builder::Builder ( Builder && other )

noexcept

◆ ~Builder()

luciad::FeatureLayer::Builder::~Builder ( )

Member Function Documentation

◆ build()

std::shared_ptr< FeatureLayer > luciad::FeatureLayer::Builder::build ( ) const

Returns a new layer, based on the properties set on this builder.

Returns: a new layer, based on the properties set on this builder.

Exceptions

luciad::LogicException If not all mandatory parameters are set. If no painter is set and the feature model contains at least one feature data type without a geometry.

◆ editable()

Builder & luciad::FeatureLayer::Builder::editable ( bool editable )

Sets whether the layer should be editable initially.

When an edit configuration is set, the default is true. When no edit configuration is set, the default is false.

When this method is called with true as parameter, and no edit configuration is edit set, a default edit configuration will be used. This default configuration enables editing for all features, using a default handles provider.

Refer to editConfiguration for enabling editing capabilities.

Parameters

editable the edit capability.

Returns: this builder.

See also: FeatureLayer::setEditable for more info.

Since: 2020.1

◆ editConfiguration()

Builder & luciad::FeatureLayer::Builder::editConfiguration ( std::shared_ptr< IFeatureEditConfiguration > editConfiguration )

Enables editing capabilities using the given IFeatureEditConfiguration.

If not set, editing will not be supported, and FeatureLayer::getEditConfiguration will return nullptr. If set, editing will be enabled by default.

Additional configuration for editing can be done using:

Editor::Builder: for more global editing configuration
FeatureLayer::Builder::editCreateGeometryProvider: to determine the edit/create geometry associated with a Feature

Parameters

editConfiguration the feature edit configuration used to edit the feature model. Cannot be nullptr.

Returns: this builder.

Since: 2020.1

Exceptions

luciad::NullArgumentException when the given edit configuration is nullptr

◆ editCreateGeometryProvider()

Builder & luciad::FeatureLayer::Builder::editCreateGeometryProvider ( std::shared_ptr< IFeatureGeometryProvider > geometryProvider )

Provides the edit/create geometry provider for a Feature.

This geometry provider determines using which geometry a Feature can be edited or created, and how to apply this geometry back on the Feature. This implementation is for example used by FeatureHandlesProvider, and by Creator.

Calling this method is optional. When this method is not called, a default implementation will be used. This default implementation assumes that

the Feature has a DataType with a GeometryDataAnnotation that points to the Geometry that can be edited
the changed Geometry can be applied by replacing that Geometry property value, using Feature::asBuilder

Parameters

geometryProvider the edit geometry provider for the current Feature. Cannot be nullptr.

Returns: this

Since: 2020.1

Exceptions

luciad::NullArgumentException when the given geometry provider is nullptr

◆ labeled()

Builder & luciad::FeatureLayer::Builder::labeled ( bool labeled )

Sets whether the layer should display labels initially.

The default is true.

Returns: this builder.

Parameters

labeled whether the layer should display labels initially.

See also: FeatureLayer::setLabeled

Since: 2020.2

◆ loadingStrategy()

Builder & luciad::FeatureLayer::Builder::loadingStrategy ( FeatureLayerLoadingStrategy loadingStrategy )

Sets the FeatureLayerLoadingStrategy to use.

This method is optional. If a loading strategy is not explicitly configured, the LoadSpatially strategy is used. It tries to use the LoadSpatially strategy first. If that strategy is not supported for the layer's model, the LoadEverything strategy is used as fallback.

Parameters

loadingStrategy the loading strategy to use.

Returns: this builder

Since: 2023.0.02

◆ model()

Builder & luciad::FeatureLayer::Builder::model ( std::shared_ptr< IFeatureModel > model )

Sets the feature model of the layer.

Calling this function is mandatory.

Parameters

model the feature model of the layer. Cannot be nullptr.

Returns: this builder.

Exceptions

luciad::NullArgumentException when the given model is nullptr.

◆ operator=()

Builder & luciad::FeatureLayer::Builder::operator= ( Builder other )

noexcept

◆ painter()

Builder & luciad::FeatureLayer::Builder::painter ( std::shared_ptr< IFeaturePainter > featurePainter )

Sets the IFeaturePainter to use.

If not set, a default painter will be used. The default painter relies on the feature model having all of its feature data types containing a geometry annotation.

Parameters

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

Returns: this builder.

Exceptions

luciad::NullArgumentException when the given feature painter is nullptr

◆ queryable()

Builder & luciad::FeatureLayer::Builder::queryable ( bool queryable )

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

The default is true.

Parameters

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

Returns: this builder

See also: FeatureLayer::setQueryable

Since: 2023.1

◆ queryConfiguration()

Builder & luciad::FeatureLayer::Builder::queryConfiguration ( std::shared_ptr< FeatureQueryConfiguration > configuration )

Sets the query configuration to use.

The query configuration determines which features to load based on the current map's scale. If not set, a default configuration will be used that always loads all features.

Parameters

configuration the query configuration. Cannot be nullptr.

Returns: this builder

Exceptions

luciad::NullArgumentException when the given query configuration is nullptr

◆ title()

Builder & luciad::FeatureLayer::Builder::title ( std::string title )

Sets the title to use for the layer.

If not set, the title from the ModelMetadata is used.

Parameters

title the title for the layer.

Returns: this builder.

◆ visible()

Builder & luciad::FeatureLayer::Builder::visible ( bool visible )

Sets whether the layer should be visible initially.

Default is true.

Parameters

visible the visibility.

Returns: this builder.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder() [1/2]

◆ Builder() [2/2]

◆ ~Builder()

Member Function Documentation

◆ build()

◆ editable()

◆ editConfiguration()

◆ editCreateGeometryProvider()

◆ labeled()

◆ loadingStrategy()

◆ model()

◆ operator=()

◆ painter()

◆ queryable()

◆ queryConfiguration()

◆ title()

◆ visible()