Class SpatialAnchorFeature
Enables AR Foundation anchor support via OpenXR Spatial Entities extensions.
Inheritance
Implements
Inherited Members
Namespace: UnityEngine.XR.OpenXR.Features.SpatialEntities
Assembly: Unity.XR.SpatialEntities.dll
Syntax
public class SpatialAnchorFeature : SpatialSetupConfigurationProvider, IConfigurationAnalyticFields
featureId
The feature id string. This is used to give the feature a well known id for reference.
Declaration
public const string featureId = "com.unity.openxr.feature.arfoundation-spatialentities-anchor"Field Value
| Type | Description |
|---|---|
| string |
Properties
automaticallyLoadSavedAnchors
Get or set whether the anchor provider should automatically load all saved anchors when it starts. You can only set this value before you initialize the OpenXR loader.
Declaration
public bool automaticallyLoadSavedAnchors { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown if you set this value after you've initialized the OpenXR loader. |
Methods
GetValidationChecks(List<ValidationRule>, BuildTargetGroup)
Get validation rules for this feature.
Declaration
protected override void GetValidationChecks(List<OpenXRFeature.ValidationRule> rules, BuildTargetGroup targetGroup)Parameters
| Type | Name | Description |
|---|---|---|
| List<OpenXRFeature.ValidationRule> | rules | |
| BuildTargetGroup | targetGroup |
Overrides
OnInstanceCreate(ulong)
Called after xrCreateInstance. Override this method to validate that any necessary OpenXR extensions were
successfully enabled
(OpenXRRuntime.IsExtensionEnabled)
and that any required system properties are supported. If this method returns false,
the feature's enabled property is set to false.
Declaration
protected override bool OnInstanceCreate(ulong xrInstance)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | xrInstance | Handle of the native |
Returns
| Type | Description |
|---|---|
| bool | true if this feature successfully initialized. Otherwise, false. |
Overrides
Remarks
If this feature is a required feature of an enabled feature set, returning false here
causes the OpenXRLoader to fail, and XR Plug-in Management will fall back to another loader if enabled.
See Also
OnSessionCreate(ulong)
Called after xrCreateSession.
Declaration
protected override void OnSessionCreate(ulong xrSession)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | xrSession | The OpenXR session handle. |
Overrides
OnSessionDestroy(ulong)
Called before xrDestroySession.
Declaration
protected override void OnSessionDestroy(ulong xrSession)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | xrSession | The OpenXR session handle. |
Overrides
OnSubsystemCreate()
Called after the OpenXR Loader is initialized and has created its subsystems.
Declaration
protected override void OnSubsystemCreate()Overrides
OnSubsystemDestroy()
Called before the OpenXR Loader destroys its subsystems.
Declaration
protected override void OnSubsystemDestroy()