Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory Interface Reference

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

Public Member Functions
Handles.IEditHandle	CreateInsertPointHandle (Utils.Observable< Luciad.Geometries.PolylineRing > polylineRing, uint insertIndex, Handles.IPointEditAction editAction, Features.FeatureEditContext context)
	Creates a handle that allows you to insert a new point in a PolylineRing. More...
Handles.IEditHandle	CreateMovePointHandle (Utils.Observable< Luciad.Geometries.PolylineRing > polylineRing, uint pointIndex, Handles.IPointEditAction editAction, Features.FeatureEditContext context)
	Creates a handle that allows you to move a point of the PolylineRing. More...
Handles.IEditHandle	CreateRemovePointHandle (Utils.Observable< Luciad.Geometries.PolylineRing > polylineRing, uint pointIndex, Handles.IPointEditAction editAction, Features.FeatureEditContext context)
	Creates a handle that allows you to remove a point of the PolylineRing. More...
bool	IsInsertPointHandleValid (Handles.IEditHandle insertPointHandle, Utils.Observable< Luciad.Geometries.PolylineRing > polylineRing, uint insertIndex, Features.FeatureEditContext context)
	Returns true if the given handle is still valid, or false if it should be removed. More...
bool	IsMovePointHandleValid (Handles.IEditHandle movePointHandle, Utils.Observable< Luciad.Geometries.PolylineRing > polylineRing, uint pointIndex, Features.FeatureEditContext context)
	Returns true if the given handle is still valid, or false if it should be removed. More...
bool	IsRemovePointHandleValid (Handles.IEditHandle removePointHandle, Utils.Observable< Luciad.Geometries.PolylineRing > polylineRing, uint pointIndex, 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 used 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 PolylineRingHandlesProvider, 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::PolylineRingHandlesProvider::IHandleFactory.

Member Function Documentation

CreateInsertPointHandle()

Luciad.Edit.Handles.IEditHandle Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory.CreateInsertPointHandle	(	Utils.Observable< Luciad.Geometries.PolylineRing >	polylineRing,
		uint	insertIndex,
		Handles.IPointEditAction	editAction,
		Features.FeatureEditContext	context
	)

Creates a handle that allows you to insert a new point in a PolylineRing.

While the handle is not already present, this method is called whenever the edited geometry changes.

polylineRing

the Geometry that is being edited

insertIndex

the index at which to insert a point in the Polyline. After the point is inserted, the new point will have this index. Values are within [1, pointCount].

editAction

the edit action that inserts the point. If a constraint was configured on the handles provider, this action applies that constraint when it is executed, providing a PolylineChange parameter with one inserted point index.

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::PolylineRingHandlesProvider::IHandleFactory::createInsertPointHandle.

CreateMovePointHandle()

Luciad.Edit.Handles.IEditHandle Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory.CreateMovePointHandle	(	Utils.Observable< Luciad.Geometries.PolylineRing >	polylineRing,
		uint	pointIndex,
		Handles.IPointEditAction	editAction,
		Features.FeatureEditContext	context
	)

Creates a handle that allows you to move a point of the PolylineRing.

While the handle is not already present, this method is called whenever the edited geometry changes.

polylineRing

the Geometry that is being edited

pointIndex

the index of the point to move

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 PolylineChange parameter with one moved point index.

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::PolylineRingHandlesProvider::IHandleFactory::createMovePointHandle.

CreateRemovePointHandle()

Luciad.Edit.Handles.IEditHandle Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory.CreateRemovePointHandle	(	Utils.Observable< Luciad.Geometries.PolylineRing >	polylineRing,
		uint	pointIndex,
		Handles.IPointEditAction	editAction,
		Features.FeatureEditContext	context
	)

Creates a handle that allows you to remove a point of the PolylineRing.

While the handle is not already present, this method is called whenever the edited geometry changes.

polylineRing

the Geometry that is being edited

pointIndex

the index of the point to remove

editAction

the remove-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 PolylineChange parameter with one removed point index.

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::PolylineRingHandlesProvider::IHandleFactory::createRemovePointHandle.

IsInsertPointHandleValid()

bool Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory.IsInsertPointHandleValid	(	Handles.IEditHandle	insertPointHandle,
		Utils.Observable< Luciad.Geometries.PolylineRing >	polylineRing,
		uint	insertIndex,
		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 createInsertPointHandle 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.

insertPointHandle

the handle

polylineRing

the Geometry that is being edited

insertIndex

the insertion index

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::PolylineRingHandlesProvider::IHandleFactory::isInsertPointHandleValid.

IsMovePointHandleValid()

bool Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory.IsMovePointHandleValid	(	Handles.IEditHandle	movePointHandle,
		Utils.Observable< Luciad.Geometries.PolylineRing >	polylineRing,
		uint	pointIndex,
		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 createMovePointHandle 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.

movePointHandle

the handle

polylineRing

the Geometry that is being edited

pointIndex

the index of the point

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::PolylineRingHandlesProvider::IHandleFactory::isMovePointHandleValid.

IsRemovePointHandleValid()

bool Luciad.Edit.Geometries.PolylineRingHandlesProvider.IHandleFactory.IsRemovePointHandleValid	(	Handles.IEditHandle	removePointHandle,
		Utils.Observable< Luciad.Geometries.PolylineRing >	polylineRing,
		uint	pointIndex,
		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 createRemovePointHandle 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.

removePointHandle

the handle

polylineRing

the Geometry that is being edited

pointIndex

the index of the point

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::PolylineRingHandlesProvider::IHandleFactory::isRemovePointHandleValid.