AreaSelectionOperator

class Operators.AreaSelectionOperator()

Methods

Methods

addMapping

AreaSelectionOperator.addMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

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.

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:SelectionMask

hasActiveSelection

AreaSelectionOperator.hasActiveSelection()
Return type:boolean

setForceEffectiveSceneVisibilityMask

AreaSelectionOperator.setForceEffectiveSceneVisibilityMask(mask)
Arguments:
  • mask (SelectionMask()) – None

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

Return type:void

setMapping

AreaSelectionOperator.setMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

Sets the button and key modifier mapping for the operator.

Return type:void

waitForIdle

AreaSelectionOperator.waitForIdle()
Return type:Promise <void>