Class ARKitSessionSubsystem
ARKit implementation of the XRSessionSubsystem
. Do not create this directly. Use the SubsystemManager
instead.
Inherited Members
Namespace: UnityEngine.XR.ARKit
Assembly: solution.dll
Syntax
[Preserve]
public sealed class ARKitSessionSubsystem : XRSessionSubsystem
Properties
Name | Description |
---|---|
coachingActivatesAutomatically | Whether the Coaching Overlay activates automatically or not. By default, it does not. |
coachingActive |
|
coachingGoal | Defines the Coaching Goal. This property is obsolete. Use requestedCoachingGoal or currentCoachingGoal instead. |
coachingOverlaySupported |
|
collaborationDataCount | The number of ARCollaborationDatas in the queue. Obtain ARCollaborationData with DequeueCollaborationData(). |
collaborationEnabled | Queries whether collaboration is currently enabled. |
collaborationRequested | Get whether collaboration is enabled. When collaboration is enabled, collaboration data is accumulated by the subsystem until you read it out with DequeueCollaborationData(). |
currentCoachingGoal | The current Coaching Goal. This can be different than the requestedCoachingGoal. |
currentWorldAlignment | The current ARWorldAlignment for the session. |
requestedCoachingGoal | Requests the Coaching Goal. This should be based on your app's tracking requirements and affects the UI that the coaching overlay presents. |
requestedWorldAlignment | The requested ARWorldAlignment for the session. |
sessionDelegate | The ARKitSessionDelegate to use for session-related callbacks. |
supportsCollaboration | True if collaboration is supported. Collaboration is only supported on iOS versions 13.0 and later. |
worldMapSupported | Detect ARWorldMap support. |
worldMappingStatus | Get the world mapping status. Used to determine the suitability of the current session for creating an ARWorldMap. |
Methods
Name | Description |
---|---|
ApplyWorldMap(ARWorldMap) | Applies an ARWorldMap to the session. |
DequeueCollaborationData() | Dequeues the oldest collaboration data in the queue. After calling this method, collaborationDataCount will be decremented by one. |
GetARWorldMapAsync() | Asynchronously create an ARWorldMap. An It is a wrapper for ARKit's ARWorldMap. |
GetARWorldMapAsync(Action<ARWorldMapRequestStatus, ARWorldMap>) |
Asynchronously create an ARWorldMap. An It is a wrapper for ARKit's ARWorldMap. If the ARWorldMapRequestStatus is Success, then the resulting ARWorldMap must be disposed to avoid leaking native resources. Otherwise, the ARWorldMap is not valid, and need not be disposed. |
OnCreate() | Invoked when the subsystem is created. |
SetCoachingActive(bool, ARCoachingOverlayTransition) | Activates or deactivates the Coaching Overlay. |
UpdateWithCollaborationData(ARCollaborationData) | Applies ARCollaborationData to the session. |