LuciadCPillar C# 2023.1.04
Luciad.Create.Features.IFeatureCreator Interface Reference

A feature creator can create feature instances, based on input events. More...

Inheritance diagram for Luciad.Create.Features.IFeatureCreator:
Luciad.Create.Features.FeatureCreator Luciad.Symbology.Military.MilitarySymbolFeatureCreator

Public Member Functions

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

A feature creator can create feature instances, based on input events.

It uses a callback to signal changes to the feature or to signal that the creation has finished. Users of this class need to explicitly start creation send events to the creator listen to feature changes stop sending events when creation has finished

IFeatureCreator instances can be used multiple times. Creating a new instance should only start after the last one has finished. 2020.1

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

Member Function Documentation

◆ OnEvent()

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

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.

Implemented in Luciad.Create.Features.FeatureCreator.

◆ Start()

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

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.

Implemented in Luciad.Create.Features.FeatureCreator.