This handle represents a line on the Map and can be visualized using a line. More...

#include <luciad/edit/handles/LineEditHandle.h>

Inheritance diagram for luciad::LineEditHandle:

Public Member Functions
	LineEditHandle (const LineEditHandle &other)=delete

	LineEditHandle (std::shared_ptr< Geometry > geometry)
	Creates a new LineEditHandle without associated actions. More...

	LineEditHandle (std::shared_ptr< Observable< std::shared_ptr< Geometry > > > geometryProvider)
	Creates a LineEditHandle without associated actions. More...

	~LineEditHandle () override

void	addEditStateObserver (std::shared_ptr< IInvalidationCallback > observer) override
	Adds an observer that is called when the `edit state` of this handle has changed. More...

EditActionBinder &	addOnClickAction (std::shared_ptr< IPointEditAction > action, size_t clickCount)
	Adds an action that will be triggered when the handle is clicked or tapped (touch). More...

EditActionBinder &	addOnDragAction (std::shared_ptr< IPointEditAction > action)
	Adds an action that will be triggered when the handle is dragged. More...

EditActionBinder &	addOnMouseMoveAction (std::shared_ptr< IPointEditAction > action)
	Adds an action that will be executed on every mouse move. More...

EditActionBinder &	addOnTouchLongPressAction (std::shared_ptr< IPointEditAction > action)
	Adds an action that will be triggered when a long press is performed on a handle. More...

const std::optional< LineStyle > &	getActiveLineStyle () const
	Returns the visual aid line style to use when this handle is in an `active` state. More...

EditHandleState	getEditState () const override
	Returns the current state of this handle. More...

std::shared_ptr< Geometry >	getGeometry () const
	Returns the current geometry of this handle. More...

std::shared_ptr< Observable< std::shared_ptr< Geometry > > >	getGeometryProvider () const
	Returns the geometry provider of this handle. More...

const std::optional< LineStyle > &	getHighlightedLineStyle () const
	Returns the visual aid line style to use when this handle is in a `highlighted` state. More...

std::optional< MouseCursor >	getMouseCursor () const override
	Returns the current mouse cursor that should be displayed for this handle. More...

const std::optional< LineStyle > &	getRegularLineStyle () const
	Returns the visual aid line style to use when this handle is in an `inactive` state. More...

ZOrder	getZOrder () const
	Returns the Z-order that is used for this handle's paint calls to the `FeatureCanvas`. More...

EventResult	onEvent (const std::shared_ptr< IInputEvent > &inputEvent, const std::shared_ptr< FeatureEditContext > &context) override
	Handles the given event, and returns if the event was consumed or not. More...

void	paint (FeatureCanvas &canvas, const std::shared_ptr< FeatureEditContext > &context) const override
	Paints this handle on the given canvas. More...

void	removeEditStateObserver (const std::shared_ptr< IInvalidationCallback > &observer) override
	Removes the given observer. More...

void	setActiveLineStyle (std::optional< LineStyle > lineStyle)
	Sets the line style to use when this handle is in an `active` state. More...

void	setHighlightedLineStyle (std::optional< LineStyle > lineStyle)
	Sets the line style to use when this handle is in a `highlighted` state. More...

void	setInvalidationCallback (std::shared_ptr< IInvalidationCallback > invalidationCallback) override
	Sets the callback for the handle to call when its visual representation or cursor has changed. More...

void	setRegularLineStyle (std::optional< LineStyle > lineStyle)
	Sets the line style to use when this handle is in an `inactive` state. More...

void	setZOrder (ZOrder zOrder)
	Sets the Z-order that is used for this handle's paint calls to the `FeatureCanvas`. More...

Public Member Functions inherited from luciad::IEditHandle
	IEditHandle ()
	Creates a new edit handle instance. More...

virtual	~IEditHandle ()=default

virtual void	addEditStateObserver (std::shared_ptr< IInvalidationCallback > observer)=0
	Adds an observer that is called when the `edit state` of this handle has changed. More...

virtual EditHandleState	getEditState () const =0
	Returns the current state of this handle. More...

virtual std::optional< MouseCursor >	getMouseCursor () const =0
	Returns the current mouse cursor that should be displayed for this handle. More...

virtual EventResult	onEvent (const std::shared_ptr< IInputEvent > &inputEvent, const std::shared_ptr< FeatureEditContext > &context)=0
	Handles the given event, and returns if the event was consumed or not. More...

virtual void	paint (FeatureCanvas &canvas, const std::shared_ptr< FeatureEditContext > &context) const =0
	Paints this handle on the given canvas. More...

virtual void	removeEditStateObserver (const std::shared_ptr< IInvalidationCallback > &observer)=0
	Removes the given observer. More...

virtual void	setInvalidationCallback (std::shared_ptr< IInvalidationCallback > invalidationCallback)=0
	Sets the callback for the handle to call when its visual representation or cursor has changed. More...

Detailed Description

This handle represents a line on the Map and can be visualized using a line.

It can be moved around, or react to mouse events.

The handle executes IPointEditAction, based on mouse input events. IEditHandles implementations configure concrete IPointEditAction implementations on this handle to make sure they result in geometry or feature changes. For example, when this handle is dragged around on the Map, an IEditHandles implementation for circles can make sure that the circle can expand/shrink.

This class supports the following gestures:

This handle is painted using the provided geometry.

Since: 2025.0

Constructor & Destructor Documentation

◆ LineEditHandle() [1/3]

luciad::LineEditHandle::LineEditHandle ( std::shared_ptr< Geometry > geometry )

explicit

Creates a new LineEditHandle without associated actions.

Parameters

geometry the initial geometry of the handle, cannot be nullptr

◆ LineEditHandle() [2/3]

luciad::LineEditHandle::LineEditHandle ( std::shared_ptr< Observable< std::shared_ptr< Geometry > > > geometryProvider )

explicit

Creates a LineEditHandle without associated actions.

Parameters

geometryProvider the geometry provider of the handle. The handle assumes the geometry of this point upon construction, while also observing the geometry to adjust its own shape whenever the observable geometry changes; cannot be nullptr.

◆ LineEditHandle() [3/3]

luciad::LineEditHandle::LineEditHandle ( const LineEditHandle & other )

delete

◆ ~LineEditHandle()

luciad::LineEditHandle::~LineEditHandle ( )

override

Member Function Documentation

◆ addEditStateObserver()

void luciad::LineEditHandle::addEditStateObserver ( std::shared_ptr< IInvalidationCallback > observer )

overridevirtual

Adds an observer that is called when the edit state of this handle has changed.

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

Parameters

observer an observer

Exceptions

InvalidArgumentException when the observer was already added.

Since: 2023.1

Implements luciad::IEditHandle.

◆ addOnClickAction()

EditActionBinder & luciad::LineEditHandle::addOnClickAction	(	std::shared_ptr< IPointEditAction >	action,
		size_t	clickCount
	)

Adds an action that will be triggered when the handle is clicked or tapped (touch).

Parameters

action	the action to be performed, cannot be `nullptr`.
clickCount	the action will only be performed when an event is received with this click count.

Returns: an object to specify more options or requirements for the given on-click action, such as the mouse buttons that need to be pressed for the action to be executed.

◆ addOnDragAction()

EditActionBinder & luciad::LineEditHandle::addOnDragAction ( std::shared_ptr< IPointEditAction > action )

Adds an action that will be triggered when the handle is dragged.

The given action is executed at least when the drag gesture starts and ends, and if EditActionBinder::performOnIntermediateEvents is set to true, it also gets executed on every intermediate drag event. The action is always called with an EventStatus parameter corresponding to the drag event.

Parameters

action the action to be performed on drag, cannot be nullptr.

Returns: an object to specify more options or requirements for the given on-drag action, such as the mouse buttons that need to be pressed for the action to be executed.

◆ addOnMouseMoveAction()

EditActionBinder & luciad::LineEditHandle::addOnMouseMoveAction ( std::shared_ptr< IPointEditAction > action )

Adds an action that will be executed on every mouse move.

Parameters

action the action to be performed during the mouse move, cannot be nullptr.

Returns: an object to specify more options or requirements for the given action, such as the modifier keys that need to be pressed for the action to be executed.

◆ addOnTouchLongPressAction()

EditActionBinder & luciad::LineEditHandle::addOnTouchLongPressAction ( std::shared_ptr< IPointEditAction > action )

Adds an action that will be triggered when a long press is performed on a handle.

Parameters

action the action to be performed, cannot be nullptr.

Returns: an object to specify more options or requirements for the given on-drag action

◆ getActiveLineStyle()

const std::optional< LineStyle > & luciad::LineEditHandle::getActiveLineStyle ( ) const

Returns the visual aid line style to use when this handle is in an active state.

Returns: The visual aid line style to use when this handle is in an active state.

◆ getEditState()

EditHandleState luciad::LineEditHandle::getEditState ( ) const

overridevirtual

Returns the current state of this handle.

Returns: the current state of this handle.

Implements luciad::IEditHandle.

◆ getGeometry()

std::shared_ptr< Geometry > luciad::LineEditHandle::getGeometry ( ) const

Returns the current geometry of this handle.

Note that this geometry is not necessarily equal to the geometry provider at all times. For example, they may differ when the handle is dragged around and no geometry changes are triggered in the geometry provider.

Returns: the current geometry of this handle

◆ getGeometryProvider()

std::shared_ptr< Observable< std::shared_ptr< Geometry > > > luciad::LineEditHandle::getGeometryProvider ( ) const

Returns the geometry provider of this handle.

Note that the handle's current geometry is not necessarily equal to this geometry provider at all times. For example, they may differ when the handle is dragged around and no geometry changes are triggered in this geometry provider.

Returns: the geometry provider of this handle. Never nullptr.

◆ getHighlightedLineStyle()

const std::optional< LineStyle > & luciad::LineEditHandle::getHighlightedLineStyle ( ) const

Returns the visual aid line style to use when this handle is in a highlighted state.

Returns: The visual aid line style to use when this handle is in a highlighted state.

◆ getMouseCursor()

std::optional< MouseCursor > luciad::LineEditHandle::getMouseCursor ( ) const

overridevirtual

Returns the current mouse cursor that should be displayed for this handle.

This method typically returns a value when this handle is highlighted or active. If not, std::nullopt can be returned.

Returns: the current mouse cursor that should be displayed for this handle.

Implements luciad::IEditHandle.

◆ getRegularLineStyle()

const std::optional< LineStyle > & luciad::LineEditHandle::getRegularLineStyle ( ) const

Returns the visual aid line style to use when this handle is in an inactive state.

Returns: The visual aid line style to use when this handle is in an inactive state.

◆ getZOrder()

ZOrder luciad::LineEditHandle::getZOrder ( ) const

Returns the Z-order that is used for this handle's paint calls to the FeatureCanvas.

Returns: the Z-order that is used for this handle's paint calls to the FeatureCanvas.

See also: setZOrder.; FeatureCanvas draw commands. For example FeatureCanvas::GeometryDrawCommand::zOrder.

◆ onEvent()

EventResult luciad::LineEditHandle::onEvent	(	const std::shared_ptr< IInputEvent > &	inputEvent,
		const std::shared_ptr< FeatureEditContext > &	context
	)

overridevirtual

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

While handling events, IEditHandles can mark themselves as highlighted or as Active. Related to event handling, the main effect of this is that highlighted or active handles get a higher priority compared to other handles: they get the chance to consume events first. See EditHandleState

Parameters

inputEvent	the event to handle, cannot be `nullptr`
context	the context, cannot be `nullptr`

Returns: if the event was consumed or not

Exceptions

NullArgumentException when nullptr is passed.

Implements luciad::IEditHandle.

◆ paint()

void luciad::LineEditHandle::paint	(	FeatureCanvas &	canvas,
		const std::shared_ptr< FeatureEditContext > &	context
	)		const

overridevirtual

Paints this handle on the given canvas.

This method is called when

the handle's IEditHandles fires an EditHandlesEvent containing this handle, when the handle is newly added or removed for example.
the handle triggers a new paint call itself by calling its invalidation callback.

This method only gets called on the UI thread, so there is no need for additional synchronization.

Parameters

canvas	the canvas on which this handle gets painted.
context	the context, cannot be `nullptr`

Implements luciad::IEditHandle.

◆ removeEditStateObserver()

void luciad::LineEditHandle::removeEditStateObserver ( const std::shared_ptr< IInvalidationCallback > & observer )

overridevirtual

Removes the given observer.

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

Parameters

observer an observer

Exceptions

InvalidArgumentException when the observer is not known.

Since: 2023.1

Implements luciad::IEditHandle.

◆ setActiveLineStyle()

void luciad::LineEditHandle::setActiveLineStyle ( std::optional< LineStyle > lineStyle )

Sets the line style to use when this handle is in an active state.

Parameters

lineStyle The line style to use when this handle is in an active state.

◆ setHighlightedLineStyle()

void luciad::LineEditHandle::setHighlightedLineStyle ( std::optional< LineStyle > lineStyle )

Sets the line style to use when this handle is in a highlighted state.

Parameters

lineStyle The line style to use when this handle is in a highlighted state.

◆ setInvalidationCallback()

void luciad::LineEditHandle::setInvalidationCallback ( std::shared_ptr< IInvalidationCallback > invalidationCallback )

overridevirtual

Sets the callback for the handle to call when its visual representation or cursor has changed.

Calling this callback triggers a new call to this handle's paint method.

Parameters

invalidationCallback the callback for the handle to call when its visual representation has changed

Implements luciad::IEditHandle.

◆ setRegularLineStyle()

void luciad::LineEditHandle::setRegularLineStyle ( std::optional< LineStyle > lineStyle )

Sets the line style to use when this handle is in an inactive state.

Parameters

lineStyle The line style to use when this handle is in an inactive state.

◆ setZOrder()

void luciad::LineEditHandle::setZOrder ( ZOrder zOrder )

Sets the Z-order that is used for this handle's paint calls to the FeatureCanvas.

This Z-order determines which handles are painted on top, when multiple handles overlap. Edit handles with a higher Z-order are painted on top of handles with a lower Z-order. Note: Highlighted edit handles are always painted above regular handles, and active handles are always painted above highlighted handles.

Must be between [-1000,1000]. The default value is 0.

Parameters

zOrder the Z-order that is used for this handle's paint calls to the FeatureCanvas.

See also: FeatureCanvas draw commands. For example FeatureCanvas::GeometryDrawCommand::zOrder.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LineEditHandle() [1/3]

◆ LineEditHandle() [2/3]

◆ LineEditHandle() [3/3]

◆ ~LineEditHandle()

Member Function Documentation

◆ addEditStateObserver()

◆ addOnClickAction()

◆ addOnDragAction()

◆ addOnMouseMoveAction()

◆ addOnTouchLongPressAction()

◆ getActiveLineStyle()

◆ getEditState()

◆ getGeometry()

◆ getGeometryProvider()

◆ getHighlightedLineStyle()

◆ getMouseCursor()

◆ getRegularLineStyle()

◆ getZOrder()

◆ onEvent()

◆ paint()

◆ removeEditStateObserver()

◆ setActiveLineStyle()

◆ setHighlightedLineStyle()

◆ setInvalidationCallback()

◆ setRegularLineStyle()

◆ setZOrder()