Class XRImageTrackingSubsystem.Provider

Methods to implement by the implementing provider.

Inheritance

Object

XRImageTrackingSubsystem.Provider

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public abstract class Provider

Properties

currentMaxNumberOfMovingImages

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

Declaration

public virtual int currentMaxNumberOfMovingImages { get; }

Property Value

Type	Description
Int32

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 implies the subsystem should stop detecting and tracking images.

requestedMaxNumberOfMovingImages

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

Declaration

public virtual int requestedMaxNumberOfMovingImages { get; set; }

Property Value

Type	Description
Int32

Remarks

Must be implemented if supportsMovingImages is true; otherwise, this property will never be set and need not 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

public abstract RuntimeReferenceImageLibrary CreateRuntimeLibrary(XRReferenceImageLibrary serializedLibrary)

Parameters

Type	Name	Description
XRReferenceImageLibrary	serializedLibrary	A XRReferenceImageLibrary to deserialize.

Returns

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

Destroy()

Called when the subsystem is destroyed.

Declaration

public virtual void Destroy()

GetChanges(XRTrackedImage, Allocator)

Get the changes (added, updated, removed) to the tracked images 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 (added, updated, removed) tracked images since the last call to this method.