SelectionOperator

class Communicator.Operator.SelectionOperator()

Methods

addMapping()
clearMapping()
getForceEffectiveSceneVisibilityMask()
getPickConfig()
getSelectionButton()
setDoubleClickFitWorldEnabled()
setForceEffectiveSceneVisibilityMask()
setMapping()
setPickConfig()
setSelectionButton()

Methods

addMapping

SelectionOperator.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

SelectionOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

getForceEffectiveSceneVisibilityMask

SelectionOperator.getForceEffectiveSceneVisibilityMask()

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

Deprecated: Use getPickConfig instead.
Return type: SelectionMask

getPickConfig

SelectionOperator.getPickConfig()

Returns the PickConfig that will be passed to View.pickFromPoint

Return type: PickConfig()

getSelectionButton

SelectionOperator.getSelectionButton()

Gets the button used for selection.

Return type: Button
Returns: Button

setDoubleClickFitWorldEnabled

SelectionOperator.setDoubleClickFitWorldEnabled(doubleClickFitWorld)

When enabled, a double click will fit the view to the model bounding box.

Arguments

doubleClickFitWorld (boolean()) –

Return type

void

setForceEffectiveSceneVisibilityMask

SelectionOperator.setForceEffectiveSceneVisibilityMask(mask)

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

This setting overrides the value passed to setPickConfig Passing null causes the value passed to setPickConfig to be used.

Deprecated

Use setPickConfig instead.

Arguments

mask (SelectionMask | null) –

Return type

void

This setting overrides the value passed to setPickConfig Passing null causes the value passed to setPickConfig to be used.

setMapping

SelectionOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments

button (Button) –
modifier (KeyModifiers) – optional

Return type

void

setPickConfig

SelectionOperator.setPickConfig(config)

Sets the PickConfig that will be passed to View.pickFromPoint

Arguments

config (PickConfig()) –

Return type

void

setSelectionButton

SelectionOperator.setSelectionButton(button)

Sets the button used for selection

Arguments

button (Button) –

Return type

void