mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
113 lines
4.9 KiB
ReStructuredText
113 lines
4.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the InputEventMouseMotion.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_InputEventMouseMotion:
|
|
|
|
InputEventMouseMotion
|
|
=====================
|
|
|
|
**Inherits:** :ref:`InputEventMouse<class_InputEventMouse>` **<** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Input event type for mouse motion events.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains mouse and pen motion information. Supports relative, absolute positions and speed. See :ref:`Node._input<class_Node_method__input>`.
|
|
|
|
**Note:** By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, call :ref:`Input.set_use_accumulated_input<class_Input_method_set_use_accumulated_input>` with ``false`` to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing `Bresenham's line algorithm <https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm>`__ as well to avoid visible gaps in lines if the user is moving the mouse quickly.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/inputs/mouse_and_input_coordinates`
|
|
|
|
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+----------------------------------------------------------------+---------------------+
|
|
| :ref:`float<class_float>` | :ref:`pressure<class_InputEventMouseMotion_property_pressure>` | ``0.0`` |
|
|
+-------------------------------+----------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`relative<class_InputEventMouseMotion_property_relative>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+----------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`speed<class_InputEventMouseMotion_property_speed>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+----------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`tilt<class_InputEventMouseMotion_property_tilt>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+----------------------------------------------------------------+---------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventMouseMotion_property_pressure:
|
|
|
|
- :ref:`float<class_float>` **pressure**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_pressure(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_pressure() |
|
|
+-----------+---------------------+
|
|
|
|
Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``.
|
|
|
|
----
|
|
|
|
.. _class_InputEventMouseMotion_property_relative:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **relative**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_relative(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_relative() |
|
|
+-----------+---------------------+
|
|
|
|
The mouse position relative to the previous position (position at the last frame).
|
|
|
|
**Note:** Since ``InputEventMouseMotion`` is only emitted when the mouse moves, the last event won't have a relative position of ``Vector2(0, 0)`` when the user stops moving the mouse.
|
|
|
|
----
|
|
|
|
.. _class_InputEventMouseMotion_property_speed:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **speed**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_speed(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_speed() |
|
|
+-----------+---------------------+
|
|
|
|
The mouse speed in pixels per second.
|
|
|
|
----
|
|
|
|
.. _class_InputEventMouseMotion_property_tilt:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **tilt**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_tilt(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_tilt() |
|
|
+-----------+---------------------+
|
|
|
|
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from ``-1.0`` to ``1.0`` for both axes.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|