Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AnimationMixer (2)
- AudioStreamPlayer
- CanvasItem (2)
- CanvasLayer (1)
- EditorFileSystem
- EditorPlugin (1)
- EditorResourcePreview
- HTTPRequest
- InstancePlaceholder
- MissingNode
- MultiplayerSpawner
- MultiplayerSynchronizer
- NavigationAgent2D
- NavigationAgent3D
- Node3D (31)
- ResourcePreloader
- ShaderGlobalsOverride
- StatusIndicator
- Timer
- Viewport (2)
- WorldEnvironment
- AudioListener3D
- AudioStreamPlayer3D
- BoneAttachment3D
- Camera3D (1)
- CollisionObject3D (2)
- CollisionPolygon3D
- CollisionShape3D
- GridMap
- ImporterMeshInstance3D
- Joint3D (5)
- LightmapProbe
- Marker3D
- NavigationLink3D
- NavigationObstacle3D
- NavigationRegion3D
- OpenXRCompositionLayer (3)
- OpenXRHand
- Path3D
- PathFollow3D
- RayCast3D
- RemoteTransform3D
- ShapeCast3D
- Skeleton3D
- SkeletonModifier3D (7)
- SpringArm3D
- SpringBoneCollision3D (3)
- VehicleWheel3D
- VisualInstance3D (13)
- XRFaceModifier3D
- XRNode3D (2)
- XROrigin3D
Table of contents
-
var physics_interpolation_mode = PHYSICS_INTERPOLATION_MODE_OFF -
var pose: StringName = &"default" -
var show_when_tracked: bool = false -
var tracker: StringName = &"" -
const func get_has_tracking_data() -> bool -
const func get_is_active() -> bool -
func get_pose() -> XRPose -
func trigger_haptic_pulse(delay_sec: float) -> void -
signal tracking_changed(tracking: bool)
XRNode3D #
is_instantiable, Node3D, Node3D, Node, core, not_builtin_classes
A 3D node that has its position automatically updated by the XRServer.
This node can be bound to a specific pose of a 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.
Members #
var physics_interpolation_mode = PHYSICS_INTERPOLATION_MODE_OFF#
var pose: StringName = &"default"#
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 XRInterface.
var show_when_tracked: bool = false#
Enables showing the node when tracking starts, and hiding the node when tracking is lost.
var tracker: StringName = &""#
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 XRInterface.
Methods #
const func get_has_tracking_data() -> bool#
Returns true if the tracker has current tracking data for the pose being tracked.
const func get_is_active() -> bool#
Returns true if the tracker has been registered and the pose is being tracked.
func get_pose() -> XRPose#
Returns the XRPose containing the current state of the pose being tracked. This gives access to additional properties of this pose.
func trigger_haptic_pulse(delay_sec: float) -> void#
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.
Annotations #
Constants #
Constructors #
Enums #
Operators #
Signals #
signal tracking_changed(tracking: bool)#
Emitted when the tracker starts or stops receiving updated tracking data for the pose being tracked. The tracking argument indicates whether the tracker is getting updated tracking data.