Class XRImageTrackingSubsystem.Provider

Methods to implement by the implementing provider.

Inheritance

object

SubsystemProvider

SubsystemProvider<XRImageTrackingSubsystem>

XRImageTrackingSubsystem.Provider

Inherited Members

SubsystemProvider<XRImageTrackingSubsystem>.TryInitialize()

SubsystemProvider<XRImageTrackingSubsystem>.Start()

SubsystemProvider<XRImageTrackingSubsystem>.Stop()

SubsystemProvider<XRImageTrackingSubsystem>.Destroy()

SubsystemProvider.running

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public abstract class XRImageTrackingSubsystem.Provider : SubsystemProvider<XRImageTrackingSubsystem>

Properties

currentMaxNumberOfMovingImages

The current maximum number of moving images to track in realtime.

Declaration

public virtual int currentMaxNumberOfMovingImages { get; }

Property Value

Type	Description
int

Remarks

Must be implemented if supportsMovingImages is true.

imageLibrary

Sets the set of images to search for in the environment.

Declaration

public abstract RuntimeReferenceImageLibrary imageLibrary { set; }

Property Value

Type	Description
RuntimeReferenceImageLibrary

Remarks

Setting this to null or an empty library implies the subsystem should stop detecting and tracking images.

requestedMaxNumberOfMovingImages

The requested maximum number of moving images to track in real time.

Declaration

public virtual int requestedMaxNumberOfMovingImages { get; set; }

Property Value

Type	Description
int

Remarks

Must be implemented if supportsMovingImages is true; otherwise, this property will never be set and doesn't need to be implemented.

Exceptions

Type	Condition
NotSupportedException	Thrown if not overridden by the derived class.

Methods

CreateRuntimeLibrary(XRReferenceImageLibrary)

Creates a RuntimeReferenceImageLibrary from an existing XRReferenceImageLibrary, or an empty library if serializedLibrary is null.

Declaration

[Obsolete("CreateRuntimeLibrary is deprecated in AR Foundation 6.7. Use TryCreateRuntimeLibraryAsync instead.")]
public abstract RuntimeReferenceImageLibrary CreateRuntimeLibrary(XRReferenceImageLibrary serializedLibrary)

Parameters

Type	Name	Description
XRReferenceImageLibrary	serializedLibrary	A XRReferenceImageLibrary to build the RuntimeReferenceImageLibrary from.

Returns

Type	Description
RuntimeReferenceImageLibrary	The runtime version of serializedLibrary or an empty library if serializedLibrary is null.

GetChanges(XRTrackedImage, Allocator)

Get the changes to the tracked images (added, updated, and removed) since the last call to this method.

Declaration

public abstract TrackableChanges<XRTrackedImage> GetChanges(XRTrackedImage defaultTrackedImage, Allocator allocator)

Parameters

Type	Name	Description
XRTrackedImage	defaultTrackedImage	An XRTrackedImage populated with default values. The implementation should first fill arrays of added, updated, and removed with copies of this before copying in its own values. This guards against additional fields added to the XRTrackedImage in the future.
Allocator	allocator	The allocator to use for the returned data.

Returns

Type	Description
TrackableChanges<XRTrackedImage>	The set of changes to tracked images (added, updated, and removed) since the last call to this method.

TryCreateRuntimeLibraryAsync(XRReferenceImageLibrary, CancellationToken)

Asynchronously creates a RuntimeReferenceImageLibrary from an existing XRReferenceImageLibrary, or an empty library if serializedLibrary is null.

Declaration

public virtual Awaitable<Result<RuntimeReferenceImageLibrary>> TryCreateRuntimeLibraryAsync(XRReferenceImageLibrary serializedLibrary, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
XRReferenceImageLibrary	serializedLibrary	A XRReferenceImageLibrary to build the RuntimeReferenceImageLibrary from, or null to create an empty library.
CancellationToken	cancellationToken	A cancellation token, which you can use to cancel the operation in progress.

Returns

Type	Description
Awaitable<Result<RuntimeReferenceImageLibrary>>	The result of the async operation that contains the new RuntimeReferenceImageLibrary.

Remarks

Providers that create libraries asynchronously should throw OperationCanceledException if cancellationToken is canceled before the operation completes. Providers that complete synchronously can ignore cancellationToken.

Exceptions

Type	Condition
NotSupportedException	Thrown if not overridden by the derived class.