Class TrackXRDevice

Tracks a spatial anchor.

Inheritance

object

IdentifiableObject

DependencyObject

AttachableObject

PrefabInstanceObject

Component

Behavior

TrackXRDevice

AdvancedTrackXRDevice

TrackXRController

Implements

IDependencyObject

Inherited Members

Behavior.Family

Behavior.UpdateOrder

Component.Owner

Component.Managers

Component.ShouldBeActivated

Component.Clone()

Component.Attach(Entity)

Component.OnLoaded()

Component.OnActivated()

Component.Start()

Component.OnDeactivated()

Component.OnDetach()

Component.OnDestroy()

PrefabInstanceObject.PrefabSource

PrefabInstanceObject.RefreshPrefab(Prefab)

PrefabInstanceObject.PrefabElementId

PrefabInstanceObject.IsPrefabInstance

PrefabInstanceObject.IsMissingPrefabSource

AttachableObject.AttachableStateChanged

AttachableObject.IsEnabled

AttachableObject.State

AttachableObject.IsLoaded

AttachableObject.IsAttached

AttachableObject.IsActivated

AttachableObject.IsStarted

AttachableObject.IsDestroyed

AttachableObject.Destroy()

AttachableObject.DependencyBroken()

DependencyObject.Dependencies

DependencyObject.OnDependencyRemoved

IdentifiableObject.Id

IdentifiableObject.IdHasChanged(Guid)

Namespace: Evergine.Components.XR

Assembly: Evergine.Components.dll

Syntax

public class TrackXRDevice : Behavior, IDependencyObject

Fields

pointer

The pointer ray in world space.

Declaration

protected Ray pointer

Field Value

Type	Description
Ray

transform

Owner Entity's Transform3D Component.

Declaration

[BindComponent(true, true, BindComponentSource.Owner, null, true)]
protected Transform3D transform

Field Value

Type	Description
Transform3D

xrPlatform

XReality platform.

Declaration

[BindService(true)]
protected XRPlatform xrPlatform

Field Value

Type	Description
XRPlatform

Properties

AngularVelocity

Gets the device's angular velocity.

Declaration

public Vector3 AngularVelocity { get; }

Property Value

Type	Description
Vector3

InternalDeviceType

Gets or sets the device type.

Declaration

protected XRTrackedDeviceType InternalDeviceType { get; set; }

Property Value

Type	Description
XRTrackedDeviceType

InternalHandedness

Gets or sets the controller role.

Declaration

protected XRHandedness InternalHandedness { get; set; }

Property Value

Type	Description
XRHandedness

InternalIndex

Gets or sets the index.

Declaration

protected uint InternalIndex { get; set; }

Property Value

Type	Description
uint

InternalSelectionStrategy

Gets or sets the Device Selection Strategy.

Declaration

protected TrackXRDevice.SelectionDeviceStrategy InternalSelectionStrategy { get; set; }

Property Value

Type	Description
TrackXRDevice.SelectionDeviceStrategy

IsConnected

Gets a value indicating whether this device has been connected to a real device.

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
bool

LocalPointer

Gets the device pointer ray in local space.

Declaration

public Ray LocalPointer { get; }

Property Value

Type	Description
Ray

LocalPose

Gets the current device pose in local space.

Declaration

public ViewPose LocalPose { get; }

Property Value

Type	Description
ViewPose

Pointer

Gets the device pointer ray.

Declaration

public Ray Pointer { get; }

Property Value

Type	Description
Ray

Pose

Gets the current device's pose.

Declaration

public ViewPose Pose { get; }

Property Value

Type	Description
ViewPose

PoseIsValid

Gets a value indicating whether the pose of this device is valid.

Declaration

public bool PoseIsValid { get; }

Property Value

Type	Description
bool

TrackedDevice

Gets the tracked device.

Declaration

public XRTrackedDevice TrackedDevice { get; }

Property Value

Type	Description
XRTrackedDevice

TrackingLostMode

Gets or sets how this controller behaves after tracking is lost.

Declaration

[DataMember]
public TrackXRDevice.XRTrackingLostMode TrackingLostMode { get; set; }

Property Value

Type	Description
TrackXRDevice.XRTrackingLostMode

TrackingState

Gets the current tracking state of this device.

Declaration

public XRTrackingState TrackingState { get; }

Property Value

Type	Description
XRTrackingState

Transform

Gets the transform of the tracked device.

Declaration

public Transform3D Transform { get; }

Property Value

Type	Description
Transform3D

Velocity

Gets the device's angular velocity.

Declaration

public Vector3 Velocity { get; }

Property Value

Type	Description
Vector3

Methods

InternalUpdate()

Updates method by the tracked device.

Declaration

protected virtual void InternalUpdate()

OnAttached()

Invoked when the object is attached to the system.

Declaration

protected override bool OnAttached()

Returns

Type	Description
bool	True if everything is OK.

Overrides

Behavior.OnAttached()

OnDetached()

Invoked when the object is detached.

Declaration

protected override void OnDetached()

Overrides

Behavior.OnDetached()

RefreshTrackedDevice()

Refreshes the tracked device.

Declaration

protected virtual void RefreshTrackedDevice()

Update(TimeSpan)

Allows this instance to execute custom logic during its Update.

Declaration

protected override void Update(TimeSpan gameTime)

Parameters

Type	Name	Description
TimeSpan	gameTime	The game time.

Overrides

Behavior.Update(TimeSpan)

Remarks

This method will not be executed if the Component or the Entity owning it is not Active.

Events

OnTrackedDeviceChanged

Event triggered when a tracked device changes.

Declaration

public event EventHandler<XRTrackedDevice> OnTrackedDeviceChanged

Event Type

Type	Description
EventHandler<XRTrackedDevice>

Implements

IDependencyObject

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)