LuciadCPillar C# 2023.1.04
Luciad.Edit.Features.FeatureStateEditCandidateProvider Class Reference

This IFeatureEditCandidateProvider uses enabled FeatureStates to determine editing candidates. More...

Inheritance diagram for Luciad.Edit.Features.FeatureStateEditCandidateProvider:
Luciad.Edit.Features.IFeatureEditCandidateProvider

Public Member Functions

 FeatureStateEditCandidateProvider (Luciad.Maps.Map map, Luciad.Layers.Features.FeatureState featureState)
 
void AddObserver (Luciad.Edit.Features.IFeatureEditCandidateObserver observer)
 Adds an observer that allows you to receive change events from this edit candidate provider. More...
 
void Dispose ()
 
System.Collections.Generic.IList< Luciad.Layers.Features.LayerFeatureIdGetEditCandidates ()
 
void RemoveObserver (Luciad.Edit.Features.IFeatureEditCandidateObserver observer)
 Removes the given observer. More...
 
void AddObserver (Luciad.Edit.Features.IFeatureEditCandidateObserver observer)
 Adds an observer that allows you to receive change events from this edit candidate provider. More...
 
System.Collections.Generic.IList< Luciad.Layers.Features.LayerFeatureIdGetEditCandidates ()
 
void RemoveObserver (Luciad.Edit.Features.IFeatureEditCandidateObserver observer)
 Removes the given observer. More...
 

Detailed Description

This IFeatureEditCandidateProvider uses enabled FeatureStates to determine editing candidates.

It can for example provide: selected objects (FeatureState::selected()) hovered-over objects (FeatureState::hover())

2020.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureStateEditCandidateProvider.

Constructor & Destructor Documentation

◆ FeatureStateEditCandidateProvider()

Luciad.Edit.Features.FeatureStateEditCandidateProvider.FeatureStateEditCandidateProvider ( Luciad.Maps.Map  map,
Luciad.Layers.Features.FeatureState  featureState 
)
inline

Member Function Documentation

◆ AddObserver()

void Luciad.Edit.Features.FeatureStateEditCandidateProvider.AddObserver ( Luciad.Edit.Features.IFeatureEditCandidateObserver  observer)
inline

Adds an observer that allows you to receive change events from this edit candidate provider.

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

observer

an observer

luciad::InvalidArgumentException

when the observer was already added.

luciad::NullArgumentException

when the observer is nullptr.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::IFeatureEditCandidateProvider::addObserver.

Implements Luciad.Edit.Features.IFeatureEditCandidateProvider.

◆ Dispose()

void Luciad.Edit.Features.FeatureStateEditCandidateProvider.Dispose ( )
inline

◆ GetEditCandidates()

System.Collections.Generic.IList< Luciad.Layers.Features.LayerFeatureId > Luciad.Edit.Features.FeatureStateEditCandidateProvider.GetEditCandidates ( )
inline

the list of edit candidates

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::IFeatureEditCandidateProvider::getEditCandidates.

Implements Luciad.Edit.Features.IFeatureEditCandidateProvider.

◆ RemoveObserver()

void Luciad.Edit.Features.FeatureStateEditCandidateProvider.RemoveObserver ( Luciad.Edit.Features.IFeatureEditCandidateObserver  observer)
inline

Removes the given observer.

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

observer

an observer

luciad::InvalidArgumentException

when the observer is not known.

luciad::NullArgumentException

when the observer is nullptr.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::IFeatureEditCandidateProvider::removeObserver.

Implements Luciad.Edit.Features.IFeatureEditCandidateProvider.