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


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

.. js:class:: wv.Operators.AreaSelectionOperator

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



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: wv.Operators.AreaSelectionOperator.addMapping

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



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

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



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

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



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

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



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

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



.. js:method:: wv.Operators.AreaSelectionOperator.setMapping

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



.. js:method:: wv.Operators.AreaSelectionOperator.waitForIdle

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




