.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


#################
SelectionOperator
#################

.. js:class:: Operators.SelectionOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Operators.SelectionOperator.addMapping`
   * :js:meth:`~Operators.SelectionOperator.clearMapping`
   * :js:meth:`~Operators.SelectionOperator.getPickConfig`
   * :js:meth:`~Operators.SelectionOperator.getSelectionButton`
   * :js:meth:`~Operators.SelectionOperator.setDoubleClickFitWorldEnabled`
   * :js:meth:`~Operators.SelectionOperator.setMapping`
   * :js:meth:`~Operators.SelectionOperator.setPickConfig`
   * :js:meth:`~Operators.SelectionOperator.setSelectionButton`
   
   




Methods
=======

.. js:method:: Operators.SelectionOperator.addMapping

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | addMapping(**button**\ : :js:data:`~Button`\ , **modifier**\ : :js:data:`~KeyModifiers`\ ?): *void*
   
   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**
   
      **button**\ : :js:data:`~Button`
   
      **modifier**\ : :js:data:`~KeyModifiers` = KeyModifiers.None
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.SelectionOperator.clearMapping

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | clearMapping(): *void*
   
   Clears any button and key modifier mappings for the operator.
   
   **Returns**\ : *void*
   



.. js:method:: Operators.SelectionOperator.getPickConfig

   .. rst-class:: sig-pretty-signature
   
      | getPickConfig(): :js:class:`~PickConfig`
   
   Returns the [[PickConfig]] that will be passed to [[View.pickFromPoint]].
   
   **Returns**\ : :js:class:`~PickConfig`
   



.. js:method:: Operators.SelectionOperator.getSelectionButton

   .. rst-class:: sig-pretty-signature
   
      | getSelectionButton(): :js:data:`~Button`
   
   Gets the button used for selection.
   
   **Returns**\ : :js:data:`~Button`
   
      Button
   
   



.. js:method:: Operators.SelectionOperator.setDoubleClickFitWorldEnabled

   .. rst-class:: sig-pretty-signature
   
      | setDoubleClickFitWorldEnabled(**doubleClickFitWorld**\ : *boolean*\ ): *void*
   
   When enabled, a double click will fit the view to the model bounding box.
   
   **Parameters**
   
      **doubleClickFitWorld**\ : *boolean*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.SelectionOperator.setMapping

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setMapping(**button**\ : :js:data:`~Button`\ , **modifier**\ : :js:data:`~KeyModifiers`\ ?): *void*
   
   Sets the button and key modifier mapping for the operator.
   
   **Parameters**
   
      **button**\ : :js:data:`~Button`
   
      **modifier**\ : :js:data:`~KeyModifiers` = KeyModifiers.None
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.SelectionOperator.setPickConfig

   .. rst-class:: sig-pretty-signature
   
      | setPickConfig(**config**\ : :js:class:`~PickConfig`\ ): *void*
   
   Sets the [[PickConfig]] that will be passed to [[View.pickFromPoint]].
   
   **Parameters**
   
      **config**\ : :js:class:`~PickConfig`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.SelectionOperator.setSelectionButton

   .. rst-class:: sig-pretty-signature
   
      | setSelectionButton(**button**\ : :js:data:`~Button`\ ): *void*
   
   Sets the button used for selection
   
   **Parameters**
   
      **button**\ : :js:data:`~Button`
   
   
   **Returns**\ : *void*
   





