Luciad.Edit.Geometries.PointHandlesProvider Class Reference

This handles provider can create handles to edit Point geometries. More...

Inheritance diagram for Luciad.Edit.Geometries.PointHandlesProvider:

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

Public Member Functions
	PointHandlesProvider ()
	Creates a new PointHandlesProvider that can create handles to modify Point geometries. More...
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...
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...

Properties
Luciad.Geometries.Constraints.IPointConstraint	Constraint [get, set]
	The constraint that is applied to the handles' edit actions. More...
Luciad.Edit.Geometries.PointHandlesProvider.IHandleFactory	HandleFactory [get, set]
	The handle factory used by the handles provider. More...

Detailed Description

This handles provider can create handles to edit Point geometries.

The handles provider offers the following handles:

• A handle to change the height of the point. Note that the default implementation of PointHandlesProvider.IHandleFactory automatically omits these handles on a 2D map, or on a 3D map when for points without elevation.

Note: the handle to translate the entire feature is typically created by the IFeatureHandlesProvider. FeatureHandlesProvider does this by default.

Since

2020.1

Constructor & Destructor Documentation

PointHandlesProvider()

Luciad.Edit.Geometries.PointHandlesProvider.PointHandlesProvider ( )

inline

Creates a new PointHandlesProvider that can create handles to modify Point geometries.

Member Function Documentation

CanProvide()

bool Luciad.Edit.Geometries.PointHandlesProvider.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.

Parameters

geometry	an observable geometry, cannot be null
context	the context. Contains additional information about the edited feature, cannot be null.

Returns

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

Implements Luciad.Edit.Geometries.IGeometryHandlesProvider.

Dispose()

void Luciad.Edit.Geometries.PointHandlesProvider.Dispose ( )

inline

Provide()

Luciad.Edit.Handles.IEditHandles Luciad.Edit.Geometries.PointHandlesProvider.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.

Parameters

geometry	the observable geometry for which to provide handles, cannot be null.
context	the context. Contains additional information about the edited feature, cannot be null.
geometryEditCallback	a callback that notifies the caller when the Feature has changed, cannot be null.

Returns

handles for the given feature. Never null.

Implements Luciad.Edit.Geometries.IGeometryHandlesProvider.

ProvideTranslateAction()

Luciad.Edit.Handles.ITranslateEditAction Luciad.Edit.Geometries.PointHandlesProvider.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

Parameters

geometry	the observable geometry for which to provide a translate action, cannot be null
context	the context, cannot be null
geometryEditCallback	a callback that notifies the caller of this method when a translation has occurred, cannot be null

Returns

a translate action. Never null.

Implements Luciad.Edit.Geometries.IGeometryHandlesProvider.

Property Documentation

Constraint

Luciad.Geometries.Constraints.IPointConstraint Luciad.Edit.Geometries.PointHandlesProvider.Constraint

getset

The constraint that is applied to the handles' edit actions.

[get]

Returns the constraint that is applied to the handles' edit actions. Can be null if no constraint is set.

[set]

Sets the constraint that is applied to the handles' edit actions. Handles always call the constraint with a PointChange parameter, containing the point difference.

HandleFactory

Luciad.Edit.Geometries.PointHandlesProvider.IHandleFactory Luciad.Edit.Geometries.PointHandlesProvider.HandleFactory

getset

The handle factory used by the handles provider.

[get]

Returns the handle factory used by the handles provider.

[set]

Sets the handle factory used by the handles provider. If this method is not called, a default handle factory is used. You can change the behavior of this default handle factory by:

• wrapping it with your own IHandleFactory implementation, by delegating to the default factory
• omitting/replacing one or more handles that are returned

Exceptions

System.ArgumentNullException

when null is passed.