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
TrackedPoseDriver
Syntax
[Serializable]
public class TrackedPoseDriver : MonoBehaviour
Fields
m_OriginPose
Declaration
protected Pose m_OriginPose
Field Value
Properties
deviceType
This is used to indicate which pose the TrackedPoseDriver is currently tracking.
Declaration
public TrackedPoseDriver.DeviceType deviceType { get; }
Property Value
originPose
Declaration
public Pose originPose { get; set; }
Property Value
poseSource
The pose being tracked by the tracked pose driver
Declaration
public TrackedPoseDriver.TrackedPose poseSource { get; }
Property Value
trackingType
The tracking type being used by the tracked pose driver
Declaration
public TrackedPoseDriver.TrackingType trackingType { get; set; }
Property Value
updateType
The update type being used by the tracked pose driver
Declaration
public TrackedPoseDriver.UpdateType updateType { get; set; }
Property Value
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
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()
Declaration
protected virtual void PerformUpdate()
Declaration
protected virtual void SetLocalTransform(Vector3 newPosition, Quaternion newRotation, PoseDataFlags poseFlags)
Parameters
Type |
Name |
Description |
Vector3 |
newPosition |
|
Quaternion |
newRotation |
|
PoseDataFlags |
poseFlags |
|
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
Returns
Type |
Description |
Boolean |
true if the values provided are sensible, otherwise false
|
Declaration
protected Pose TransformPoseByOriginIfNeeded(Pose pose)
Parameters
Type |
Name |
Description |
Pose |
pose |
|
Returns
Update()
Declaration
protected virtual void Update()
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.