LuciadCPillar C# 2023.1.04
Luciad.Edit.Geometries.CompositeGeometryHandlesProvider Class Reference

A composite implementation of IGeometryHandlesProvider. More...

Inheritance diagram for Luciad.Edit.Geometries.CompositeGeometryHandlesProvider:
Luciad.Edit.Geometries.IGeometryHandlesProvider

Public Member Functions

 CompositeGeometryHandlesProvider ()
 
void Add (IGeometryHandlesProvider handlesProvider, Containers.Priority? priority=null)
 
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...
 
void Dispose ()
 
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...
 
void Remove (Luciad.Edit.Geometries.IGeometryHandlesProvider handlesProvider)
 
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...
 

Static Public Member Functions

static Luciad.Edit.Geometries.CompositeGeometryHandlesProvider CreateDefault ()
 

Properties

System.Collections.Generic.IList< Luciad.Edit.Geometries.IGeometryHandlesProviderList [get]
 

Detailed Description

A composite implementation of IGeometryHandlesProvider.

This composite allows you to: add instances: CompositeGeometryHandlesProvider::add remove instances: CompositeGeometryHandlesProvider::remove retrieve instances: CompositeGeometryHandlesProvider::getList

The composite implementation uses its delegate instances in a specific order. The order is based on the priority you assign when you add the delegate instance. If the priorities of two instances are equal, the instance that you added first gets priority. A default implementation is available, see createDefault. 2020.1

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

Constructor & Destructor Documentation

◆ CompositeGeometryHandlesProvider()

Luciad.Edit.Geometries.CompositeGeometryHandlesProvider.CompositeGeometryHandlesProvider ( )
inline

Member Function Documentation

◆ Add()

void Luciad.Edit.Geometries.CompositeGeometryHandlesProvider.Add ( IGeometryHandlesProvider  handlesProvider,
Containers.Priority priority = null 
)
inline

◆ CanProvide()

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

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.

Implements Luciad.Edit.Geometries.IGeometryHandlesProvider.

◆ CreateDefault()

static Luciad.Edit.Geometries.CompositeGeometryHandlesProvider Luciad.Edit.Geometries.CompositeGeometryHandlesProvider.CreateDefault ( )
inlinestatic

◆ Dispose()

void Luciad.Edit.Geometries.CompositeGeometryHandlesProvider.Dispose ( )
inline

◆ Provide()

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

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.

Implements Luciad.Edit.Geometries.IGeometryHandlesProvider.

◆ ProvideTranslateAction()

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

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.

Implements Luciad.Edit.Geometries.IGeometryHandlesProvider.

◆ Remove()

void Luciad.Edit.Geometries.CompositeGeometryHandlesProvider.Remove ( Luciad.Edit.Geometries.IGeometryHandlesProvider  handlesProvider)
inline

Property Documentation

◆ List

System.Collections.Generic.IList<Luciad.Edit.Geometries.IGeometryHandlesProvider> Luciad.Edit.Geometries.CompositeGeometryHandlesProvider.List
get