SelectionOperator

class Communicator.Operator.SelectionOperator()

Methods

addMapping()

clearMapping()

getForceEffectiveSceneVisibilityMask()

getPickConfig()

getSelectionButton()

setDoubleClickFitWorldEnabled()

setForceEffectiveSceneVisibilityMask()

setMapping()

setPickConfig()

setSelectionButton()


Methods

addMapping

Communicator.Operator.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 (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

clearMapping

Communicator.Operator.SelectionOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type

void

getForceEffectiveSceneVisibilityMask

Communicator.Operator.SelectionOperator.getForceEffectiveSceneVisibilityMask()

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

Note

getForceEffectiveSceneVisibilityMask is deprecated: Use getPickConfig instead.

Return type

Communicator.SelectionMask

getPickConfig

Communicator.Operator.SelectionOperator.getPickConfig()

Returns the PickConfig that will be passed to View.pickFromPoint

Return type

Communicator.PickConfig

getSelectionButton

Communicator.Operator.SelectionOperator.getSelectionButton()

Gets the button used for selection.

Return type

Communicator.Button

Returns

Button

setDoubleClickFitWorldEnabled

Communicator.Operator.SelectionOperator.setDoubleClickFitWorldEnabled(doubleClickFitWorld)

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

Arguments
  • doubleClickFitWorld (boolean()) –

Return type

void

setForceEffectiveSceneVisibilityMask

Communicator.Operator.SelectionOperator.setForceEffectiveSceneVisibilityMask(mask)

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

Note

setForceEffectiveSceneVisibilityMask is deprecated: Use setPickConfig instead.

Arguments
  • mask ({  }()) –

Return type

void

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

setMapping

Communicator.Operator.SelectionOperator.setMapping(button, modifier)

Sets the button and key modifier mapping for the operator.

Arguments
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

setPickConfig

Communicator.Operator.SelectionOperator.setPickConfig(config)

Sets the PickConfig that will be passed to View.pickFromPoint

Arguments
  • config (Communicator.PickConfig()) –

Return type

void

setSelectionButton

Communicator.Operator.SelectionOperator.setSelectionButton(button)

Sets the button used for selection

Arguments
  • button (Communicator.Button()) –

Return type

void