.. role:: ts-api-decorator

#########################
RayDrillSelectionOperator
#########################

.. js:module:: Operators
   :noindex:

.. container:: ts-api-section

   .. js:class:: RayDrillSelectionOperator



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Operators.RayDrillSelectionOperator.addMapping`
   * :js:meth:`~Operators.RayDrillSelectionOperator.clearMapping`
   * :js:meth:`~Operators.RayDrillSelectionOperator.clearSelection`
   * :js:meth:`~Operators.RayDrillSelectionOperator.getForceEffectiveSceneVisibilityMask`
   * :js:meth:`~Operators.RayDrillSelectionOperator.getIgnoreTransparency`
   * :js:meth:`~Operators.RayDrillSelectionOperator.hasActiveSelection`
   * :js:meth:`~Operators.RayDrillSelectionOperator.setForceEffectiveSceneVisibilityMask`
   * :js:meth:`~Operators.RayDrillSelectionOperator.setIgnoreTransparency`
   * :js:meth:`~Operators.RayDrillSelectionOperator.setMapping`
   * :js:meth:`~Operators.RayDrillSelectionOperator.waitForIdle`





------------

Methods
=======

.. rst-class:: ts-api-section

addMapping
----------

.. js:method:: RayDrillSelectionOperator.addMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   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.


   :rtype: void

.. rst-class:: ts-api-section

clearMapping
------------

.. js:method:: RayDrillSelectionOperator.clearMapping()



   Clears any button and key modifier mappings for the operator.


   :rtype: void

.. rst-class:: ts-api-section

clearSelection
--------------

.. js:method:: RayDrillSelectionOperator.clearSelection()



   :rtype: Promise <void>

.. rst-class:: ts-api-section

getForceEffectiveSceneVisibilityMask
------------------------------------

.. js:method:: RayDrillSelectionOperator.getForceEffectiveSceneVisibilityMask()



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


   :rtype: SelectionMask

.. rst-class:: ts-api-section

getIgnoreTransparency
---------------------

.. js:method:: RayDrillSelectionOperator.getIgnoreTransparency()



   :rtype: boolean

.. rst-class:: ts-api-section

hasActiveSelection
------------------

.. js:method:: RayDrillSelectionOperator.hasActiveSelection()



   :rtype: boolean

.. rst-class:: ts-api-section

setForceEffectiveSceneVisibilityMask
------------------------------------

.. js:method:: RayDrillSelectionOperator.setForceEffectiveSceneVisibilityMask( mask)

   :param mask: None
   :type mask: SelectionMask


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


   :rtype: void

.. rst-class:: ts-api-section

setIgnoreTransparency
---------------------

.. js:method:: RayDrillSelectionOperator.setIgnoreTransparency( value)

   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setMapping
----------

.. js:method:: RayDrillSelectionOperator.setMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Sets the button and key modifier mapping for the operator.


   :rtype: void

.. rst-class:: ts-api-section

waitForIdle
-----------

.. js:method:: RayDrillSelectionOperator.waitForIdle()



   :rtype: Promise <void>

