Luciad.Edit.Geometries.PolylineRingHandlesProvider Class Reference

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

Inheritance diagram for Luciad.Edit.Geometries.PolylineRingHandlesProvider:

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

Public Member Functions
	PolylineRingHandlesProvider ()
	Creates a new handles provider that can create handles for a PolylineRing geometry.
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.
void	Dispose ()
override bool	Equals (object obj)
override int	GetHashCode ()
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.
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.

Properties
Luciad.Geometries.Constraints.IPolylineRingConstraint	Constraint [get, set]
	The constraint that is applied on the handles' edit actions.
Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory	HandleFactory [get, set]
	The handle factory used by the handles provider.
uint	MaxPointCount [get, set]
	The maximum number of points a polyline ring can have.
uint	MinPointCount [get, set]
	The minimum number of points a polyline ring can have.

Detailed Description

This handles provider can create handles to edit PolylineRing geometries.

It offers the following handles:

• move point handles
• insert point handles
• remove point handles

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

PolylineRingHandlesProvider()

Luciad.Edit.Geometries.PolylineRingHandlesProvider.PolylineRingHandlesProvider ( )

inline

Creates a new handles provider that can create handles for a PolylineRing geometry.

Member Function Documentation

CanProvide()

bool Luciad.Edit.Geometries.PolylineRingHandlesProvider.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.PolylineRingHandlesProvider.Dispose ( )

inline

Equals()

override bool Luciad.Edit.Geometries.PolylineRingHandlesProvider.Equals ( object obj )

inline

GetHashCode()

override int Luciad.Edit.Geometries.PolylineRingHandlesProvider.GetHashCode ( )

inline

Provide()

Luciad.Edit.Handles.IEditHandles Luciad.Edit.Geometries.PolylineRingHandlesProvider.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.PolylineRingHandlesProvider.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, 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 to the geometry
• apply this IGeometryHandlesProvider's constraint (if configured) to 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.IPolylineRingConstraint Luciad.Edit.Geometries.PolylineRingHandlesProvider.Constraint

getset

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

[get]

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

[set]

Sets the constraint that is applied on the handles' edit actions. They always call this constraint with a PolylineChange, describing a single change. More specifically:

• Move point handles provide a PolylineChange containing one moved point index.
• Insert point handles provide a PolylineChange containing one inserted point index.
• Remove point handles provide a PolylineChange containing one removed point index.

HandleFactory

Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory Luciad.Edit.Geometries.PolylineRingHandlesProvider.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.

MaxPointCount

uint Luciad.Edit.Geometries.PolylineRingHandlesProvider.MaxPointCount

getset

The maximum number of points a polyline ring can have.

[get]

Returns the maximum number of points a polyline ring can have.

[set]

Sets the maximum number of points a polyline ring can have. If a polyline's point count is higher than or equal to this value, this handles provider will not provide handles to insert new points for that polyline ring. By default, this value is the maximum value of size_t, which realistically corresponds to "no maximum".

Exceptions

System.ArgumentException

if maxPointCount is lower than the current min point count.

See also

MaxPointCount

MinPointCount

uint Luciad.Edit.Geometries.PolylineRingHandlesProvider.MinPointCount

getset

The minimum number of points a polyline ring can have.

[get]

Returns the minimum number of points a polyline ring can have.

[set]

Sets the minimum number of points a polyline ring can have. If a polyline ring's point count is lower than or equal to this value, this handles provider will not provide handles to remove points from that polyline ring. By default, this value is 3.

Exceptions

System.ArgumentException

if minPointCount is lower than 2, or higher than the current maximum point count.

See also

MinPointCount