Class SpatialAnchorSubsystem

The OpenXR Spatial Entities implementation of the UnityEngine.XR.ARSubsystems.XRAnchorSubsystem. Don't create this directly. Use the SubsystemManager instead.

Inheritance

object

SubsystemWithProvider

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>

XRSubsystem<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>

TrackingSubsystem<XRAnchor, XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>

XRAnchorSubsystem

SpatialAnchorSubsystem

Implements

ISubsystem

Inherited Members

XRAnchorSubsystem.GetChanges(Allocator)

XRAnchorSubsystem.TryAddAnchor(Pose, out XRAnchor)

XRAnchorSubsystem.TryAddAnchorAsync(Pose)

XRAnchorSubsystem.TryAttachAnchor(TrackableId, Pose, out XRAnchor)

XRAnchorSubsystem.TryRemoveAnchor(TrackableId)

XRAnchorSubsystem.TrySaveAnchorAsync(TrackableId, CancellationToken)

XRAnchorSubsystem.TrySaveAnchorsAsync(NativeArray<TrackableId>, Allocator, CancellationToken)

XRAnchorSubsystem.TryLoadAnchorAsync(SerializableGuid, CancellationToken)

XRAnchorSubsystem.TryLoadAnchorsAsync(NativeArray<SerializableGuid>, Allocator, Action<NativeArray<XRLoadAnchorResult>>, CancellationToken)

XRAnchorSubsystem.TryEraseAnchorAsync(SerializableGuid, CancellationToken)

XRAnchorSubsystem.TryEraseAnchorsAsync(NativeArray<SerializableGuid>, Allocator, CancellationToken)

XRAnchorSubsystem.TryGetSavedAnchorIdsAsync(Allocator, CancellationToken)

TrackingSubsystem<XRAnchor, XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.GetChanges(Allocator)

XRSubsystem<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.GetPermissionState()

XRSubsystem<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.TryStartAsync(CancellationToken, XRSubsystemStartOptions)

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.OnCreate()

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.OnStart()

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.OnStop()

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.OnDestroy()

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.subsystemDescriptor

SubsystemWithProvider<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.provider

SubsystemWithProvider.Start()

SubsystemWithProvider.OnStart()

SubsystemWithProvider.Stop()

SubsystemWithProvider.OnStop()

SubsystemWithProvider.Destroy()

SubsystemWithProvider.running

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.OpenXR.Features.SpatialEntities

Assembly: Unity.XR.SpatialEntities.dll

Syntax

[Preserve]
public class SpatialAnchorSubsystem : XRAnchorSubsystem, ISubsystem

Methods

GetPermissionState()

Get the state of any required permissions for this subsystem to run on the current device.

Declaration

public override XRPermissionState GetPermissionState()

Returns

Type	Description
XRPermissionState	The permission state.

Overrides

UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRAnchorSubsystem, UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRAnchorSubsystem.Provider>.GetPermissionState()

OnDestroy()

Called when the subsystem is being destroyed.

Declaration

protected override void OnDestroy()

Overrides

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRAnchorSubsystem, UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRAnchorSubsystem.Provider>.OnDestroy()

TryStartAsync(CancellationToken, XRSubsystemStartOptions)

Attempts to start the subsystem with the given options.

Declaration

public override Awaitable<XRResultStatus> TryStartAsync(CancellationToken token, XRSubsystemStartOptions options = XRSubsystemStartOptions.None)

Parameters

Type	Name	Description
CancellationToken	token	The cancellation token.
XRSubsystemStartOptions	options	The start options.

Returns

Type	Description
Awaitable<XRResultStatus>	A status representing whether the subsystem was successfully started, and any applicable error codes from the runtime.

Overrides

XRSubsystem<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>.TryStartAsync(CancellationToken, XRSubsystemStartOptions)

Implements

ISubsystem