LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::Editor Class Referencefinal

This class allows you to interactively edit Features on the Map. More...

#include <luciad/edit/Editor.h>

Classes

class  Builder
 Builder for the Editor class. More...
 

Public Member Functions

 ~Editor ()
 
std::shared_ptr< FeatureLayergetEditHandleLayer () const
 Returns the layer that paint IEditHandles. More...
 
EventResult onEvent (const std::shared_ptr< IInputEvent > &inputEvent)
 Handles the given event, and returns if the event was handled or not. More...
 

Static Public Member Functions

static Builder newBuilder ()
 Returns a new builder for creating an Editor. More...
 

Detailed Description

This class allows you to interactively edit Features on the Map.

See the related guide for an overview of the editing API.

It manages the editing state and provides visualization capabilities by:

Editing can be configured using:

It is allowed to access this class on the UI thread only. See the related article: Threading rules for the Map

Since
2020.1

Constructor & Destructor Documentation

◆ ~Editor()

luciad::Editor::~Editor ( )

Member Function Documentation

◆ getEditHandleLayer()

std::shared_ptr< FeatureLayer > luciad::Editor::getEditHandleLayer ( ) const

Returns the layer that paint IEditHandles.

This layer can contain the edit handles of multiple feature layers. The returned layer instance will always be the same, but the layer's model gets updated as edit handles are added, removed or modified.

A controller implementation typically adds this layer to its layer list, although it can also add this layer to the Map's layer list.

Returns
the layer that paint IEditHandles.

◆ newBuilder()

static Builder luciad::Editor::newBuilder ( )
static

Returns a new builder for creating an Editor.

Returns
a new builder for creating an Editor.

◆ onEvent()

EventResult luciad::Editor::onEvent ( const std::shared_ptr< IInputEvent > &  inputEvent)

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

This method delegates the given event to one of the currently available handles. The order in which this event is passed to the handles is determined by the handle's state, and the order in which they are returned from IEditHandles:

  • Active handles have priority over Highlighted handles, and Highlighted handles have priority over Inactive handles.
  • If multiple handles have the same state, the order in which they are returned from IEditHandles is used
Parameters
inputEventan event, cannot be nullptr.
Returns
if the event was consumed or not
Exceptions
NullArgumentExceptionwhen nullptr is passed.