Luciad.Edit.Editor.Builder Class Reference

Builder for the Editor class. More...

Inheritance diagram for Luciad.Edit.Editor.Builder:

Public Member Functions
	Builder (Luciad.Edit.Editor.Builder other)
Luciad.Edit.Editor	Build ()
	Returns a new editor, based on the properties set on this builder. More...
Luciad.Edit.Editor.Builder	DefaultSettings (Luciad.Edit.EditSettings editSettings)
	Sets the default settings that can be used by the handles that are used to edit features and geometries. More...
void	Dispose ()
Luciad.Edit.Editor.Builder	EditCandidateProvider (Luciad.Edit.Features.IFeatureEditCandidateProvider editCandidateProvider)
	Sets the IFeatureEditCandidateProvider to use. More...
Luciad.Edit.Editor.Builder	Map (Luciad.Maps.Map map)
	Sets the map on which features are edited. More...
Luciad.Edit.Editor.Builder	MouseCursorCallback (Luciad.Maps.IMouseCursorCallback mouseCursorCallback)
	Sets the IMouseCursorCallback to use. More...

Detailed Description

Builder for the Editor class.

Since

2020.1

Constructor & Destructor Documentation

Builder()

Luciad.Edit.Editor.Builder.Builder ( Luciad.Edit.Editor.Builder  other )

inline

Member Function Documentation

Build()

Luciad.Edit.Editor Luciad.Edit.Editor.Builder.Build ( )

inline

Returns a new editor, based on the properties set on this builder.

Returns

a new editor.

Exceptions

System.InvalidOperationException

if not all mandatory parameters are set

DefaultSettings()

Luciad.Edit.Editor.Builder Luciad.Edit.Editor.Builder.DefaultSettings ( Luciad.Edit.EditSettings  editSettings )

inline

Sets the default settings that can be used by the handles that are used to edit features and geometries.

Feature and Geometry implementations are encouraged to use these default settings. The settings are available in the context given as parameter to their methods.

This parameter is optional. If it is not provided, a default EditSettings instance will be used.

Parameters

editSettings

the default settings to use. Should not be null.

Returns

this builder

Exceptions

System.ArgumentNullException

when null is passed.

Dispose()

void Luciad.Edit.Editor.Builder.Dispose ( )

inline

EditCandidateProvider()

Luciad.Edit.Editor.Builder Luciad.Edit.Editor.Builder.EditCandidateProvider ( Luciad.Edit.Features.IFeatureEditCandidateProvider  editCandidateProvider )

inline

Sets the IFeatureEditCandidateProvider to use.

This parameter is optional. When it is not set, edit candidates will be based on selection through FeatureStateEditCandidateProvider.

Parameters

editCandidateProvider

the edit candidate provider to use.

Returns

this builder

Exceptions

System.ArgumentNullException

when null is passed.

Map()

Luciad.Edit.Editor.Builder Luciad.Edit.Editor.Builder.Map ( Luciad.Maps.Map  map )

inline

Sets the map on which features are edited.

This parameter is mandatory. If it is not set, Editor.Builder.Build will throw an exception.

Parameters

map	the Map on which to edit features

Returns

this builder

Exceptions

System.ArgumentNullException

when null is passed.

MouseCursorCallback()

Luciad.Edit.Editor.Builder Luciad.Edit.Editor.Builder.MouseCursorCallback ( Luciad.Maps.IMouseCursorCallback  mouseCursorCallback )

inline

Sets the IMouseCursorCallback to use.

This callback is called when the Editor's cursor has changed.

Typically, this method is called by an IController implementation that supports Feature editing. This implementation can call Map.Cursor to effectively change the mouse cursor.

This callback is called on the UI thread only.

This parameter is optional.

Parameters

mouseCursorCallback

a callback that is called when the editor's cursor has changed.

Returns

this builder