LuciadCPillar C# 2023.1.04
Luciad.Edit.Geometries.PointHandlesProvider.IHandleFactory Interface Reference

Allows you to specify which handles are created by this handles provider. More...

Public Member Functions

Handles.IEditHandle CreateElevationPointHandle (Utils.Observable< Luciad.Geometries.Point > point, Handles.IPointEditAction editAction, Features.FeatureEditContext context)
 Creates a handle that allows you to move the Point vertically. More...
 
bool IsElevationPointHandleValid (Handles.IEditHandle elevationHandle, Utils.Observable< Luciad.Geometries.Point > point, Features.FeatureEditContext context)
 Returns true if the given handle is still valid, or false if it should be removed. More...
 

Detailed Description

Allows you to specify which handles are created by this handles provider.

It allows you to replace handles with other handle implementations (dynamically) disable or re-enable specific handles

Additional handles can not be added using this factory. The way to do this is to wrap the IEditHandles provided by PointHandlesProvider, and to insert additional handles in the IEditHandles::getList method.

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

Member Function Documentation

◆ CreateElevationPointHandle()

Luciad.Edit.Handles.IEditHandle Luciad.Edit.Geometries.PointHandlesProvider.IHandleFactory.CreateElevationPointHandle ( Utils.Observable< Luciad.Geometries.Point point,
Handles.IPointEditAction  editAction,
Features.FeatureEditContext  context 
)

Creates a handle that allows you to move the Point vertically.

This method is only called when a 3D Map is used. While the handle is not already present, this method is called whenever the edited geometry changes.

point

the geometry that is being edited

editAction

the move-point edit action, to be used by the handle. If a constraint was configured on the handles provider, this action applies that constraint when it is executed, providing a PointChange parameter with the translation.

context

the context

a new handle, or nullptr if no handle should be used

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

◆ IsElevationPointHandleValid()

bool Luciad.Edit.Geometries.PointHandlesProvider.IHandleFactory.IsElevationPointHandleValid ( Handles.IEditHandle  elevationHandle,
Utils.Observable< Luciad.Geometries.Point point,
Features.FeatureEditContext  context 
)

Returns true if the given handle is still valid, or false if it should be removed.

This method is called whenever the edited geometry changes and allows the factory to dynamically disable or re-create specific edit handles. When this method returns false, the handle is removed and createElevationPointHandle is called, in case the handle should immediately be re-created. If the handle should remain absent, make sure to also return nullptr in that method.

elevationHandle

the handle

point

the Geometry that is being edited

context

the context

true if the given handle is still valid, or false if it should be removed.

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