class_remotetransform2d.rst 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the RemoteTransform2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RemoteTransform2D:
  6. RemoteTransform2D
  7. =================
  8. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. RemoteTransform2D pushes its own :ref:`Transform2D<class_Transform2D>` to another :ref:`CanvasItem<class_CanvasItem>` derived Node in the scene.
  13. Properties
  14. ----------
  15. +---------------------------------+----------------------------------------------------------------------------------------+
  16. | :ref:`NodePath<class_NodePath>` | :ref:`remote_path<class_RemoteTransform2D_property_remote_path>` |
  17. +---------------------------------+----------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`update_position<class_RemoteTransform2D_property_update_position>` |
  19. +---------------------------------+----------------------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`update_rotation<class_RemoteTransform2D_property_update_rotation>` |
  21. +---------------------------------+----------------------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`update_scale<class_RemoteTransform2D_property_update_scale>` |
  23. +---------------------------------+----------------------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`use_global_coordinates<class_RemoteTransform2D_property_use_global_coordinates>` |
  25. +---------------------------------+----------------------------------------------------------------------------------------+
  26. Description
  27. -----------
  28. RemoteTransform2D pushes its own :ref:`Transform2D<class_Transform2D>` to another :ref:`CanvasItem<class_CanvasItem>` derived Node (called the remote node) in the scene.
  29. It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates.
  30. Property Descriptions
  31. ---------------------
  32. .. _class_RemoteTransform2D_property_remote_path:
  33. - :ref:`NodePath<class_NodePath>` **remote_path**
  34. +----------+------------------------+
  35. | *Setter* | set_remote_node(value) |
  36. +----------+------------------------+
  37. | *Getter* | get_remote_node() |
  38. +----------+------------------------+
  39. The :ref:`NodePath<class_NodePath>` to the remote node, relative to the RemoteTransform2D's position in the scene.
  40. ----
  41. .. _class_RemoteTransform2D_property_update_position:
  42. - :ref:`bool<class_bool>` **update_position**
  43. +----------+----------------------------+
  44. | *Setter* | set_update_position(value) |
  45. +----------+----------------------------+
  46. | *Getter* | get_update_position() |
  47. +----------+----------------------------+
  48. If ``true``, the remote node's position is updated. Default value: ``true``.
  49. ----
  50. .. _class_RemoteTransform2D_property_update_rotation:
  51. - :ref:`bool<class_bool>` **update_rotation**
  52. +----------+----------------------------+
  53. | *Setter* | set_update_rotation(value) |
  54. +----------+----------------------------+
  55. | *Getter* | get_update_rotation() |
  56. +----------+----------------------------+
  57. If ``true``, the remote node's rotation is updated. Default value: ``true``.
  58. ----
  59. .. _class_RemoteTransform2D_property_update_scale:
  60. - :ref:`bool<class_bool>` **update_scale**
  61. +----------+-------------------------+
  62. | *Setter* | set_update_scale(value) |
  63. +----------+-------------------------+
  64. | *Getter* | get_update_scale() |
  65. +----------+-------------------------+
  66. If ``true``, the remote node's scale is updated. Default value: ``true``.
  67. ----
  68. .. _class_RemoteTransform2D_property_use_global_coordinates:
  69. - :ref:`bool<class_bool>` **use_global_coordinates**
  70. +----------+-----------------------------------+
  71. | *Setter* | set_use_global_coordinates(value) |
  72. +----------+-----------------------------------+
  73. | *Getter* | get_use_global_coordinates() |
  74. +----------+-----------------------------------+
  75. If ``true``, global coordinates are used. If ``false``, local coordinates are used. Default value: ``true``.