AreaSelectionOperator

class Operators.AreaSelectionOperator()

Index

Methods

• addMapping
• clearMapping
• clearSelection
• getForceEffectiveSceneVisibilityMask
• hasActiveSelection
• setForceEffectiveSceneVisibilityMask
• setMapping
• waitForIdle

Methods

Operators.AreaSelectionOperator.addMapping()

inherited

addMapping(button: Button, modifier: KeyModifiers?): void

Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.AreaSelectionOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

Operators.AreaSelectionOperator.clearSelection()

clearSelection(): Promise

Returns: Promise

Operators.AreaSelectionOperator.getForceEffectiveSceneVisibilityMask()

getForceEffectiveSceneVisibilityMask(): SelectionMask

Gets the mask used for forcing effective scene visibility during selection.

Returns: SelectionMask

Operators.AreaSelectionOperator.hasActiveSelection()

hasActiveSelection(): boolean

Returns: boolean

Operators.AreaSelectionOperator.setForceEffectiveSceneVisibilityMask()

setForceEffectiveSceneVisibilityMask(mask: SelectionMask): void

Sets the mask used for forcing effective scene visibility during selection.

Parameters

mask: SelectionMask

Returns: void

Operators.AreaSelectionOperator.setMapping()

inherited

setMapping(button: Button, modifier: KeyModifiers?): void

Sets the button and key modifier mapping for the operator.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.AreaSelectionOperator.waitForIdle()

waitForIdle(): Promise

Returns: Promise