.. role:: ts-api-decorator

########
Operator
########

.. js:module:: Operators
   :noindex:

.. container:: ts-api-section

   .. js:class:: Operator



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~Operators.Operator.onActivate`
   * :js:attr:`~Operators.Operator.onDeactivate`
   * :js:attr:`~Operators.Operator.onKeyDown`
   * :js:attr:`~Operators.Operator.onKeyUp`
   * :js:attr:`~Operators.Operator.onMouseDown`
   * :js:attr:`~Operators.Operator.onMouseMove`
   * :js:attr:`~Operators.Operator.onMouseUp`
   * :js:attr:`~Operators.Operator.onMousewheel`
   * :js:attr:`~Operators.Operator.onTouchEnd`
   * :js:attr:`~Operators.Operator.onTouchMove`
   * :js:attr:`~Operators.Operator.onTouchStart`
   * :js:attr:`~Operators.Operator.onViewOrientationChange`
   * :js:attr:`~Operators.Operator.stopInteraction`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: Operator.onActivate

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onActivate()
         :noindex:



         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onDeactivate

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onDeactivate()
         :noindex:



         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onKeyDown

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onKeyDown( event)
         :noindex:

         :param event: None
         :type event: KeyInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onKeyUp

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onKeyUp( event)
         :noindex:

         :param event: None
         :type event: KeyInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onMouseDown

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onMouseDown( event)
         :noindex:

         :param event: None
         :type event: MouseInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onMouseMove

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onMouseMove( event)
         :noindex:

         :param event: None
         :type event: MouseInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onMouseUp

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onMouseUp( event)
         :noindex:

         :param event: None
         :type event: MouseInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onMousewheel

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onMousewheel( event)
         :noindex:

         :param event: None
         :type event: MouseWheelInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onTouchEnd

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onTouchEnd( event)
         :noindex:

         :param event: None
         :type event: TouchInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onTouchMove

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onTouchMove( event)
         :noindex:

         :param event: None
         :type event: TouchInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onTouchStart

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onTouchStart( event)
         :noindex:

         :param event: None
         :type event: TouchInputEvent


         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.onViewOrientationChange

      :type: function :ts-api-decorator:`optional`




      .. js:function:: onViewOrientationChange()
         :noindex:



         :rtype: void | Promise <void>





.. container:: ts-api-section

   .. js:attribute:: Operator.stopInteraction

      :type: function :ts-api-decorator:`optional`

      Stops an operator from interacting with the scene.


      .. js:function:: stopInteraction()
         :noindex:



         :rtype: void | Promise <void>





