Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Branch: 4.0
Branches Tags
godot-docs
/
classes
/
class_xrnode3d.rst

class_xrnode3d.rst 8.0 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/XRNode3D.xml.
    7. 

  7. 

  8. .. _class_XRNode3D:
    9. 

  9. 

  10. XRNode3D
    11. 

  11. ========
    12. 

  12. 

  13. **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. **Inherited By:** :ref:`XRAnchor3D<class_XRAnchor3D>`, :ref:`XRController3D<class_XRController3D>`
    16. 

  16. 

  17. A spatial node that has its position automatically updated by the :ref:`XRServer<class_XRServer>`.
    18. 

  18. 

  19. .. rst-class:: classref-introduction-group
    20. 

  20. 

  21. Description
    22. 

  22. -----------
    23. 

  23. 

  24. This node can be bound to a specific pose of a :ref:`XRPositionalTracker<class_XRPositionalTracker>` and will automatically have its :ref:`Node3D.transform<class_Node3D_property_transform>` updated by the :ref:`XRServer<class_XRServer>`. Nodes of this type must be added as children of the :ref:`XROrigin3D<class_XROrigin3D>` node.
    25. 

  25. 

  26. .. rst-class:: classref-reftable-group
    27. 

  27. 

  28. Properties
    29. 

  29. ----------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

  34.    +-------------------------------------+-------------------------------------------------+----------------+
    35. 

  35.    | :ref:`StringName<class_StringName>` | :ref:`pose<class_XRNode3D_property_pose>`       | ``&"default"`` |
    36. 

  36.    +-------------------------------------+-------------------------------------------------+----------------+
    37. 

  37.    | :ref:`StringName<class_StringName>` | :ref:`tracker<class_XRNode3D_property_tracker>` | ``&""``        |
    38. 

  38.    +-------------------------------------+-------------------------------------------------+----------------+
    39. 

  39. 

  40. .. rst-class:: classref-reftable-group
    41. 

  41. 

  42. Methods
    43. 

  43. -------
    44. 

  44. 

  45. .. table::
    46. 

  46.    :widths: auto
    47. 

  47. 

  48.    +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | :ref:`bool<class_bool>`     | :ref:`get_has_tracking_data<class_XRNode3D_method_get_has_tracking_data>` **(** **)** |const|                                                                                                                                                                                      |
    50. 

  50.    +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | :ref:`bool<class_bool>`     | :ref:`get_is_active<class_XRNode3D_method_get_is_active>` **(** **)** |const|                                                                                                                                                                                                      |
    52. 

  52.    +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53.    | :ref:`XRPose<class_XRPose>` | :ref:`get_pose<class_XRNode3D_method_get_pose>` **(** **)**                                                                                                                                                                                                                        |
    54. 

  54.    +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55.    | void                        | :ref:`trigger_haptic_pulse<class_XRNode3D_method_trigger_haptic_pulse>` **(** :ref:`String<class_String>` action_name, :ref:`float<class_float>` frequency, :ref:`float<class_float>` amplitude, :ref:`float<class_float>` duration_sec, :ref:`float<class_float>` delay_sec **)** |
    56. 

  56.    +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. 

  58. .. rst-class:: classref-section-separator
    59. 

  59. 

  60. ----
    61. 

  61. 

  62. .. rst-class:: classref-descriptions-group
    63. 

  63. 

  64. Property Descriptions
    65. 

  65. ---------------------
    66. 

  66. 

  67. .. _class_XRNode3D_property_pose:
    68. 

  68. 

  69. .. rst-class:: classref-property
    70. 

  70. 

  71. :ref:`StringName<class_StringName>` **pose** = ``&"default"``
    72. 

  72. 

  73. .. rst-class:: classref-property-setget
    74. 

  74. 

  75. - void **set_pose_name** **(** :ref:`StringName<class_StringName>` value **)**
    76. 

  76. - :ref:`StringName<class_StringName>` **get_pose_name** **(** **)**
    77. 

  77. 

  78. The name of the pose we're bound to. Which poses a tracker supports is not known during design time.
    79. 

  79. 

  80. Godot defines number of standard pose names such as ``aim`` and ``grip`` but other may be configured within a given :ref:`XRInterface<class_XRInterface>`.
    81. 

  81. 

  82. .. rst-class:: classref-item-separator
    83. 

  83. 

  84. ----
    85. 

  85. 

  86. .. _class_XRNode3D_property_tracker:
    87. 

  87. 

  88. .. rst-class:: classref-property
    89. 

  89. 

  90. :ref:`StringName<class_StringName>` **tracker** = ``&""``
    91. 

  91. 

  92. .. rst-class:: classref-property-setget
    93. 

  93. 

  94. - void **set_tracker** **(** :ref:`StringName<class_StringName>` value **)**
    95. 

  95. - :ref:`StringName<class_StringName>` **get_tracker** **(** **)**
    96. 

  96. 

  97. The name of the tracker we're bound to. Which trackers are available is not known during design time.
    98. 

  98. 

  99. Godot defines a number of standard trackers such as ``left_hand`` and ``right_hand`` but others may be configured within a given :ref:`XRInterface<class_XRInterface>`.
    100. 

  100. 

  101. .. rst-class:: classref-section-separator
    102. 

  102. 

  103. ----
    104. 

  104. 

  105. .. rst-class:: classref-descriptions-group
    106. 

  106. 

  107. Method Descriptions
    108. 

  108. -------------------
    109. 

  109. 

  110. .. _class_XRNode3D_method_get_has_tracking_data:
    111. 

  111. 

  112. .. rst-class:: classref-method
    113. 

  113. 

  114. :ref:`bool<class_bool>` **get_has_tracking_data** **(** **)** |const|
    115. 

  115. 

  116. Returns ``true`` if the :ref:`tracker<class_XRNode3D_property_tracker>` has current tracking data for the :ref:`pose<class_XRNode3D_property_pose>` being tracked.
    117. 

  117. 

  118. .. rst-class:: classref-item-separator
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_XRNode3D_method_get_is_active:
    123. 

  123. 

  124. .. rst-class:: classref-method
    125. 

  125. 

  126. :ref:`bool<class_bool>` **get_is_active** **(** **)** |const|
    127. 

  127. 

  128. Returns ``true`` if the :ref:`tracker<class_XRNode3D_property_tracker>` has been registered and the :ref:`pose<class_XRNode3D_property_pose>` is being tracked.
    129. 

  129. 

  130. .. rst-class:: classref-item-separator
    131. 

  131. 

  132. ----
    133. 

  133. 

  134. .. _class_XRNode3D_method_get_pose:
    135. 

  135. 

  136. .. rst-class:: classref-method
    137. 

  137. 

  138. :ref:`XRPose<class_XRPose>` **get_pose** **(** **)**
    139. 

  139. 

  140. Returns the :ref:`XRPose<class_XRPose>` containing the current state of the pose being tracked. This gives access to additional properties of this pose.
    141. 

  141. 

  142. .. rst-class:: classref-item-separator
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_XRNode3D_method_trigger_haptic_pulse:
    147. 

  147. 

  148. .. rst-class:: classref-method
    149. 

  149. 

  150. void **trigger_haptic_pulse** **(** :ref:`String<class_String>` action_name, :ref:`float<class_float>` frequency, :ref:`float<class_float>` amplitude, :ref:`float<class_float>` duration_sec, :ref:`float<class_float>` delay_sec **)**
    151. 

  151. 

  152. Triggers a haptic pulse on a device associated with this interface.
    153. 

  153. 

  154. \ ``action_name`` is the name of the action for this pulse.
    155. 

  155. 

  156. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    157. 

  157. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    158. 

  158. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    159. 

  159. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    160. 

  160. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    161. 

  161. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    162. 

  162.