AreaSelectionOperator
- class Communicator.Operator.AreaSelectionOperator()
Methods
Methods
addMapping
- AreaSelectionOperator.addMapping(button[, modifier])
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.
- Arguments
button (Button) –
modifier (KeyModifiers) – optional
- Return type
void
clearMapping
- AreaSelectionOperator.clearMapping()
Clears any button and key modifier mappings for the operator.
- Return type
void
clearSelection
- AreaSelectionOperator.clearSelection()
- Return type
Promise <void>
getForceEffectiveSceneVisibilityMask
- AreaSelectionOperator.getForceEffectiveSceneVisibilityMask()
Gets the mask used for forcing effective scene visibility during selection.
- Return type
hasActiveSelection
- AreaSelectionOperator.hasActiveSelection()
- Return type
boolean
setForceEffectiveSceneVisibilityMask
- AreaSelectionOperator.setForceEffectiveSceneVisibilityMask(mask)
Sets the mask used for forcing effective scene visibility during selection.
- Arguments
mask (SelectionMask) –
- Return type
void
setMapping
- AreaSelectionOperator.setMapping(button[, modifier])
Sets the button and key modifier mapping for the operator.
- Arguments
button (Button) –
modifier (KeyModifiers) – optional
- Return type
void
waitForIdle
- AreaSelectionOperator.waitForIdle()
- Return type
Promise <void>
