This class contains settings that can be used as defaults for IFeatureHandlesProvider and IGeometryHandlesProvider implementations. More...

Inheritance diagram for Luciad.Edit.EditSettings:

Public Member Functions
	EditSettings ()
	Creates a new `EditSettings` instance with default values. More...

void	Dispose ()

Properties
Luciad.Drawing.IIcon	AuxiliaryHandleIconActive `[get, set]`
	The auxiliary icon for `Active` handles. More...

Luciad.Drawing.IIcon	AuxiliaryHandleIconHighlighted `[get, set]`
	The auxiliary icon for `Highlighted` handles. More...

Luciad.Drawing.IIcon	AuxiliaryHandleIconRegular `[get, set]`
	The auxiliary icon for `Inactive` handles. More...

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle	ComplexStrokeOutlineStyleActive `[get, set]`
	The complex stroke line style that is used for `Active` handles that paint an outline. More...

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle	ComplexStrokeOutlineStyleHighlighted `[get, set]`
	The complex stroke line style that is used for `Highlighted` handles that paint an outline. More...

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle	ComplexStrokeOutlineStyleRegular `[get, set]`
	The complex stroke line style that is used for `Inactive` handles that paint an outline. More...

Luciad.Input.Mouse.MouseButton	ElevationButton `[get, set]`
	The mouse button that is used by handles to modify elevation. More...

Luciad.Maps.MouseCursor	ElevationCursor `[get, set]`
	The cursor that is used for handles that manipulate elevation. More...

Luciad.Input.ModifierKeys	ElevationModifierKeys `[get, set]`
	The modifier keys that are used by handles to modify elevation. More...

Luciad.Drawing.IIcon	HandleIconActive `[get, set]`
	The icon for `Active` handles. More...

Luciad.Drawing.IIcon	HandleIconHighlighted `[get, set]`
	The icon for `Highlighted` handles. More...

Luciad.Drawing.IIcon	HandleIconRegular `[get, set]`
	The icon for `Inactive` handles. More...

Luciad.Input.Mouse.MouseButton	InsertButton `[get, set]`
	The mouse button that is used by handles to insert something. More...

Luciad.Maps.MouseCursor	InsertCursor `[get, set]`
	The cursor that is used for handles that insert something. More...

Luciad.Input.ModifierKeys	InsertModifierKeys `[get, set]`
	The modifier keys that are used by handles to insert something. More...

Luciad.Input.Mouse.MouseButton	MoveButton `[get, set]`
	The mouse button that is used by handles to move something. More...

Luciad.Maps.MouseCursor	MoveCursor `[get, set]`
	The cursor that is used for handles that move something. More...

Luciad.Input.ModifierKeys	MoveModifierKeys `[get, set]`
	The modifier keys that are used by handles to move something. More...

Luciad.Layers.Styles.LineStyle	OutlineStyleActive `[get, set]`
	The line style that is used for `Active` handles that paint an outline. More...

Luciad.Layers.Styles.LineStyle	OutlineStyleHighlighted `[get, set]`
	The line style that is used for `Highlighted` handles that paint an outline. More...

Luciad.Layers.Styles.LineStyle	OutlineStyleRegular `[get, set]`
	The line style that is used for `Inactive` handles that paint an outline. More...

Luciad.Input.Mouse.MouseButton	PrependAppendButton `[get, set]`
	The mouse button that is used by handles that prepend or append something. More...

Luciad.Maps.MouseCursor	PrependAppendCursor `[get, set]`
	The cursor that is used for handles that prepend or append something. More...

Luciad.Input.ModifierKeys	PrependAppendModifierKeys `[get, set]`
	The modifier keys that are used by handles to prepend or append something. More...

Luciad.Input.Mouse.MouseButton	RemoveButton `[get, set]`
	The mouse button that is used by handles to remove something. More...

Luciad.Maps.MouseCursor	RemoveCursor `[get, set]`
	The cursor that is used for handles that remove something. More...

Luciad.Input.ModifierKeys	RemoveModifierKeys `[get, set]`
	The modifier keys that are used by handles to remove something. More...

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle	ShadowComplexStrokeLineStyle `[get, set]`
	The complex stroke line style that is used for shadow lines. More...

Luciad.Layers.Styles.FillStyle	ShadowFillStyle `[get, set]`
	The fill style that is used when a shadow version of a geometry is painted. More...

Luciad.Drawing.IIcon	ShadowIcon `[get, set]`
	The icon that is used when a shadow version of a geometry is painted. More...

Luciad.Layers.Styles.LineStyle	ShadowLineStyle `[get, set]`
	The line style that is used for shadow lines. More...

Luciad.Input.Mouse.MouseButton	TranslateButton `[get, set]`
	The mouse button that is used for translate handles. More...

Luciad.Maps.MouseCursor	TranslateCursor `[get, set]`
	The cursor that is used for translate handles. More...

Luciad.Input.ModifierKeys	TranslateModifierKeys `[get, set]`
	The modifier keys that are used by the translate handles. More...

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle	VisualAidComplexStrokeLineStyle `[get, set]`
	The complex stroke line style that is used for visual aid lines. More...

Luciad.Layers.Styles.LineStyle	VisualAidLineStyle `[get, set]`
	The line style that is used for visual aid lines. More...

Detailed Description

This class contains settings that can be used as defaults for IFeatureHandlesProvider and IGeometryHandlesProvider implementations.

To change the defaults, you can create a new instance of this class, adapt the settings, and configure it on the Editor class.

These settings are typically used in the following way:

handle icon: for point handles. See PointEditHandle.
highlighted handle icon: for point handles when in a highlighted state. If null, the regular icon will be used instead.
active handle icon: for point handles when in an active state. If null, the highlighted icon will be used instead, or the active one if that one is null as well.
auxiliary handle icon: for point handles that require different styling. An example is the insert handle for polylines. See PointEditHandle. highlighted and active auxiliary icons behave the same as the normal handle icons.
outline style: for handles that manipulate an outline
visual aid style: for handles that paint an additional helper line. For example: a vertical line that connects a handle with the terrain. See PointEditHandle.
shadow icon and styles: for handles that paint a shadow version of a geometry on the terrain. This is for example done by TranslateEditHandle.
cursors: you can configure cursors for different types of actions
mouse buttons: you can configure the mouse button that is used for different types of actions
modifier keys: you can configure the modifier keys that are used for different types of actions

If you need to customize edit behavior that is not available in this class, you can do so by creation and customizing the handles directly. The following handle implementations can for example be used and customized:

PointEditHandle
TranslateEditHandle

Most handles providers allow you to specify which handles are used. See for example:

Since: 2020.1

Constructor & Destructor Documentation

◆ EditSettings()

Luciad.Edit.EditSettings.EditSettings ( )

inline

Creates a new EditSettings instance with default values.

Member Function Documentation

◆ Dispose()

void Luciad.Edit.EditSettings.Dispose ( )

inline

Property Documentation

◆ AuxiliaryHandleIconActive

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.AuxiliaryHandleIconActive

getset

The auxiliary icon for Active handles.

[get]

Returns the auxiliary icon for Active handles.

[set]

Sets the auxiliary icon for Active handles. Can be null. In that case no icon is painted.

◆ AuxiliaryHandleIconHighlighted

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.AuxiliaryHandleIconHighlighted

getset

The auxiliary icon for Highlighted handles.

[get]

Returns the auxiliary icon for Highlighted handles.

[set]

Sets the auxiliary icon for Highlighted handles. Can be null. In that case no icon is painted.

◆ AuxiliaryHandleIconRegular

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.AuxiliaryHandleIconRegular

getset

The auxiliary icon for Inactive handles.

[get]

Returns the auxiliary icon for Inactive handles.

[set]

Sets the auxiliary icon for Inactive handles. Can be null. In that case no icon is painted.

◆ ComplexStrokeOutlineStyleActive

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle Luciad.Edit.EditSettings.ComplexStrokeOutlineStyleActive

getset

The complex stroke line style that is used for Active handles that paint an outline.

[get]

Returns the complex stroke line style that is used for Active handles that paint an outline. This method is linked to the OutlineStyleActive method:

if both of them return null, no outline is painted
if one of them is not null, that line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the complex stroke line style that is used for Active handles that paint an outline. Only one active line style can be set, if this function is called with a non null value when a LineStyle has already been set, it will be overwritten.

Since: 2023.1

◆ ComplexStrokeOutlineStyleHighlighted

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle Luciad.Edit.EditSettings.ComplexStrokeOutlineStyleHighlighted

getset

The complex stroke line style that is used for Highlighted handles that paint an outline.

[get]

Returns the complex stroke line style that is used for Highlighted handles that paint an outline. This method is linked to the OutlineStyleHighlighted method:

if both of them return null, no outline is painted
if one of them is not null, that line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the complex stroke line style that is used for Highlighted handles that paint an outline. Only one active line style can be set, if this function is called with a non null value when a LineStyle has already been set, it will be overwritten.

Since: 2023.1

◆ ComplexStrokeOutlineStyleRegular

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle Luciad.Edit.EditSettings.ComplexStrokeOutlineStyleRegular

getset

The complex stroke line style that is used for Inactive handles that paint an outline.

[get]

Returns the complex stroke line style that is used for Inactive handles that paint an outline. This method is linked to the OutlineStyleRegular method:

if both of them return null, no outline is painted
if one of them is not null, that line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the complex stroke line style that is used for Inactive handles that paint an outline. Only one active line style can be set, if this function is called with a non null value when a LineStyle has already been set, it will be overwritten.

Since: 2023.1

◆ ElevationButton

Luciad.Input.Mouse.MouseButton Luciad.Edit.EditSettings.ElevationButton

getset

The mouse button that is used by handles to modify elevation.

[get]

Returns the mouse button that is used by handles to modify elevation.

[set]

Sets the mouse button that is used by handles to modify elevation.

◆ ElevationCursor

Luciad.Maps.MouseCursor Luciad.Edit.EditSettings.ElevationCursor

getset

The cursor that is used for handles that manipulate elevation.

[get]

Returns the cursor that is used for handles that manipulate elevation.

[set]

Sets the cursor that is used for handles that manipulate elevation.

◆ ElevationModifierKeys

Luciad.Input.ModifierKeys Luciad.Edit.EditSettings.ElevationModifierKeys

getset

The modifier keys that are used by handles to modify elevation.

[get]

Returns the modifier keys that are used by handles to modify elevation.

[set]

Sets the modifier keys that are used by handles to modify elevation.

◆ HandleIconActive

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.HandleIconActive

getset

The icon for Active handles.

[get]

Returns the icon for Active handles.

[set]

Sets the icon for Active handles. Can be null. In that case no icon is painted.

◆ HandleIconHighlighted

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.HandleIconHighlighted

getset

The icon for Highlighted handles.

[get]

Returns the icon for Highlighted handles.

[set]

Sets the icon for Highlighted handles. Can be null. In that case no icon is painted.

◆ HandleIconRegular

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.HandleIconRegular

getset

The icon for Inactive handles.

[get]

Returns the icon for Inactive handles.

[set]

Sets the icon for Inactive handles. Can be null. In that case no icon is painted.

◆ InsertButton

Luciad.Input.Mouse.MouseButton Luciad.Edit.EditSettings.InsertButton

getset

The mouse button that is used by handles to insert something.

[get]

Returns the mouse button that is used by handles to insert something.

[set]

Sets the mouse button that is used by handles to insert something.

◆ InsertCursor

Luciad.Maps.MouseCursor Luciad.Edit.EditSettings.InsertCursor

getset

The cursor that is used for handles that insert something.

[get]

Returns the cursor that is used for handles that insert something.

[set]

Sets the cursor that is used for handles that insert something.

◆ InsertModifierKeys

Luciad.Input.ModifierKeys Luciad.Edit.EditSettings.InsertModifierKeys

getset

The modifier keys that are used by handles to insert something.

[get]

Returns the modifier keys that are used by handles to insert something.

[set]

Sets the modifier keys that are used by handles to insert something.

◆ MoveButton

Luciad.Input.Mouse.MouseButton Luciad.Edit.EditSettings.MoveButton

getset

The mouse button that is used by handles to move something.

[get]

Returns the mouse button that is used by handles to move something.

[set]

Sets the mouse button that is used by handles to move something.

◆ MoveCursor

Luciad.Maps.MouseCursor Luciad.Edit.EditSettings.MoveCursor

getset

The cursor that is used for handles that move something.

[get]

Returns the cursor that is used for handles that move something.

[set]

Sets the cursor that is used for handles that move something.

◆ MoveModifierKeys

Luciad.Input.ModifierKeys Luciad.Edit.EditSettings.MoveModifierKeys

getset

The modifier keys that are used by handles to move something.

[get]

Returns the modifier keys that are used by handles to move something.

[set]

Sets the modifier keys that are used by handles to move something.

◆ OutlineStyleActive

Luciad.Layers.Styles.LineStyle Luciad.Edit.EditSettings.OutlineStyleActive

getset

The line style that is used for Active handles that paint an outline.

[get]

Returns the line style that is used for Active handles that paint an outline. This method is linked to the ComplexStrokeOutlineStyleActive method:

if both of them return null, no outline is painted
if one of them is not null, that line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the line style that is used for Active handles that paint an outline. Only one active line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

◆ OutlineStyleHighlighted

Luciad.Layers.Styles.LineStyle Luciad.Edit.EditSettings.OutlineStyleHighlighted

getset

The line style that is used for Highlighted handles that paint an outline.

[get]

Returns the line style that is used for Highlighted handles that paint an outline. This method is linked to the ComplexStrokeOutlineStyleHighlighted method:

if both of them return null, no outline is painted
if one of them is not null, that line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the line style that is used for Highlighted handles that paint an outline. Only one highlighted line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

◆ OutlineStyleRegular

Luciad.Layers.Styles.LineStyle Luciad.Edit.EditSettings.OutlineStyleRegular

getset

The line style that is used for Inactive handles that paint an outline.

[get]

Returns the line style that is used for Inactive handles that paint an outline. This method is linked to the ComplexStrokeOutlineStyleRegular method:

if both of them return null, no outline is painted
if one of them is not null, that line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the line style that is used for Inactive handles that paint an outline. Only one regular line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

◆ PrependAppendButton

Luciad.Input.Mouse.MouseButton Luciad.Edit.EditSettings.PrependAppendButton

getset

The mouse button that is used by handles that prepend or append something.

[get]

Returns the mouse button that is used by handles that prepend or append something.

[set]

Sets the mouse button that is used by handles that prepend or append something.

◆ PrependAppendCursor

Luciad.Maps.MouseCursor Luciad.Edit.EditSettings.PrependAppendCursor

getset

The cursor that is used for handles that prepend or append something.

[get]

Returns the cursor that is used for handles that prepend or append something.

[set]

Sets the cursor that is used for handles that prepend or append something.

◆ PrependAppendModifierKeys

Luciad.Input.ModifierKeys Luciad.Edit.EditSettings.PrependAppendModifierKeys

getset

The modifier keys that are used by handles to prepend or append something.

[get]

Returns the modifier keys that are used by handles to prepend or append something.

[set]

Sets the modifier keys that are used by handles to prepend or append something.

◆ RemoveButton

Luciad.Input.Mouse.MouseButton Luciad.Edit.EditSettings.RemoveButton

getset

The mouse button that is used by handles to remove something.

[get]

Returns the mouse button that is used by handles to remove something.

[set]

Sets the mouse button that is used by handles to remove something.

◆ RemoveCursor

Luciad.Maps.MouseCursor Luciad.Edit.EditSettings.RemoveCursor

getset

The cursor that is used for handles that remove something.

[get]

Returns the cursor that is used for handles that remove something.

[set]

Sets the cursor that is used for handles that remove something.

◆ RemoveModifierKeys

Luciad.Input.ModifierKeys Luciad.Edit.EditSettings.RemoveModifierKeys

getset

The modifier keys that are used by handles to remove something.

[get]

Returns the modifier keys that are used by handles to remove something.

[set]

Sets the modifier keys that are used by handles to remove something.

◆ ShadowComplexStrokeLineStyle

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle Luciad.Edit.EditSettings.ShadowComplexStrokeLineStyle

getset

The complex stroke line style that is used for shadow lines.

[get]

Returns the complex stroke line style that is used for shadow lines. This method is linked to the ShadowLineStyle method:

if both of them return null, no shadow line is painted
if one of them is not null, that shadow line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the complex stroke line style that is used for shadow lines. Only one shadow line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Since: 2023.1

◆ ShadowFillStyle

Luciad.Layers.Styles.FillStyle Luciad.Edit.EditSettings.ShadowFillStyle

getset

The fill style that is used when a shadow version of a geometry is painted.

[get]

Returns the fill style that is used when a shadow version of a geometry is painted.

[set]

Sets the fill style that is used when a shadow version of a geometry is painted. Setting this to null means the shadow version of the geometry won't have a fill style.

◆ ShadowIcon

Luciad.Drawing.IIcon Luciad.Edit.EditSettings.ShadowIcon

getset

The icon that is used when a shadow version of a geometry is painted.

[get]

Returns the icon that is used when a shadow version of a geometry is painted.

[set]

Sets the icon that is used when a shadow version of a geometry is painted. Can be null. In that case no icon is painted.

◆ ShadowLineStyle

Luciad.Layers.Styles.LineStyle Luciad.Edit.EditSettings.ShadowLineStyle

getset

The line style that is used for shadow lines.

[get]

Returns the line style that is used for shadow lines. This method is linked to the ShadowComplexStrokeLineStyle method:

if both of them return null, no shadow line is painted
if one of them is not null, that shadow line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the line style that is used for shadow lines. Only one shadow line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

◆ TranslateButton

Luciad.Input.Mouse.MouseButton Luciad.Edit.EditSettings.TranslateButton

getset

The mouse button that is used for translate handles.

[get]

Returns the mouse button that is used for translate handles.

[set]

Sets the mouse button that is used for translate handles.

◆ TranslateCursor

Luciad.Maps.MouseCursor Luciad.Edit.EditSettings.TranslateCursor

getset

The cursor that is used for translate handles.

[get]

Returns the cursor that is used for translate handles.

[set]

Sets the cursor that is used for translate handles.

◆ TranslateModifierKeys

Luciad.Input.ModifierKeys Luciad.Edit.EditSettings.TranslateModifierKeys

getset

The modifier keys that are used by the translate handles.

[get]

Returns the modifier keys that are used by the translate handles.

[set]

Sets the modifier keys that are used by the translate handles.

◆ VisualAidComplexStrokeLineStyle

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle Luciad.Edit.EditSettings.VisualAidComplexStrokeLineStyle

getset

The complex stroke line style that is used for visual aid lines.

[get]

Returns the complex stroke line style that is used for visual aid lines. This method is linked to the VisualAidLineStyle method:

if both of them return null, no visual aid line is painted
if one of them is not null, that visual aid line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the complex stroke line style that is used for visual aid lines. Only one visual aid line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Since: 2023.1

◆ VisualAidLineStyle

Luciad.Layers.Styles.LineStyle Luciad.Edit.EditSettings.VisualAidLineStyle

getset

The line style that is used for visual aid lines.

[get]

Returns the line style that is used for visual aid lines. This method is linked to the VisualAidComplexStrokeLineStyle method:

if both of them return null, no visual aid line is painted
if one of them is not null, that visual aid line style is used
it's not possible for both methods to return a non null value: they are mutually exclusive

[set]

Sets the line style that is used for visual aid lines. Only one visual aid line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EditSettings()

Member Function Documentation

◆ Dispose()

Property Documentation

◆ AuxiliaryHandleIconActive

[get]

[set]

◆ AuxiliaryHandleIconHighlighted

[get]

[set]

◆ AuxiliaryHandleIconRegular

[get]

[set]

◆ ComplexStrokeOutlineStyleActive

[get]

[set]

◆ ComplexStrokeOutlineStyleHighlighted

[get]

[set]

◆ ComplexStrokeOutlineStyleRegular

[get]

[set]

◆ ElevationButton

[get]

[set]

◆ ElevationCursor

[get]

[set]

◆ ElevationModifierKeys

[get]

[set]

◆ HandleIconActive

[get]

[set]

◆ HandleIconHighlighted

[get]

[set]

◆ HandleIconRegular

[get]

[set]

◆ InsertButton

[get]

[set]

◆ InsertCursor

[get]

[set]

◆ InsertModifierKeys

[get]

[set]

◆ MoveButton

[get]

[set]

◆ MoveCursor

[get]

[set]

◆ MoveModifierKeys

[get]

[set]

◆ OutlineStyleActive

[get]

[set]

◆ OutlineStyleHighlighted

[get]

[set]

◆ OutlineStyleRegular

[get]

[set]

◆ PrependAppendButton

[get]

[set]

◆ PrependAppendCursor

[get]

[set]

◆ PrependAppendModifierKeys

[get]

[set]