class_inputeventgesture.rst 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the InputEventGesture.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_InputEventGesture:
  6. InputEventGesture
  7. =================
  8. **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>`
  9. **Inherited By:** :ref:`InputEventMagnifyGesture<class_InputEventMagnifyGesture>`, :ref:`InputEventPanGesture<class_InputEventPanGesture>`
  10. Base class for touch control gestures.
  11. Properties
  12. ----------
  13. +-------------------------------+------------------------------------------------------------+-------------------+
  14. | :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventGesture_property_position>` | ``Vector2(0, 0)`` |
  15. +-------------------------------+------------------------------------------------------------+-------------------+
  16. Property Descriptions
  17. ---------------------
  18. .. _class_InputEventGesture_property_position:
  19. - :ref:`Vector2<class_Vector2>` **position**
  20. +-----------+---------------------+
  21. | *Default* | ``Vector2(0, 0)`` |
  22. +-----------+---------------------+
  23. | *Setter* | set_position(value) |
  24. +-----------+---------------------+
  25. | *Getter* | get_position() |
  26. +-----------+---------------------+
  27. 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.
  28. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  29. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  30. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  31. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  32. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  33. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`