:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRNode3D.xml. .. _class_XRNode3D: XRNode3D ======== **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`XRAnchor3D`, :ref:`XRController3D` A 3D node that has its position automatically updated by the :ref:`XRServer`. .. rst-class:: classref-introduction-group Description ----------- This node can be bound to a specific pose of a :ref:`XRPositionalTracker` and will automatically have its :ref:`Node3D.transform` updated by the :ref:`XRServer`. Nodes of this type must be added as children of the :ref:`XROrigin3D` node. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`XR documentation index <../tutorials/xr/index>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------+---------------------------------------------------------------------+----------------+ | :ref:`StringName` | :ref:`pose` | ``&"default"`` | +-------------------------------------+---------------------------------------------------------------------+----------------+ | :ref:`bool` | :ref:`show_when_tracked` | ``false`` | +-------------------------------------+---------------------------------------------------------------------+----------------+ | :ref:`StringName` | :ref:`tracker` | ``&""`` | +-------------------------------------+---------------------------------------------------------------------+----------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_has_tracking_data`\ (\ ) |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_is_active`\ (\ ) |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`XRPose` | :ref:`get_pose`\ (\ ) | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_haptic_pulse`\ (\ action_name\: :ref:`String`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_XRNode3D_signal_tracking_changed: .. rst-class:: classref-signal **tracking_changed**\ (\ tracking\: :ref:`bool`\ ) :ref:`🔗` Emitted when the :ref:`tracker` starts or stops receiving updated tracking data for the :ref:`pose` being tracked. The ``tracking`` argument indicates whether the tracker is getting updated tracking data. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_XRNode3D_property_pose: .. rst-class:: classref-property :ref:`StringName` **pose** = ``&"default"`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pose_name**\ (\ value\: :ref:`StringName`\ ) - :ref:`StringName` **get_pose_name**\ (\ ) The name of the pose we're bound to. Which poses a tracker supports is not known during design time. Godot defines number of standard pose names such as ``aim`` and ``grip`` but other may be configured within a given :ref:`XRInterface`. .. rst-class:: classref-item-separator ---- .. _class_XRNode3D_property_show_when_tracked: .. rst-class:: classref-property :ref:`bool` **show_when_tracked** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_show_when_tracked**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_show_when_tracked**\ (\ ) Enables showing the node when tracking starts, and hiding the node when tracking is lost. .. rst-class:: classref-item-separator ---- .. _class_XRNode3D_property_tracker: .. rst-class:: classref-property :ref:`StringName` **tracker** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tracker**\ (\ value\: :ref:`StringName`\ ) - :ref:`StringName` **get_tracker**\ (\ ) The name of the tracker we're bound to. Which trackers are available is not known during design time. Godot defines a number of standard trackers such as ``left_hand`` and ``right_hand`` but others may be configured within a given :ref:`XRInterface`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_XRNode3D_method_get_has_tracking_data: .. rst-class:: classref-method :ref:`bool` **get_has_tracking_data**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`tracker` has current tracking data for the :ref:`pose` being tracked. .. rst-class:: classref-item-separator ---- .. _class_XRNode3D_method_get_is_active: .. rst-class:: classref-method :ref:`bool` **get_is_active**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the :ref:`tracker` has been registered and the :ref:`pose` is being tracked. .. rst-class:: classref-item-separator ---- .. _class_XRNode3D_method_get_pose: .. rst-class:: classref-method :ref:`XRPose` **get_pose**\ (\ ) :ref:`🔗` Returns the :ref:`XRPose` containing the current state of the pose being tracked. This gives access to additional properties of this pose. .. rst-class:: classref-item-separator ---- .. _class_XRNode3D_method_trigger_haptic_pulse: .. rst-class:: classref-method |void| **trigger_haptic_pulse**\ (\ action_name\: :ref:`String`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) :ref:`🔗` Triggers a haptic pulse on a device associated with this interface. \ ``action_name`` is the name of the action for this pulse. \ ``frequency`` is the frequency of the pulse, set to ``0.0`` to have the system use a default frequency. \ ``amplitude`` is the amplitude of the pulse between ``0.0`` and ``1.0``. \ ``duration_sec`` is the duration of the pulse in seconds. \ ``delay_sec`` is a delay in seconds before the pulse is given. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`