Inheritance #

RefCounted

- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
XRPose

Table of contents

XRPose #

is_refcounted, is_instantiable, core, not_builtin_classes

This object contains all data related to a pose on a tracked object.

XR runtimes often identify multiple locations on devices such as controllers that are spatially tracked.

Orientation, location, linear velocity and angular velocity are all provided for each pose by the XR runtime. This object contains this state of a pose.

Members #

var angular_velocity: Vector3 = Vector3(0, 0, 0)#

The angular velocity for this pose.

var has_tracking_data: bool = false#

If true our tracking data is up to date. If false we're no longer receiving new tracking data and our state is whatever that last valid state was.

var linear_velocity: Vector3 = Vector3(0, 0, 0)#

The linear velocity of this pose.

var name: StringName = &""#

The name of this pose. Usually, this name is derived from an action map set up by the user. Godot also suggests some pose names that XRInterface objects are expected to implement:

- root is the root location, often used for tracked objects that do not have further nodes.

- aim is the tip of a controller with its orientation pointing outwards, often used for raycasts.

- grip is the location where the user grips the controller.

- skeleton is the root location for a hand mesh, when using hand tracking and an animated skeleton is supplied by the XR runtime.

var tracking_confidence = XR_TRACKING_CONFIDENCE_NONE#

The tracking confidence for this pose, provides insight on how accurate the spatial positioning of this record is.

var transform: Transform3D = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)#

The transform containing the original and transform as reported by the XR runtime.

Methods #

const func get_adjusted_transform() -> Transform3D#

Returns the transform with world scale and our reference frame applied. This is the transform used to position XRNode3D objects.

Annotations #

Constants #

const XR_TRACKING_CONFIDENCE_NONE = 0 enum TrackingConfidence#

No tracking information is available for this pose.

const XR_TRACKING_CONFIDENCE_LOW = 1 enum TrackingConfidence#

Tracking information may be inaccurate or estimated. For example, with inside out tracking this would indicate a controller may be (partially) obscured.

const XR_TRACKING_CONFIDENCE_HIGH = 2 enum TrackingConfidence#

Tracking information is considered accurate and up to date.

Constructors #

Enums #

TrackingConfidence#

enum TrackingConfidence { XR_TRACKING_CONFIDENCE_NONE = 0, XR_TRACKING_CONFIDENCE_LOW = 1, XR_TRACKING_CONFIDENCE_HIGH = 2, }

Operators #

Signals #

Theme Items #

Tutorials #