Class XRAnchorSubsystemDescriptor

Indicates the capabilities supported by a provider of the XRAnchorSubsystem. Provider implementations must derive from XRAnchorSubsystem.Provider and may override virtual class members.

Inheritance

object

SubsystemDescriptorWithProvider

SubsystemDescriptorWithProvider<XRAnchorSubsystem, XRAnchorSubsystem.Provider>

XRAnchorSubsystemDescriptor

Implements

ISubsystemDescriptor

Inherited Members

SubsystemDescriptorWithProvider<XRAnchorSubsystem, XRAnchorSubsystem.Provider>.Create()

SubsystemDescriptorWithProvider.id

SubsystemDescriptorWithProvider.providerType

SubsystemDescriptorWithProvider.subsystemTypeOverride

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 class XRAnchorSubsystemDescriptor : SubsystemDescriptorWithProvider<XRAnchorSubsystem, XRAnchorSubsystem.Provider>, ISubsystemDescriptor

Properties

supportsAsyncCancellation

Indicates whether the provider implementation supports cancelling async operations in progress using a CancellationToken.

Declaration

public bool supportsAsyncCancellation { get; }

Property Value

Type	Description
bool	If false, XRAnchorSubsystem APIs that take a CancellationToken as input will ignore the input cancellation token.

supportsEraseAnchor

Indicates whether the provider implementation supports the ability to erase the persistent saved data associated with an anchor via XRAnchorSubsystem.TryEraseAnchorAsync.

Declaration

public bool supportsEraseAnchor { get; }

Property Value

Type	Description
bool	If false, TryEraseAnchorAsync will throw a NotImplementedException.

supportsGetSavedAnchorIds

Indicates whether the provider implementation supports the ability to get all saved persistent anchor GUIDs via XRAnchorSubsystem.TryGetSavedAnchorIdsAsync.

Declaration

public bool supportsGetSavedAnchorIds { get; }

Property Value

Type	Description
bool	If false, TryGetSavedAnchorIdsAsync will throw a NotImplementedException.

supportsLoadAnchor

Indicates whether the provider implementation supports the ability to load persistently saved anchors via XRAnchorSubsystem.TryLoadAnchorAsync.

Declaration

public bool supportsLoadAnchor { get; }

Property Value

Type	Description
bool	If false, TryLoadAnchorAsync will throw a NotImplementedException.

supportsSaveAnchor

Indicates whether the provider implementation supports the ability to persistently save anchors via XRAnchorSubsystem.TrySaveAnchorAsync.

Declaration

public bool supportsSaveAnchor { get; }

Property Value

Type	Description
bool	If false, TrySaveAnchorAsync will throw a NotImplementedException.

supportsSynchronousAdd

Indicates whether the provider implementation supports the ability to synchronously add anchors via XRAnchorSubsystem.TryAddAnchor. If false, TryAddAnchor must always return false. In this case, use XRAnchorSubsystem.TryAddAnchorAsync instead.

Declaration

public bool supportsSynchronousAdd { get; }

Property Value

Type	Description
bool

supportsTrackableAttachments

Indicates whether the provider implementation supports the ability to attach an anchor to a trackable via XRAnchorSubsystem.TryAttachAnchor. If false, TryAttachAnchor must always return false.

Declaration

public bool supportsTrackableAttachments { get; }

Property Value

Type	Description
bool

Methods

Create(Cinfo)

Creates a new subsystem descriptor instance and registers it with the SubsystemManager.

Declaration

[Obsolete("Create(Cinfo) has been deprecated in AR Foundation version 6.0. Use Register(Cinfo) instead (UnityUpgradable) -> Register(*)", false)]
public static void Create(XRAnchorSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRAnchorSubsystemDescriptor.Cinfo	cinfo	Construction info for the descriptor.

Register(Cinfo)

Creates a new subsystem descriptor instance and registers it with the SubsystemManager.

Declaration

public static void Register(XRAnchorSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRAnchorSubsystemDescriptor.Cinfo	cinfo	Construction info for the descriptor.

Implements

ISubsystemDescriptor