Class TrackedPoseDriver

The TrackedPoseDriver component applies the current Pose value of a tracked device to the transform of the GameObject. TrackedPoseDriver can track multiple types of devices including XR HMDs, controllers, and remotes.

Inheritance

System.Object

TrackedPoseDriver

TrackedPoseDriverTests.TestTrackedPoseDriverWrapper

Namespace: UnityEngine.SpatialTracking

Syntax

[Serializable]
public class TrackedPoseDriver : MonoBehaviour

Fields

m_OriginPose

Declaration

protected Pose m_OriginPose

Field Value

Type	Description
Pose

Properties

deviceType

This is used to indicate which pose the TrackedPoseDriver is currently tracking.

Declaration

public TrackedPoseDriver.DeviceType deviceType { get; }

Property Value

Type	Description
TrackedPoseDriver.DeviceType

originPose

Declaration

public Pose originPose { get; set; }

Property Value

Type	Description
Pose

poseProviderComponent

Optional: This field holds the reference to the PoseProvider instance that, if set, will be used to override the behavior of the TrackedPoseDriver. When this field is empty, the TrackedPoseDriver will operate as per usual, with pose data being retrieved from the device or pose settings of the TrackedPoseDriver. When this field is set, the pose data will be provided by the attached PoseProvider. The device or pose fields will be hidden as they are no longer used to control the parent GameObject Transform.

Declaration

public BasePoseProvider poseProviderComponent { get; set; }

Property Value

Type	Description
BasePoseProvider

poseSource

The pose being tracked by the tracked pose driver

Declaration

public TrackedPoseDriver.TrackedPose poseSource { get; }

Property Value

Type	Description
TrackedPoseDriver.TrackedPose

trackingType

The tracking type being used by the tracked pose driver

Declaration

public TrackedPoseDriver.TrackingType trackingType { get; set; }

Property Value

Type	Description
TrackedPoseDriver.TrackingType

updateType

The update type being used by the tracked pose driver

Declaration

public TrackedPoseDriver.UpdateType updateType { get; set; }

Property Value

Type	Description
TrackedPoseDriver.UpdateType

UseRelativeTransform

This is used to indicate whether the TrackedPoseDriver will use the object's original transform as its basis.

Declaration

public bool UseRelativeTransform { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Awake()

Declaration

protected virtual void Awake()

FixedUpdate()

Declaration

protected virtual void FixedUpdate()

OnBeforeRender()

Declaration

protected virtual void OnBeforeRender()

OnDestroy()

Declaration

protected virtual void OnDestroy()

OnDisable()

Declaration

protected virtual void OnDisable()

OnEnable()

Declaration

protected virtual void OnEnable()

PerformUpdate()

Declaration

protected virtual void PerformUpdate()

SetLocalTransform(Vector3, Quaternion)

Declaration

protected virtual void SetLocalTransform(Vector3 newPosition, Quaternion newRotation)

Parameters

Type	Name	Description
Vector3	newPosition
Quaternion	newRotation

SetPoseSource(TrackedPoseDriver.DeviceType, TrackedPoseDriver.TrackedPose)

This method is used to set the device / pose pair for the SpatialTracking.TrackedPoseDriver. setting an invalid combination of these values will return false.

Declaration

public bool SetPoseSource(TrackedPoseDriver.DeviceType deviceType, TrackedPoseDriver.TrackedPose pose)

Parameters

Type	Name	Description
TrackedPoseDriver.DeviceType	deviceType	The device type that we wish to track
TrackedPoseDriver.TrackedPose	pose	The pose source that we wish to track

Returns

Type	Description
System.Boolean	true if the values provided are sensible, otherwise false

TransformPoseByOriginIfNeeded(Pose)

Declaration

protected Pose TransformPoseByOriginIfNeeded(Pose pose)

Parameters

Type	Name	Description
Pose	pose

Returns

Type	Description
Pose

Update()

Declaration

protected virtual void Update()