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


#####################
AreaSelectionOperator
#####################

.. js:class:: Operators.AreaSelectionOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Operators.AreaSelectionOperator.addMapping`
   * :js:meth:`~Operators.AreaSelectionOperator.clearMapping`
   * :js:meth:`~Operators.AreaSelectionOperator.clearSelection`
   * :js:meth:`~Operators.AreaSelectionOperator.getForceEffectiveSceneVisibilityMask`
   * :js:meth:`~Operators.AreaSelectionOperator.hasActiveSelection`
   * :js:meth:`~Operators.AreaSelectionOperator.setForceEffectiveSceneVisibilityMask`
   * :js:meth:`~Operators.AreaSelectionOperator.setMapping`
   * :js:meth:`~Operators.AreaSelectionOperator.waitForIdle`
   
   




Methods
=======

.. js:method:: Operators.AreaSelectionOperator.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.AreaSelectionOperator.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.AreaSelectionOperator.clearSelection

   .. rst-class:: sig-pretty-signature
   
      | clearSelection(): *Promise*
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.AreaSelectionOperator.getForceEffectiveSceneVisibilityMask

   .. rst-class:: sig-pretty-signature
   
      | getForceEffectiveSceneVisibilityMask(): :js:data:`~SelectionMask`
   
   Gets the mask used for forcing effective scene visibility during selection.
   
   **Returns**\ : :js:data:`~SelectionMask`
   



.. js:method:: Operators.AreaSelectionOperator.hasActiveSelection

   .. rst-class:: sig-pretty-signature
   
      | hasActiveSelection(): *boolean*
   
   **Returns**\ : *boolean*
   



.. js:method:: Operators.AreaSelectionOperator.setForceEffectiveSceneVisibilityMask

   .. rst-class:: sig-pretty-signature
   
      | setForceEffectiveSceneVisibilityMask(**mask**\ : :js:data:`~SelectionMask`\ ): *void*
   
   Sets the mask used for forcing effective scene visibility during selection.
   
   **Parameters**
   
      **mask**\ : :js:data:`~SelectionMask`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.AreaSelectionOperator.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.AreaSelectionOperator.waitForIdle

   .. rst-class:: sig-pretty-signature
   
      | waitForIdle(): *Promise*
   
   **Returns**\ : *Promise*
   





