RemoteTransform.xml 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. RemoteTransform mirrors the [Transform] of another [Spatial] derived Node in the scene.
  5. </brief_description>
  6. <description>
  7. RemoteTransform mirrors the [Transform] of another [Spatial] derived Node (called the remote node) in the scene.
  8. It can be set to track another Node's position, rotation and/or scale and update its own accordingly, using either global or local coordinates.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <demos>
  13. </demos>
  14. <methods>
  15. <method name="get_remote_node" qualifiers="const">
  16. <return type="NodePath">
  17. </return>
  18. <description>
  19. </description>
  20. </method>
  21. <method name="get_update_position" qualifiers="const">
  22. <return type="bool">
  23. </return>
  24. <description>
  25. </description>
  26. </method>
  27. <method name="get_update_rotation" qualifiers="const">
  28. <return type="bool">
  29. </return>
  30. <description>
  31. </description>
  32. </method>
  33. <method name="get_update_scale" qualifiers="const">
  34. <return type="bool">
  35. </return>
  36. <description>
  37. </description>
  38. </method>
  39. <method name="get_use_global_coordinates" qualifiers="const">
  40. <return type="bool">
  41. </return>
  42. <description>
  43. </description>
  44. </method>
  45. <method name="set_remote_node">
  46. <return type="void">
  47. </return>
  48. <argument index="0" name="path" type="NodePath">
  49. </argument>
  50. <description>
  51. </description>
  52. </method>
  53. <method name="set_update_position">
  54. <return type="void">
  55. </return>
  56. <argument index="0" name="update_remote_position" type="bool">
  57. </argument>
  58. <description>
  59. </description>
  60. </method>
  61. <method name="set_update_rotation">
  62. <return type="void">
  63. </return>
  64. <argument index="0" name="update_remote_rotation" type="bool">
  65. </argument>
  66. <description>
  67. </description>
  68. </method>
  69. <method name="set_update_scale">
  70. <return type="void">
  71. </return>
  72. <argument index="0" name="update_remote_scale" type="bool">
  73. </argument>
  74. <description>
  75. </description>
  76. </method>
  77. <method name="set_use_global_coordinates">
  78. <return type="void">
  79. </return>
  80. <argument index="0" name="use_global_coordinates" type="bool">
  81. </argument>
  82. <description>
  83. </description>
  84. </method>
  85. </methods>
  86. <members>
  87. <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node">
  88. The remote node's [NodePath].
  89. </member>
  90. <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position">
  91. If [code]true[/code] the remote node's position is mirrored.
  92. </member>
  93. <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation">
  94. If [code]true[/code] the remote node's rotation is mirrored.
  95. </member>
  96. <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale">
  97. If [code]true[/code] the remote node's scale is mirrored.
  98. </member>
  99. <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates">
  100. If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code].
  101. </member>
  102. </members>
  103. <constants>
  104. </constants>
  105. </class>