Communicator.Operator.SelectionOperator

 SelectionOperator

Implements

Methods

addMapping

  • 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

    Returns void

clearMapping

  • clearMapping(): void
  • Clears any button and key modifier mappings for the operator.

    Returns void

getForceEffectiveSceneVisibilityMask    [deprecated]

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

    deprecated

    Use getPickConfig instead.

    Returns SelectionMask

getPickConfig

getSelectionButton

  • getSelectionButton(): Button
  • Gets the button used for selection.

    Returns Button

    Button

setDoubleClickFitWorldEnabled

  • setDoubleClickFitWorldEnabled(doubleClickFitWorld: boolean): void
  • When enabled, a double click will fit the view to the model bounding box.

    Parameters

    • doubleClickFitWorld: boolean

    Returns void

setForceEffectiveSceneVisibilityMask    [deprecated]

  • setForceEffectiveSceneVisibilityMask(mask: SelectionMask | null): void
  • 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.

    Parameters

    Returns void

setMapping

  • Sets the button and key modifier mapping for the operator.

    Parameters

    Returns void

setPickConfig

setSelectionButton

  • setSelectionButton(button: Button): void
  • Sets the button used for selection

    Parameters

    Returns void