LuciadCPillar C# 2023.1.02
Luciad.Edit.Geometries.IGeometryHandlesProvider Interface Reference

This class can provide edit handles for a given Geometry. More...

Inheritance diagram for Luciad.Edit.Geometries.IGeometryHandlesProvider:
Luciad.Edit.Geometries.CompositeGeometryHandlesProvider Luciad.Edit.Geometries.PatchHandlesProvider Luciad.Edit.Geometries.PointHandlesProvider Luciad.Edit.Geometries.PolylineHandlesProvider Luciad.Edit.Geometries.PolylineRingHandlesProvider

Public Member Functions

bool CanProvide (Luciad.Utils.Observable< Luciad.Geometries.Geometry > geometry, Luciad.Edit.Features.FeatureEditContext context)
 Indicates if this handles provider can create handles for the given geometry. More...
 
Luciad.Edit.Handles.IEditHandles Provide (Luciad.Utils.Observable< Luciad.Geometries.Geometry > geometry, Luciad.Edit.Features.FeatureEditContext context, Luciad.Edit.Geometries.IGeometryEditCallback geometryEditCallback)
 Returns the handles for the given feature. More...
 
Luciad.Edit.Handles.ITranslateEditAction ProvideTranslateAction (Luciad.Utils.Observable< Luciad.Geometries.Geometry > geometry, Luciad.Edit.Features.FeatureEditContext context, Luciad.Edit.Geometries.IGeometryEditCallback geometryEditCallback)
 Provides a translate action that can be used by the caller to add translation behavior. More...
 

Detailed Description

This class can provide edit handles for a given Geometry.

The given Geometry is passed to this provider as an Observable. This object allows Editor to communicate geometry changes to the IEditHandles implementations, who can use it to create and update their collection of handles. Editing changes originating from IEditHandles are communicated to the Editor or handles wrappers by calling IGeometryEditCallback. See also the related guide on editing interactions. This class is typically used in the context of feature editing, when a feature is edited by modifying its geometry. It has a default implementation that supports many geometries. See the related guide for an overview of the editing API. 2020.1

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

Member Function Documentation

◆ CanProvide()

bool Luciad.Edit.Geometries.IGeometryHandlesProvider.CanProvide ( Luciad.Utils.Observable< Luciad.Geometries.Geometry geometry,
Luciad.Edit.Features.FeatureEditContext  context 
)

Indicates if this handles provider can create handles for the given geometry.

geometry

an observable geometry, cannot be nullptr

context

the context. Contains additional information about the edited feature, cannot be nullptr.

if this handles provider can provide handles and a translate action for the given Feature

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

Implemented in Luciad.Edit.Geometries.CompositeGeometryHandlesProvider, Luciad.Edit.Geometries.PatchHandlesProvider, Luciad.Edit.Geometries.PointHandlesProvider, Luciad.Edit.Geometries.PolylineHandlesProvider, and Luciad.Edit.Geometries.PolylineRingHandlesProvider.

◆ Provide()

Luciad.Edit.Handles.IEditHandles Luciad.Edit.Geometries.IGeometryHandlesProvider.Provide ( Luciad.Utils.Observable< Luciad.Geometries.Geometry geometry,
Luciad.Edit.Features.FeatureEditContext  context,
Luciad.Edit.Geometries.IGeometryEditCallback  geometryEditCallback 
)

Returns the handles for the given feature.

Note: translation of features is handled by IFeatureHandlesProvider. So geometry handles providers should not provide handles to translate a geometry.

geometry

the observable geometry for which to provide handles, cannot be nullptr.

context

the context. Contains additional information about the edited feature, cannot be nullptr.

geometryEditCallback

a callback that notifies the caller when the Feature has changed, cannot be nullptr.

handles for the given feature. Never nullptr.

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

Implemented in Luciad.Edit.Geometries.CompositeGeometryHandlesProvider, Luciad.Edit.Geometries.PatchHandlesProvider, Luciad.Edit.Geometries.PointHandlesProvider, Luciad.Edit.Geometries.PolylineHandlesProvider, and Luciad.Edit.Geometries.PolylineRingHandlesProvider.

◆ ProvideTranslateAction()

Luciad.Edit.Handles.ITranslateEditAction Luciad.Edit.Geometries.IGeometryHandlesProvider.ProvideTranslateAction ( Luciad.Utils.Observable< Luciad.Geometries.Geometry geometry,
Luciad.Edit.Features.FeatureEditContext  context,
Luciad.Edit.Geometries.IGeometryEditCallback  geometryEditCallback 
)

Provides a translate action that can be used by the caller to add translation behavior.

A translation handle is typically added by an IFeatureHandlesProvider, like for example the FeatureHandlesProvider implementation. It calls this method to retrieve a translate action, and uses it to create a TranslateEditHandle. When ITranslateEditAction::translate is called, the returned implementation must: apply a translation on the geometry apply this IGeometryHandlesProvider's constraint (if configured) on the translated geometry call IGeometryEditCallback with the resulting geometry

geometry

the observable geometry for which to provide a translate action, cannot be nullptr

context

the context, cannot be nullptr

geometryEditCallback

a callback that notifies the caller of this method when a translation has occurred, cannot be nullptr

a translate action. Never nullptr.

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

Implemented in Luciad.Edit.Geometries.CompositeGeometryHandlesProvider, Luciad.Edit.Geometries.PatchHandlesProvider, Luciad.Edit.Geometries.PointHandlesProvider, Luciad.Edit.Geometries.PolylineHandlesProvider, and Luciad.Edit.Geometries.PolylineRingHandlesProvider.