Class XRImageTracking

Tracks an image by its name.

Inheritance
object
IdentifiableObject
DependencyObject
AttachableObject
PrefabInstanceObject
Component
XRImageTracking
Implements
Inherited Members
Component.Owner
Component.Managers
Component.ShouldBeActivated
Component.Clone()
Component.Attach(Entity)
Component.OnLoaded()
Component.OnActivated()
Component.Start()
Component.OnDeactivated()
Component.OnDestroy()
PrefabInstanceObject.PrefabSource
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
Namespace: Evergine.Components.XR
Assembly: Evergine.Components.dll
Syntax
public class XRImageTracking : Component, IDependencyObject

Fields

transform

Owner's transform.

Declaration
[BindComponent(true, true, BindComponentSource.Owner, null, true)]
protected Transform3D transform
Field Value
Type Description
Transform3D

Properties

ImageName

Gets or sets image name.

Declaration
public string ImageName { get; set; }
Property Value
Type Description
string

IsFixed

Gets or sets a value indicating whether image is fixed (not being moved) in real world.

Declaration
public bool IsFixed { get; set; }
Property Value
Type Description
bool

Size

Gets the size of the image target.

Declaration
public Vector3 Size { get; }
Property Value
Type Description
Vector3

TrackingMethod

Gets the current tracking method.

Declaration
public XRImageTrackingMethod TrackingMethod { get; }
Property Value
Type Description
XRImageTrackingMethod

Methods

OnAnchorAdded()

Invoked when face anchor has been detected.

Declaration
protected virtual void OnAnchorAdded()

OnAnchorRemoved()

Invoked when face anchor has been removed.

Declaration
protected virtual void OnAnchorRemoved()

OnAnchorUpdated()

Invoked when face anchor has been updated.

Declaration
protected virtual void OnAnchorUpdated()

OnAttached()

Invoked when the object is attached to the system.

Declaration
protected override bool OnAttached()
Returns
Type Description
bool

True if all is OK.
Overrides
Evergine.Framework.Component.OnAttached()

OnDetach()

Invoked when the object is detached.

Declaration
protected override void OnDetach()
Overrides
Evergine.Framework.Component.OnDetach()

UpdateEntityPosition(XRImageTrackable)

Updates entity position.

Declaration
protected virtual void UpdateEntityPosition(XRImageTrackable anchor)
Parameters
Type Name Description
XRImageTrackable anchor

Image anchor.

Implements

Extension Methods