class_inputeventgesture.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/InputEventGesture.xml.
  6. .. _class_InputEventGesture:
  7. InputEventGesture
  8. =================
  9. **Inherits:** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEventFromWindow<class_InputEventFromWindow>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`InputEventMagnifyGesture<class_InputEventMagnifyGesture>`, :ref:`InputEventPanGesture<class_InputEventPanGesture>`
  11. Abstract base class for touch gestures.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. InputEventGestures are sent when a user performs a supported gesture on a touch screen. Gestures can't be emulated using mouse, because they typically require multi-touch.
  16. .. rst-class:: classref-introduction-group
  17. Tutorials
  18. ---------
  19. - :doc:`Using InputEvent <../tutorials/inputs/inputevent>`
  20. .. rst-class:: classref-reftable-group
  21. Properties
  22. ----------
  23. .. table::
  24. :widths: auto
  25. +-------------------------------+------------------------------------------------------------+-------------------+
  26. | :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventGesture_property_position>` | ``Vector2(0, 0)`` |
  27. +-------------------------------+------------------------------------------------------------+-------------------+
  28. .. rst-class:: classref-section-separator
  29. ----
  30. .. rst-class:: classref-descriptions-group
  31. Property Descriptions
  32. ---------------------
  33. .. _class_InputEventGesture_property_position:
  34. .. rst-class:: classref-property
  35. :ref:`Vector2<class_Vector2>` **position** = ``Vector2(0, 0)``
  36. .. rst-class:: classref-property-setget
  37. - void **set_position** **(** :ref:`Vector2<class_Vector2>` value **)**
  38. - :ref:`Vector2<class_Vector2>` **get_position** **(** **)**
  39. The local gesture position relative to the :ref:`Viewport<class_Viewport>`. If used in :ref:`Control._gui_input<class_Control_method__gui_input>`, the position is relative to the current :ref:`Control<class_Control>` that received this gesture.
  40. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  41. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  42. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  43. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  44. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  45. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`