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


###############
TouchInputEvent
###############

.. js:class:: Event.TouchInputEvent

   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Event.TouchInputEvent.viewKey`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Event.TouchInputEvent.getButtons`
   * :js:meth:`~Event.TouchInputEvent.getDate`
   * :js:meth:`~Event.TouchInputEvent.getEventType`
   * :js:meth:`~Event.TouchInputEvent.getHandled`
   * :js:meth:`~Event.TouchInputEvent.getId`
   * :js:meth:`~Event.TouchInputEvent.getPosition`
   * :js:meth:`~Event.TouchInputEvent.setHandled`
   
   




Accessors
=========

.. js:method:: Event.TouchInputEvent.viewKey

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | *get* viewKey(): :js:data:`ViewKey <Sc.ViewKey>`
   
   Get the ViewKey this event is associated with.
   
   **Returns**\ : :js:data:`ViewKey <Sc.ViewKey>`
   





Methods
=======

.. js:method:: Event.TouchInputEvent.getButtons

   .. rst-class:: sig-pretty-signature
   
      | getButtons(): :js:data:`~Buttons`
   
   gets the mouse buttons currently pressed with this event
   
   **Returns**\ : :js:data:`~Buttons`
   
      the mouse buttons currently pressed for this event
   
   



.. js:method:: Event.TouchInputEvent.getDate

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getDate(): *Date*
   
   Gets the Date this event occurred
   
   **Returns**\ : *Date*
   
      the event Date
   
   



.. js:method:: Event.TouchInputEvent.getEventType

   .. rst-class:: sig-pretty-signature
   
      | getEventType(): :js:data:`~TouchInputType`
   
   gets the event type
   
   **Returns**\ : :js:data:`~TouchInputType`
   
      the type of touch event
   
   



.. js:method:: Event.TouchInputEvent.getHandled

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getHandled(): *boolean*
   
   Gets the handled state of the event
   
   **Returns**\ : *boolean*
   
      whether the event has been handled
   
   



.. js:method:: Event.TouchInputEvent.getId

   .. rst-class:: sig-pretty-signature
   
      | getId(): *number*
   
   gets the id this event
   
   **Returns**\ : *number*
   
      the unique identifier for this touch
   
   



.. js:method:: Event.TouchInputEvent.getPosition

   .. rst-class:: sig-pretty-signature
   
      | getPosition(): :js:class:`~Point2`
   
   gets the window position of the mouse pointer for this event
   
   **Returns**\ : :js:class:`~Point2`
   
      the mouse position for this event
   
   



.. js:method:: Event.TouchInputEvent.setHandled

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setHandled(**handled**\ : *boolean*\ ): *void*
   
   Sets the handled state of the event. When an event has been handled it will not propagate any further
   
   **Parameters**
   
      **handled**\ : *boolean*
   
         Indicates whether this event has been handled.
   
   
   
   **Returns**\ : *void*
   





