| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the XRNode3D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_XRNode3D:
- XRNode3D
- ========
- **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`XRAnchor3D<class_XRAnchor3D>`, :ref:`XRController3D<class_XRController3D>`
- A spatial node that has its position automatically updated by the :ref:`XRServer<class_XRServer>`.
- Description
- -----------
- 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.
- Properties
- ----------
- +-------------------------------------+-------------------------------------------------+----------------+
- | :ref:`StringName<class_StringName>` | :ref:`pose<class_XRNode3D_property_pose>` | ``&"default"`` |
- +-------------------------------------+-------------------------------------------------+----------------+
- | :ref:`StringName<class_StringName>` | :ref:`tracker<class_XRNode3D_property_tracker>` | ``&""`` |
- +-------------------------------------+-------------------------------------------------+----------------+
- Methods
- -------
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_has_tracking_data<class_XRNode3D_method_get_has_tracking_data>` **(** **)** |const| |
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_is_active<class_XRNode3D_method_get_is_active>` **(** **)** |const| |
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`XRPose<class_XRPose>` | :ref:`get_pose<class_XRNode3D_method_get_pose>` **(** **)** |
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_XRNode3D_property_pose:
- - :ref:`StringName<class_StringName>` **pose**
- +-----------+----------------------+
- | *Default* | ``&"default"`` |
- +-----------+----------------------+
- | *Setter* | set_pose_name(value) |
- +-----------+----------------------+
- | *Getter* | 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<class_XRInterface>`.
- ----
- .. _class_XRNode3D_property_tracker:
- - :ref:`StringName<class_StringName>` **tracker**
- +-----------+--------------------+
- | *Default* | ``&""`` |
- +-----------+--------------------+
- | *Setter* | set_tracker(value) |
- +-----------+--------------------+
- | *Getter* | 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<class_XRInterface>`.
- Method Descriptions
- -------------------
- .. _class_XRNode3D_method_get_has_tracking_data:
- - :ref:`bool<class_bool>` **get_has_tracking_data** **(** **)** |const|
- Returns ``true`` if the :ref:`tracker<class_XRNode3D_property_tracker>` has current tracking data for the :ref:`pose<class_XRNode3D_property_pose>` being tracked.
- ----
- .. _class_XRNode3D_method_get_is_active:
- - :ref:`bool<class_bool>` **get_is_active** **(** **)** |const|
- Returns ``true`` if the :ref:`tracker<class_XRNode3D_property_tracker>` has been registered and the :ref:`pose<class_XRNode3D_property_pose>` is being tracked.
- ----
- .. _class_XRNode3D_method_get_pose:
- - :ref:`XRPose<class_XRPose>` **get_pose** **(** **)**
- Returns the :ref:`XRPose<class_XRPose>` containing the current state of the pose being tracked. This gives access to additional properties of this pose.
- ----
- .. _class_XRNode3D_method_trigger_haptic_pulse:
- - 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 **)**
- Triggers a haptic pulse on a device associated with this interface.
- \ ``action_name`` is the name of the action for this pulse.
- .. |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.)`
|
