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


#################
CameraPanOperator
#################

.. js:class:: wv.Operators.Camera.CameraPanOperator

   Base class for operators that handle mouse and touch input. It provides common functionality for tracking mouse and touch events, as well as button and key modifier mappings. It is a Base class with No-OP hook methods (non virtual interface), meaning that it provides a default implementation for all methods, but can be extended by child classes to override specific behavior.
   
   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.addMapping`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.checkMapping`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.clearMapping`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.isActive`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.isDragging`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.onDeactivate`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.onDoubleClick`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.onMouseUp`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.onTouchEnd`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.onTouchMove`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.onTouchStart`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.setHandled`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.setMapping`
   * :js:meth:`~wv.Operators.Camera.CameraPanOperator.stopInteraction`
   
   



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

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


.. js:method:: wv.Operators.Camera.CameraPanOperator.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.Camera.CameraPanOperator.checkMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | checkMapping(**event**\ : :js:class:`MouseInputEvent <wv.Event.MouseInputEvent>`\ ): *boolean*
      
      Checks if the given mouse event matches any of the button and key modifier mappings for the operator. If no mappings are defined, it returns true.
      
      **Parameters**
      
      
         **event**\ : :js:class:`MouseInputEvent <wv.Event.MouseInputEvent>`
      
      
            The mouse event to check against the operator's mappings.
      
      
      
      **Returns**\ : *boolean*
      
      
         True if the event matches any mapping or if no mappings are defined, false otherwise.
      
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.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.Camera.CameraPanOperator.isActive

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | isActive(): *boolean*
      
      Checks if the operator is currently active, which is determined by whether the button and key modifier mapping is active or a touch event is active, and that a double click has not occurred and the context menu is not open.
      
      **Returns**\ : *boolean*
      
      
         True if the operator is active, false otherwise.
      
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.isDragging

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | isDragging(): *boolean*
      
      Checks if the operator is currently dragging.
      
      **Returns**\ : *boolean*
      
      
         True if the operator is dragging, false otherwise.
      
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.onDeactivate

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | onDeactivate(): (*void* | *Promise*\ )
      
      Called when the operator is deactivated. This method stops any ongoing interactions and resets the primary touch ID. It can be overridden by child classes to provide additional cleanup behavior when the operator is deactivated.
      
      **Returns**\ : (*void* \| *Promise*\ )
      
      
         A promise that resolves when the deactivation process is complete, or void if no asynchronous operations are performed.
      
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.onDoubleClick

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | onDoubleClick(**_event**\ : :js:class:`MouseInputEvent <wv.Event.MouseInputEvent>`\ ): *void*
      
      NO-OP method for handling double click events. By default, it does nothing, but child classes can override this method to provide specific behavior for double click events.
      
      **Parameters**
      
      
         **_event**\ : :js:class:`MouseInputEvent <wv.Event.MouseInputEvent>`
      
      
            The double click event to handle.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.onMouseUp

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | onMouseUp(**_event**\ : :js:class:`MouseInputEvent <wv.Event.MouseInputEvent>`\ ): *void*
      
      Base method for handling mouse up events. It stops the interaction if the operator is active, and resets the dragging state and drag count.
      
      **Parameters**
      
      
         **_event**\ : :js:class:`MouseInputEvent <wv.Event.MouseInputEvent>`
      
      
            The mouse up event to handle.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.onTouchEnd

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | onTouchEnd(**event**\ : :js:class:`TouchInputEvent <wv.Event.TouchInputEvent>`\ ): *void*
      
      Base method for handling touch end events. If the touch event corresponds to the primary touch point, it emulates a mouse up event using the touch position and resets the primary touch ID. It also sets the event as handled based on the operator's setHandled method.
      
      **Parameters**
      
      
         **event**\ : :js:class:`TouchInputEvent <wv.Event.TouchInputEvent>`
      
      
            The touch end event to handle.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.onTouchMove

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | onTouchMove(**event**\ : :js:class:`TouchInputEvent <wv.Event.TouchInputEvent>`\ ): *Promise*
      
      Base method for handling touch move events. If the touch event corresponds to the primary touch point, it emulates a mouse move event using the touch position. It awaits the onMouseMove method to allow for asynchronous behavior in child classes.
      
      **Parameters**
      
      
         **event**\ : :js:class:`TouchInputEvent <wv.Event.TouchInputEvent>`
      
      
            The touch move event to handle.
      
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.onTouchStart

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | onTouchStart(**event**\ : :js:class:`TouchInputEvent <wv.Event.TouchInputEvent>`\ ): *void*
      
      Base method for handling touch start events. It tracks the primary touch point and emulates a mouse down event using the touch position. If there is already an active touch, it ignores additional touch start events.
      
      **Parameters**
      
      
         **event**\ : :js:class:`TouchInputEvent <wv.Event.TouchInputEvent>`
      
      
            The touch start event to handle.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.setHandled

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setHandled(): *boolean*
      
      Base method for setting the handled state of events. By default, it returns false, but child classes can override this method to provide specific behavior for determining whether events should be marked as handled.
      
      **Returns**\ : *boolean*
      
      
         True if the event should be marked as handled, false otherwise.
      
      



.. js:method:: wv.Operators.Camera.CameraPanOperator.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.Camera.CameraPanOperator.stopInteraction

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      Stops an operator from interacting with the scene.
      
      .. rst-class:: sig-pretty-signature
      
         | stopInteraction(): *void*
      
      Stops the current interaction by triggering the "endInteraction" event on the viewer, and resets the dragging state, drag count, and button modifier active state.
      
      **Returns**\ : *void*
      




