Class reference
XRNode3D
Inherits Node3D
A 3D node that has its position automatically updated by the XRServer.
Description
This node can be bound to a specific pose of an XRPositionalTracker and will automatically have its Node3D.transform updated by the XRServer. Nodes of this type must be added as children of the XROrigin3D node.
Properties
int physics_interpolation_mode = 2
int physics_interpolation_mode = 2StringName pose = &"default"
StringName pose = &"default"The name of the pose we're bound to. Which poses a tracker supports is not known during design time. Redot defines number of standard pose names such as aim and grip but other may be configured within a given XRInterface.
bool show_when_tracked = false
bool show_when_tracked = falseEnables showing the node when tracking starts, and hiding the node when tracking is lost.
StringName tracker = &""
StringName tracker = &""The name of the tracker we're bound to. Which trackers are available is not known during design time. Redot defines a number of standard trackers such as left_hand and right_hand but others may be configured within a given XRInterface.
Methods
bool get_has_tracking_data() const
bool get_has_tracking_data() constReturns true if the tracker has current tracking data for the pose being tracked.
bool get_is_active() const
bool get_is_active() constReturns true if the tracker has been registered and the pose is being tracked.
XRPose get_pose()
XRPose get_pose()Returns the XRPose containing the current state of the pose being tracked. This gives access to additional properties of this pose.
void trigger_haptic_pulse(String action_name, float frequency, float amplitude, float duration_sec, float delay_sec)
String action_name, float frequency, float amplitude, float duration_sec, 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. 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.