LuciadCPillar C# 2023.1.04
Luciad.Create.Features.FeatureCreator Class Reference

This class can create feature instances, based on a geometry. More...

Inheritance diagram for Luciad.Create.Features.FeatureCreator:
Luciad.Create.Features.IFeatureCreator

Public Member Functions

 FeatureCreator (Luciad.Models.Features.Feature initialFeature, Luciad.Create.Geometries.IGeometryCreator geometryCreator)
 
void Dispose ()
 
Luciad.Controllers.EventResult OnEvent (Luciad.Input.IInputEvent inputEvent, Luciad.Create.Features.FeatureCreateContext context)
 Handles the given event, and returns if the event was handled or not. More...
 
void Start (Luciad.Create.Features.IFeatureCreateCallback callback, Luciad.Create.Features.FeatureCreateContext context)
 This method is called to start creation. More...
 
Luciad.Controllers.EventResult OnEvent (Luciad.Input.IInputEvent inputEvent, Luciad.Create.Features.FeatureCreateContext context)
 Handles the given event, and returns if the event was handled or not. More...
 
void Start (Luciad.Create.Features.IFeatureCreateCallback callback, Luciad.Create.Features.FeatureCreateContext context)
 This method is called to start creation. More...
 

Detailed Description

This class can create feature instances, based on a geometry.

This creator will use an initial feature instance as a base create a geometry on the map fill in the remaining Feature values using the created geometry

This initial Feature must contain the following: (optional) an id. In many cases, models are responsible to assign the id to newly added features. In this case, the Feature must not contain an id. Other models however, allow newly added features to already have an id. In that case, this Feature must have an id. all necessary property values that are needed to correctly apply a geometry on a Feature

This creator doesn't consume any events itself, but it delegates the events to the wrapped geometry creator instance. 2020.1

Creator

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

Constructor & Destructor Documentation

◆ FeatureCreator()

Luciad.Create.Features.FeatureCreator.FeatureCreator ( Luciad.Models.Features.Feature  initialFeature,
Luciad.Create.Geometries.IGeometryCreator  geometryCreator 
)
inline

Member Function Documentation

◆ Dispose()

void Luciad.Create.Features.FeatureCreator.Dispose ( )
inline

◆ OnEvent()

Luciad.Controllers.EventResult Luciad.Create.Features.FeatureCreator.OnEvent ( Luciad.Input.IInputEvent  inputEvent,
Luciad.Create.Features.FeatureCreateContext  context 
)
inline

Handles the given event, and returns if the event was handled or not.

context

the creation context, cannot be nullptr

inputEvent

an event, cannot be nullptr

if the event was consumed or not

NullArgumentException

when nullptr is passed.

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

Implements Luciad.Create.Features.IFeatureCreator.

◆ Start()

void Luciad.Create.Features.FeatureCreator.Start ( Luciad.Create.Features.IFeatureCreateCallback  callback,
Luciad.Create.Features.FeatureCreateContext  context 
)
inline

This method is called to start creation.

After this call, IFeatureCreator::onEvent can be called. When a IFeatureCreator was started, it can not be started again until it has stopped. Implementations of this method are encouraged to throw an exception in that case to signal a programming error by the caller of this method.

context

the creation context, cannot be nullptr

callback

the callback to signal feature changes, and whether creation for the feature has finished, cannot be nullptr.

NullArgumentException

when nullptr is passed.

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

Implements Luciad.Create.Features.IFeatureCreator.