luciad::EditSettings Class Reference

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

#include <luciad/edit/EditSettings.h>

Public Member Functions
	EditSettings ()
	Creates a new EditSettings instance with default values. More...
	~EditSettings ()
std::shared_ptr< IIcon >	getAuxiliaryHandleIconActive () const
std::shared_ptr< IIcon >	getAuxiliaryHandleIconHighlighted () const
std::shared_ptr< IIcon >	getAuxiliaryHandleIconRegular () const
const std::optional< ComplexStrokeLineStyle > &	getComplexStrokeOutlineStyleActive () const
	Returns the complex stroke line style that is used for active handles that paint an outline. More...
const std::optional< ComplexStrokeLineStyle > &	getComplexStrokeOutlineStyleHighlighted () const
	Returns the complex stroke line style that is used for highlighted handles that paint an outline. More...
const std::optional< ComplexStrokeLineStyle > &	getComplexStrokeOutlineStyleRegular () const
	Returns the complex stroke line style that is used for inactive handles that paint an outline. More...
MouseButton	getElevationButton () const
MouseCursor	getElevationCursor () const
ModifierKeys	getElevationModifierKeys () const
std::shared_ptr< IIcon >	getHandleIconActive () const
std::shared_ptr< IIcon >	getHandleIconHighlighted () const
std::shared_ptr< IIcon >	getHandleIconRegular () const
MouseButton	getInsertButton () const
MouseCursor	getInsertCursor () const
ModifierKeys	getInsertModifierKeys () const
MouseButton	getMoveButton () const
MouseCursor	getMoveCursor () const
ModifierKeys	getMoveModifierKeys () const
const std::optional< LineStyle > &	getOutlineStyleActive () const
	Returns the line style that is used for active handles that display an outline. More...
const std::optional< LineStyle > &	getOutlineStyleHighlighted () const
	Returns the line style that is used for highlighted handles that display an outline. More...
const std::optional< LineStyle > &	getOutlineStyleRegular () const
	Returns the line style that is used for inactive handles that display an outline. More...
MouseButton	getPrependAppendButton () const
MouseCursor	getPrependAppendCursor () const
ModifierKeys	getPrependAppendModifierKeys () const
MouseButton	getRemoveButton () const
MouseCursor	getRemoveCursor () const
ModifierKeys	getRemoveModifierKeys () const
const std::optional< ComplexStrokeLineStyle > &	getShadowComplexStrokeLineStyle () const
	Returns the complex stroke line style that is used for shadow lines. More...
const std::optional< FillStyle > &	getShadowFillStyle () const
std::shared_ptr< IIcon >	getShadowIcon () const
const std::optional< LineStyle > &	getShadowLineStyle () const
	Returns the line style that is used for shadow lines. More...
MouseButton	getTranslateButton () const
MouseCursor	getTranslateCursor () const
ModifierKeys	getTranslateModifierKeys () const
const std::optional< ComplexStrokeLineStyle > &	getVisualAidComplexStrokeLineStyle () const
	Returns the complex stroke line style that is used for visual aid lines. More...
const std::optional< LineStyle > &	getVisualAidLineStyle () const
	Returns the line style that is used for visual aid lines. More...
void	setAuxiliaryHandleIconActive (std::shared_ptr< IIcon > icon)
void	setAuxiliaryHandleIconHighlighted (std::shared_ptr< IIcon > icon)
void	setAuxiliaryHandleIconRegular (std::shared_ptr< IIcon > icon)
void	setComplexStrokeOutlineStyleActive (std::optional< ComplexStrokeLineStyle > style)
	Sets the complex stroke line style that is used for active handles that paint an outline. More...
void	setComplexStrokeOutlineStyleHighlighted (std::optional< ComplexStrokeLineStyle > style)
	Sets the complex stroke line style that is used for highlighted handles that paint an outline. More...
void	setComplexStrokeOutlineStyleRegular (std::optional< ComplexStrokeLineStyle > style)
	Sets the complex stroke line style that is used for inactive handles that paint an outline. More...
void	setElevationButton (MouseButton button)
void	setElevationCursor (MouseCursor cursor)
void	setElevationModifierKeys (ModifierKeys modifierKeys)
void	setHandleIconActive (std::shared_ptr< IIcon > icon)
void	setHandleIconHighlighted (std::shared_ptr< IIcon > icon)
void	setHandleIconRegular (std::shared_ptr< IIcon > icon)
void	setInsertButton (MouseButton button)
void	setInsertCursor (MouseCursor cursor)
void	setInsertModifierKeys (ModifierKeys modifierKeys)
void	setMoveButton (MouseButton button)
void	setMoveCursor (MouseCursor cursor)
void	setMoveModifierKeys (ModifierKeys modifierKeys)
void	setOutlineStyleActive (std::optional< LineStyle > style)
	Sets the line style that is used for active handles that paint an outline. More...
void	setOutlineStyleHighlighted (std::optional< LineStyle > style)
	Sets the line style that is used for highlighted handles that paint an outline. More...
void	setOutlineStyleRegular (std::optional< LineStyle > style)
	Sets the line style that is used for handles in a EditHandleState::Inactive state that paint an outline. More...
void	setPrependAppendButton (MouseButton button)
void	setPrependAppendCursor (MouseCursor cursor)
void	setPrependAppendModifierKeys (ModifierKeys modifierKeys)
void	setRemoveButton (MouseButton button)
void	setRemoveCursor (MouseCursor cursor)
void	setRemoveModifierKeys (ModifierKeys modifierKeys)
void	setShadowComplexStrokeLineStyle (std::optional< ComplexStrokeLineStyle > style)
	Sets the complex stroke line style that is used for shadow lines. More...
void	setShadowFillStyle (std::optional< FillStyle > style)
	Fill style that is used when a shadow version of a geometry is painted. More...
void	setShadowIcon (std::shared_ptr< IIcon > icon)
void	setShadowLineStyle (std::optional< LineStyle > style)
	Sets the line style that is used for shadow lines. More...
void	setTranslateButton (MouseButton button)
void	setTranslateCursor (MouseCursor cursor)
void	setTranslateModifierKeys (ModifierKeys modifierKeys)
void	setVisualAidComplexStrokeLineStyle (std::optional< ComplexStrokeLineStyle > style)
	Sets the complex stroke line style that is used for visual aid lines. More...
void	setVisualAidLineStyle (std::optional< LineStyle > style)
	Sets 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 nullptr, the regular icon will be used instead.
• active handle icon: for point handles when in an active state. If nullptr, the highlighted icon will be used instead, or the active one if that one is nullptr 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:

• PointHandlesProvider::IHandleFactory
• PolylineHandlesProvider::IHandleFactory
• PolylineRingHandlesProvider::IHandleFactory

Since

2020.1

Constructor & Destructor Documentation

EditSettings()

luciad::EditSettings::EditSettings

(

)

Creates a new EditSettings instance with default values.

~EditSettings()

luciad::EditSettings::~EditSettings

(

)

Member Function Documentation

getAuxiliaryHandleIconActive()

std::shared_ptr< IIcon > luciad::EditSettings::getAuxiliaryHandleIconActive

(

)

const

Returns

the auxiliary icon for active handles.

getAuxiliaryHandleIconHighlighted()

std::shared_ptr< IIcon > luciad::EditSettings::getAuxiliaryHandleIconHighlighted

(

)

const

Returns

the auxiliary icon for highlighted handles.

getAuxiliaryHandleIconRegular()

std::shared_ptr< IIcon > luciad::EditSettings::getAuxiliaryHandleIconRegular

(

)

const

Returns

the auxiliary icon for inactive handles.

getComplexStrokeOutlineStyleActive()

const std::optional< ComplexStrokeLineStyle > & luciad::EditSettings::getComplexStrokeOutlineStyleActive

(

)

const

Returns the complex stroke line style that is used for active handles that paint an outline.

This method is linked to the getOutlineStyleActive method:

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

Returns

the complex stroke line style that is used for active handles that paint an outline.

Since

2023.1

getComplexStrokeOutlineStyleHighlighted()

const std::optional< ComplexStrokeLineStyle > & luciad::EditSettings::getComplexStrokeOutlineStyleHighlighted

(

)

const

Returns the complex stroke line style that is used for highlighted handles that paint an outline.

This method is linked to the getOutlineStyleHighlighted method:

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

Returns

the complex stroke line style that is used for highlighted handles that paint an outline.

Since

2023.1

getComplexStrokeOutlineStyleRegular()

const std::optional< ComplexStrokeLineStyle > & luciad::EditSettings::getComplexStrokeOutlineStyleRegular

(

)

const

Returns the complex stroke line style that is used for inactive handles that paint an outline.

This method is linked to the getOutlineStyleRegular method:

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

Returns

the complex stroke line style that is used for inactive handles that paint an outline.

Since

2023.1

getElevationButton()

MouseButton luciad::EditSettings::getElevationButton

(

)

const

Returns

the mouse button that is used by handles to modify elevation

getElevationCursor()

MouseCursor luciad::EditSettings::getElevationCursor

(

)

const

Returns

the cursor that is used for handles that manipulate elevation

getElevationModifierKeys()

ModifierKeys luciad::EditSettings::getElevationModifierKeys

(

)

const

Returns

the modifier keys that are used by handles to modify elevation

getHandleIconActive()

std::shared_ptr< IIcon > luciad::EditSettings::getHandleIconActive

(

)

const

Returns

the icon for active handles.

getHandleIconHighlighted()

std::shared_ptr< IIcon > luciad::EditSettings::getHandleIconHighlighted

(

)

const

Returns

the icon for highlighted handles.

getHandleIconRegular()

std::shared_ptr< IIcon > luciad::EditSettings::getHandleIconRegular

(

)

const

Returns

the icon for inactive handles.

getInsertButton()

MouseButton luciad::EditSettings::getInsertButton

(

)

const

Returns

the mouse button that is used by handles to insert something

getInsertCursor()

MouseCursor luciad::EditSettings::getInsertCursor

(

)

const

Returns

the cursor that is used for handles that insert something

getInsertModifierKeys()

ModifierKeys luciad::EditSettings::getInsertModifierKeys

(

)

const

Returns

the modifier keys that are used by handles to insert something

getMoveButton()

MouseButton luciad::EditSettings::getMoveButton

(

)

const

Returns

the mouse button that is used by handles to move something

getMoveCursor()

MouseCursor luciad::EditSettings::getMoveCursor

(

)

const

Returns

the cursor that is used for handles that move something

getMoveModifierKeys()

ModifierKeys luciad::EditSettings::getMoveModifierKeys

(

)

const

Returns

the modifier keys that are used by handles to move something

getOutlineStyleActive()

const std::optional< LineStyle > & luciad::EditSettings::getOutlineStyleActive

(

)

const

Returns the line style that is used for active handles that display an outline.

This method is linked to the getComplexStrokeOutlineStyleActive method:

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

Returns

the line style that is used for active handles that paint an outline.

getOutlineStyleHighlighted()

const std::optional< LineStyle > & luciad::EditSettings::getOutlineStyleHighlighted

(

)

const

Returns the line style that is used for highlighted handles that display an outline.

This method is linked to the getComplexStrokeOutlineStyleHighlighted method:

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

Returns

the line style that is used for highlighted handles that paint an outline.

getOutlineStyleRegular()

const std::optional< LineStyle > & luciad::EditSettings::getOutlineStyleRegular

(

)

const

Returns the line style that is used for inactive handles that display an outline.

This method is linked to the getComplexStrokeOutlineStyleRegular method:

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

Returns

the line style that is used for inactive handles that paint an outline.

getPrependAppendButton()

MouseButton luciad::EditSettings::getPrependAppendButton

(

)

const

Returns

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

getPrependAppendCursor()

MouseCursor luciad::EditSettings::getPrependAppendCursor

(

)

const

Returns

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

getPrependAppendModifierKeys()

ModifierKeys luciad::EditSettings::getPrependAppendModifierKeys

(

)

const

Returns

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

getRemoveButton()

MouseButton luciad::EditSettings::getRemoveButton

(

)

const

Returns

the mouse button that is used by handles to remove something

getRemoveCursor()

MouseCursor luciad::EditSettings::getRemoveCursor

(

)

const

Returns

the cursor that is used for handles that remove something

getRemoveModifierKeys()

ModifierKeys luciad::EditSettings::getRemoveModifierKeys

(

)

const

Returns

the modifier keys that are used by handles to remove something

getShadowComplexStrokeLineStyle()

const std::optional< ComplexStrokeLineStyle > & luciad::EditSettings::getShadowComplexStrokeLineStyle

(

)

const

Returns the complex stroke line style that is used for shadow lines.

This method is linked to the getShadowLineStyle method:

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

Returns

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

Since

2023.1

getShadowFillStyle()

const std::optional< FillStyle > & luciad::EditSettings::getShadowFillStyle

(

)

const

Returns

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

getShadowIcon()

std::shared_ptr< IIcon > luciad::EditSettings::getShadowIcon

(

)

const

Returns

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

getShadowLineStyle()

const std::optional< LineStyle > & luciad::EditSettings::getShadowLineStyle

(

)

const

Returns the line style that is used for shadow lines.

This method is linked to the getShadowComplexStrokeLineStyle method:

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

Returns

the line style that is used for shadow lines.

getTranslateButton()

MouseButton luciad::EditSettings::getTranslateButton

(

)

const

Returns

the mouse button that is used for translate handles

getTranslateCursor()

MouseCursor luciad::EditSettings::getTranslateCursor

(

)

const

Returns

the cursor that is used for translate handles

getTranslateModifierKeys()

ModifierKeys luciad::EditSettings::getTranslateModifierKeys

(

)

const

Returns

the modifier keys that are used by the translate handles

getVisualAidComplexStrokeLineStyle()

const std::optional< ComplexStrokeLineStyle > & luciad::EditSettings::getVisualAidComplexStrokeLineStyle

(

)

const

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

This method is linked to the getVisualAidLineStyle method:

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

Returns

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

Since

2023.1

getVisualAidLineStyle()

const std::optional< LineStyle > & luciad::EditSettings::getVisualAidLineStyle

(

)

const

Returns the line style that is used for visual aid lines.

This method is linked to the getVisualAidComplexStrokeLineStyle method:

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

Returns

the line style that is used for visual aid lines.

setAuxiliaryHandleIconActive()

void luciad::EditSettings::setAuxiliaryHandleIconActive

(

std::shared_ptr< IIcon >

icon

)

Parameters

icon	the auxiliary icon for active handles. Can be nullptr. In that case no icon is painted.

setAuxiliaryHandleIconHighlighted()

void luciad::EditSettings::setAuxiliaryHandleIconHighlighted

(

std::shared_ptr< IIcon >

icon

)

Parameters

icon	the auxiliary icon for highlighted. Can be nullptr. In that case no icon is painted.

setAuxiliaryHandleIconRegular()

void luciad::EditSettings::setAuxiliaryHandleIconRegular

(

std::shared_ptr< IIcon >

icon

)

Parameters

icon	the auxiliary icon for inactive handles. Can be nullptr. In that case no icon is painted.

setComplexStrokeOutlineStyleActive()

void luciad::EditSettings::setComplexStrokeOutlineStyleActive

(

std::optional< ComplexStrokeLineStyle >

style

)

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 std::nullopt value when a LineStyle has already been set, it will be overwritten.

Parameters

style

the complex stroke line style that is used for active handles that paint an outline.

Since

2023.1

setComplexStrokeOutlineStyleHighlighted()

void luciad::EditSettings::setComplexStrokeOutlineStyleHighlighted

(

std::optional< ComplexStrokeLineStyle >

style

)

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 std::nullopt value when a LineStyle has already been set, it will be overwritten.

Parameters

style

the complex stroke line style that is used for highlighted handles that paint an outline.

Since

2023.1

setComplexStrokeOutlineStyleRegular()

void luciad::EditSettings::setComplexStrokeOutlineStyleRegular

(

std::optional< ComplexStrokeLineStyle >

style

)

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 std::nullopt value when a LineStyle has already been set, it will be overwritten.

Parameters

style

the complex stroke line style that is used for inactive handles that paint an outline.

Since

2023.1

setElevationButton()

void luciad::EditSettings::setElevationButton

(

MouseButton

button

)

Parameters

button

the mouse button that is used by handles to modify elevation

setElevationCursor()

void luciad::EditSettings::setElevationCursor

(

MouseCursor

cursor

)

Parameters

cursor

the cursor that is used for handles that manipulate elevation

setElevationModifierKeys()

void luciad::EditSettings::setElevationModifierKeys

(

ModifierKeys

modifierKeys

)

Parameters

modifierKeys

the modifier keys that are used by handles to modify elevation

setHandleIconActive()

void luciad::EditSettings::setHandleIconActive

(

std::shared_ptr< IIcon >

icon

)

Parameters

icon	the icon for active handles. Can be nullptr. In that case no icon is painted.

setHandleIconHighlighted()

void luciad::EditSettings::setHandleIconHighlighted

(

std::shared_ptr< IIcon >

icon

)

Parameters

icon	the icon for highlighted handles. Can be nullptr. In that case no icon is painted.

setHandleIconRegular()

void luciad::EditSettings::setHandleIconRegular

(

std::shared_ptr< IIcon >

icon

)

Parameters

icon	the icon for inactive handles. Can be nullptr. In that case no icon is painted.

setInsertButton()

void luciad::EditSettings::setInsertButton

(

MouseButton

button

)

Parameters

button

the mouse button that is used by handles to insert something

setInsertCursor()

void luciad::EditSettings::setInsertCursor

(

MouseCursor

cursor

)

Parameters

cursor

the cursor that is used for handles that insert something

setInsertModifierKeys()

void luciad::EditSettings::setInsertModifierKeys

(

ModifierKeys

modifierKeys

)

Parameters

modifierKeys

the modifier keys that are used by handles to insert something

setMoveButton()

void luciad::EditSettings::setMoveButton

(

MouseButton

button

)

Parameters

button

the mouse button that is used by handles to move something

setMoveCursor()

void luciad::EditSettings::setMoveCursor

(

MouseCursor

cursor

)

Parameters

cursor

the cursor that is used for handles that move something

setMoveModifierKeys()

void luciad::EditSettings::setMoveModifierKeys

(

ModifierKeys

modifierKeys

)

Parameters

modifierKeys

the modifier keys that are used by handles to move something

setOutlineStyleActive()

void luciad::EditSettings::setOutlineStyleActive

(

std::optional< LineStyle >

style

)

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 std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

the line style that is used for active handles that paint an outline.

setOutlineStyleHighlighted()

void luciad::EditSettings::setOutlineStyleHighlighted

(

std::optional< LineStyle >

style

)

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 std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

the line style that is used for highlighted handles that paint an outline.

setOutlineStyleRegular()

void luciad::EditSettings::setOutlineStyleRegular

(

std::optional< LineStyle >

style

)

Sets the line style that is used for handles in a EditHandleState::Inactive state that paint an outline.

Only one regular line style can be set, if this function is called with a non std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

the line style that is used for handles that manipulate an outline in a EditHandleState::Inactive state.

setPrependAppendButton()

void luciad::EditSettings::setPrependAppendButton

(

MouseButton

button

)

Parameters

button

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

setPrependAppendCursor()

void luciad::EditSettings::setPrependAppendCursor

(

MouseCursor

cursor

)

Parameters

cursor

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

setPrependAppendModifierKeys()

void luciad::EditSettings::setPrependAppendModifierKeys

(

ModifierKeys

modifierKeys

)

Parameters

modifierKeys

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

setRemoveButton()

void luciad::EditSettings::setRemoveButton

(

MouseButton

button

)

Parameters

button

the mouse button that is used by handles to remove something

setRemoveCursor()

void luciad::EditSettings::setRemoveCursor

(

MouseCursor

cursor

)

Parameters

cursor

the cursor that is used for handles that remove something

setRemoveModifierKeys()

void luciad::EditSettings::setRemoveModifierKeys

(

ModifierKeys

modifierKeys

)

Parameters

modifierKeys

the modifier keys that are used by handles to remove something

setShadowComplexStrokeLineStyle()

void luciad::EditSettings::setShadowComplexStrokeLineStyle

(

std::optional< ComplexStrokeLineStyle >

style

)

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 std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

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

Since

2023.1

setShadowFillStyle()

void luciad::EditSettings::setShadowFillStyle

(

std::optional< FillStyle >

style

)

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

Setting this to std::nullopt means the shadow version of the geometry won't have a fill style.

Parameters

style

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

setShadowIcon()

void luciad::EditSettings::setShadowIcon

(

std::shared_ptr< IIcon >

icon

)

Parameters

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

setShadowLineStyle()

void luciad::EditSettings::setShadowLineStyle

(

std::optional< LineStyle >

style

)

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 std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

the line style that is used for shadow lines.

setTranslateButton()

void luciad::EditSettings::setTranslateButton

(

MouseButton

button

)

Parameters

button

the mouse button that is used for translate handles

setTranslateCursor()

void luciad::EditSettings::setTranslateCursor

(

MouseCursor

cursor

)

Parameters

cursor

the cursor that is used for translate handles

setTranslateModifierKeys()

void luciad::EditSettings::setTranslateModifierKeys

(

ModifierKeys

modifierKeys

)

Parameters

modifierKeys

the modifier keys that are used by the translate handles

setVisualAidComplexStrokeLineStyle()

void luciad::EditSettings::setVisualAidComplexStrokeLineStyle

(

std::optional< ComplexStrokeLineStyle >

style

)

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 std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

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

Since

2023.1

setVisualAidLineStyle()

void luciad::EditSettings::setVisualAidLineStyle

(

std::optional< LineStyle >

style

)

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 std::nullopt value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

Parameters

style

the line style that is used for visual aid lines.