[email protected]

## [6.0.3] - 2024-08-16 ### Changed
needle-mirror · Aug 16, 2024 · 539beaf · 539beaf
1 parent 9095ecd
commit 539beaf
Show file tree

Hide file tree

Showing 47 changed files with 332 additions and 267 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,12 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [6.0.3] - 2024-08-16
+
+### Changed
+
+- Changed AR Foundation dependency version from 6.0.2 to 6.0.3
+
 ## [6.0.2] - 2024-05-22
 
 ### Changed
@@ -199,7 +205,7 @@ No changes
 
 - Fixed [an issue](https://issuetracker.unity3d.com/issues/ar-camera-feed-jitters-and-shakes-with-mutithreaded-rendering-when-running-on-ios-16) where rendered frames comes out of order on iOS 16 when built with multi-threaded rendering enabled in Unity.
 - Fixed a bug where the `HandheldARInputDevice` did not appear in the Editor's InputActions UI. Now, if you are manually configuring the **Tracked Pose Driver** component on the camera under XR Origin, you can select **AR Handheld Device > devicePosition** and **AR Handheld Device > deviceRotation** for position and rotation input bindings respectively.
-- Fixed a bug where `ARKitReferenceImageLibraryBuildProcessor` could cause compile error when build target is not iOS. 
+- Fixed a bug where `ARKitReferenceImageLibraryBuildProcessor` could cause compile error when build target is not iOS.
 
 ## [5.0.0-pre.13] - 2022-06-28
 

diff --git a/Documentation~/TableOfContents.md b/Documentation~/TableOfContents.md
@@ -9,6 +9,8 @@
   * [Object tracking](xref:arkit-object-tracking)
   * [Face tracking](xref:arkit-face-tracking)
   * [Point clouds](xref:arkit-point-clouds)
+  * [Anchors](xref:arkit-anchors)
   * [Meshing](xref:arkit-meshing)
   * [Occlusion](xref:arkit-occlusion)
+  * [Ray casts](xref:arkit-raycasts)
   * [Participants](xref:arkit-participant-tracking)
diff --git a/Documentation~/arkit-anchors.md b/Documentation~/arkit-anchors.md
@@ -0,0 +1,25 @@
+---
+uid: arkit-anchors
+---
+# Anchors
+
+This page is a supplement to the AR Foundation [Anchors](xref:arfoundation-anchors) manual. The following sections describe the optional features of AR Foundation's [XRAnchorSubsystem](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystem) supported by ARKit.
+
+[!include[](snippets/arf-docs-tip.md)]
+
+## Optional feature support
+
+ARKit implements the following optional features of AR Foundation's [XRAnchorSubsystem](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystem):
+
+| Feature | Descriptor Property | Supported |
+| :------ | :------------------ | :-------: |
+| **Trackable attachments** | [supportsTrackableAttachments](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsTrackableAttachments) | Yes |
+| **Synchronous add** | [supportsSynchronousAdd](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsSynchronousAdd) | Yes |
+| **Save anchor** | [supportsSaveAnchor](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsSaveAnchor) |  |
+| **Load anchor** | [supportsLoadAnchor](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsLoadAnchor) |  |
+| **Erase anchor** | [supportsEraseAnchor](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsEraseAnchor) |  |
+| **Get saved anchor IDs** | [supportsGetSavedAnchorIds](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsGetSavedAnchorIds) |  |
+| **Async cancellation** | [supportsAsyncCancellation](xref:UnityEngine.XR.ARSubsystems.XRAnchorSubsystemDescriptor.supportsAsyncCancellation) |  |
+
+> [!NOTE]
+> Refer to AR Foundation [Anchors platform support](xref:arfoundation-anchors-platform-support) for more information on the optional features of the anchor subsystem.
diff --git a/Documentation~/arkit-camera.md b/Documentation~/arkit-camera.md
@@ -31,7 +31,7 @@ ARKit implements the following optional features of AR Foundation's [XRCameraSub
 | **Exif data** | [supportsExifData](xref:UnityEngine.XR.ARSubsystems.XRCameraSubsystemDescriptor.supportsExifData) | iOS 16+ |
 
 > [!NOTE]
-> Refer to AR Foundation [Camera platform support](xref:arfoundation-camera-platform-support) for more information 
+> Refer to AR Foundation [Camera platform support](xref:arfoundation-camera-platform-support) for more information
 > on the optional features of the camera subsystem.
 
 ## Light estimation

diff --git a/Documentation~/arkit-face-tracking.md b/Documentation~/arkit-face-tracking.md
@@ -10,7 +10,7 @@ This page is a supplement to the AR Foundation [Face tracking](xref:arfoundation
 
 ## Optional feature support
 
-ARKit implements the following optional features of AR Foundation's [XRFaceSubsystem](xref:UnityEngine.XR.ARSubsystems.XRFaceSubsystem). The availability of features on specific devices depends on device hardware and software. Refer to [Requirements](#requirements) for more information. 
+ARKit implements the following optional features of AR Foundation's [XRFaceSubsystem](xref:UnityEngine.XR.ARSubsystems.XRFaceSubsystem). The availability of features on specific devices depends on device hardware and software. Refer to [Requirements](#requirements) for more information.
 
 | Feature | Descriptor Property | Supported |
 | :------ | :------------------ | :-------: |
@@ -21,7 +21,7 @@ ARKit implements the following optional features of AR Foundation's [XRFaceSubsy
 | **Eye tracking** |  [supportsEyeTracking](xref:UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor.supportsEyeTracking) | Yes |
 
 > [!NOTE]
-> Refer to AR Foundation [Face tracking platform support](xref:arfoundation-face-tracking-platform-support) for more information 
+> Refer to AR Foundation [Face tracking platform support](xref:arfoundation-face-tracking-platform-support) for more information
 > on the optional features of the face subsystem.
 
 ## Session configuration
@@ -40,7 +40,7 @@ ARKit provides a series of [blend shapes](https://developer.apple.com/documentat
 
 A blend shape represents action at a location on a face. Each blend shape is defined by an [ARKitBlendShapeLocation](xref:UnityEngine.XR.ARKit.ARKitBlendShapeLocation) to identify the location of the face action and a [ARKitBlendShapeCoefficient](xref:UnityEngine.XR.ARKit.ARKitBlendShapeCoefficient) to describe the amount of action at the location. The `ARKitBlendShapeCoefficient` is a value between `0.0` and `1.0`.
 
-You can learn more about blend shapes with the `Blend shapes` sample on the [AR Foundation Samples](https://github.com/Unity-Technologies/arfoundation-samples/tree/main?tab=readme-ov-file#blend-shapes-arkit) GitHub. This sample uses blend shapes to puppet a cartoon face which is displayed over the detected face. 
+You can learn more about blend shapes with the `Blend shapes` sample on the [AR Foundation Samples](https://github.com/Unity-Technologies/arfoundation-samples/tree/main?tab=readme-ov-file#blend-shapes-arkit) GitHub. This sample uses blend shapes to puppet a cartoon face which is displayed over the detected face.
 
 ## Face visualizer samples
 

diff --git a/Documentation~/arkit-occlusion.md b/Documentation~/arkit-occlusion.md
@@ -24,7 +24,7 @@ ARKit implements the following optional features of AR Foundation's [XROcclusion
 | **Human Segmentation Depth Image** | [humanSegmentationDepthImageSupported](xref:UnityEngine.XR.ARSubsystems.XROcclusionSubsystemDescriptor.humanSegmentationDepthImageSupported) | Yes |
 
 > [!NOTE]
-> Refer to AR Foundation [Occlusion platform support](xref:arfoundation-occlusion-platform-support) for more information 
+> Refer to AR Foundation [Occlusion platform support](xref:arfoundation-occlusion-platform-support) for more information
 > on the optional features of the occlusion subsystem.
 
 ## Environment Depth

diff --git a/Documentation~/arkit-plane-detection.md b/Documentation~/arkit-plane-detection.md
@@ -15,10 +15,10 @@ For more information, refer to [Plane detection](xref:arfoundation-plane-detecti
 
 ## Plane classifications
 
-This package maps ARKit's [ARPlaneAnchor.Classification](https://developer.apple.com/documentation/arkit/arplaneanchor/classification) to AR Foundation's [PlaneClassifications](xref:UnityEngine.XR.ARFoundation.PlaneClassifications). 
+This package maps ARKit's [ARPlaneAnchor.Classification](https://developer.apple.com/documentation/arkit/arplaneanchor/classification) to AR Foundation's [PlaneClassifications](xref:UnityEngine.XR.ARFoundation.PlaneClassifications).
 
-> [!NOTE] 
-> While AR Foundation allows XR providers to assign multiple classifications per plane, ARKit only assigns a single classification to any given plane. 
+> [!NOTE]
+> While AR Foundation allows XR providers to assign multiple classifications per plane, ARKit only assigns a single classification to any given plane.
 
 Refer to the table below to understand the mapping between AR Foundation's classifications and ARKit's classifications:
 

diff --git a/Documentation~/arkit-raycasts.md b/Documentation~/arkit-raycasts.md
@@ -0,0 +1,40 @@
+---
+uid: arkit-raycasts
+---
+# Ray casts
+
+This page is a supplement to the AR Foundation [Ray casts](xref:arfoundation-raycasts) manual. The following sections only contain information about APIs where ARKit exhibits unique platform-specific behavior.
+
+[!include[](snippets/arf-docs-tip.md)]
+
+## Optional feature support
+
+ARKit implements the following optional features of AR Foundation's [XRRaycastSubsystem](xref:UnityEngine.XR.ARSubsystems.XRRaycastSubsystem):
+
+| Feature                    | Descriptor Property | Supported |
+| :------------------------- | :------------------ | :-------: |
+| **Viewport based raycast** | [supportsViewportBasedRaycast](xref:UnityEngine.XR.ARSubsystems.XRRaycastSubsystemDescriptor.supportsViewportBasedRaycast)| Yes |
+| **World based raycast**    |  [supportsWorldBasedRaycast](xref:UnityEngine.XR.ARSubsystems.XRRaycastSubsystemDescriptor.supportsWorldBasedRaycast)   |     |
+| **Tracked raycasts**       | [supportsTrackedRaycasts](xref:UnityEngine.XR.ARSubsystems.XRRaycastSubsystemDescriptor.supportsTrackedRaycasts)     | iOS 13+ |
+
+### Supported trackables
+
+ARKit supports ray casting against the following trackable types:
+
+| TrackableType           | Supported |
+| :---------------------- | :-------: |
+| **BoundingBox**         |           |
+| **Depth**               |           |
+| **Face**                |           |
+| **FeaturePoint**        |    Yes    |
+| **Image**               |           |
+| **Planes**              |    Yes    |
+| **PlaneEstimated**      |    Yes    |
+| **PlaneWithinBounds**   |    Yes    |
+| **PlaneWithinInfinity** |    Yes    |
+| **PlaneWithinPolygon**  |    Yes    |
+
+> [!NOTE]
+> Refer to AR Foundation [Ray cast platform support](xref:arfoundation-raycasts-platform-support) for more information on the optional features of the Raycast subsystem.
+
+[!include[](snippets/apple-arkit-trademark.md)]
diff --git a/Documentation~/filter.yml b/Documentation~/filter.yml
@@ -1,6 +1,6 @@
 apiRules:
   - exclude:
-      uidRegex: Tests$
+      uidRegex: \.Tests$
       type: Namespace
   - exclude:
       uidRegex: ^UnityEngine\.XR\.ARKit\.ARKitLoaderSettings$

diff --git a/Documentation~/index.md b/Documentation~/index.md
@@ -16,8 +16,8 @@ Use the Apple ARKit XR Plug-in package to enable ARKit support in your [AR Found
 | [Face tracking](xref:arkit-face-tracking) | Detect and track human faces. |
 | [Body tracking](xref:arfoundation-body-tracking) | Detect and track a human body. |
 | [Point clouds](xref:arkit-point-clouds) | Detect and track feature points. |
-| [Raycasts](xref:arfoundation-raycasts) | Cast rays against tracked items. |
-| [Anchors](xref:arfoundation-anchors) | Track arbitrary points in space. |
+| [Ray casts](xref:arkit-raycasts) | Cast rays against tracked items. |
+| [Anchors](xref:arkit-anchors) | Track arbitrary points in space. |
 | [Meshing](xref:arkit-meshing) | Generate meshes of the environment. |
 | [Environment probes](xref:arfoundation-environment-probes) | Generate cubemaps of the environment. |
 | [Occlusion](xref:arkit-occlusion) | Occlude AR content with physical objects and perform human segmentation. |
@@ -32,7 +32,7 @@ This package does not implement the following AR Foundation features as they are
 | [Bounding Box detection](xref:arfoundation-bounding-box-detection) | Detect and track bounding boxes of 3D objects |
 
 > [!IMPORTANT]
-> Apple's App Store rejects any app that contains certain face tracking-related symbols in its binary if the app developer doesn't intend to use face tracking. To avoid ambiguity, face tracking support is available only when face tracking is enabled. Refer to [Enable the Face tracking subsystem](xref:arkit-project-config#enable-face-tracking) for instructions for changing this setting. 
+> Apple's App Store rejects any app that contains certain face tracking-related symbols in its binary if the app developer doesn't intend to use face tracking. To avoid ambiguity, face tracking support is available only when face tracking is enabled. Refer to [Enable the Face tracking subsystem](xref:arkit-project-config#enable-face-tracking) for instructions for changing this setting.
 
 # Install the Apple ARKit XR Plug-in
 
@@ -42,7 +42,7 @@ You can also install and uninstall this package using the [Package Manager](http
 
 # Project configuration
 
-See [Project configuration](xref:arkit-project-config) for information about the project settings that affect ARKit apps. 
+See [Project configuration](xref:arkit-project-config) for information about the project settings that affect ARKit apps.
 
 # Usage
 

diff --git a/Documentation~/project-configuration-arkit.md b/Documentation~/project-configuration-arkit.md
@@ -3,7 +3,7 @@ uid: arkit-project-config
 ---
 # Project configuration
 
-Use the **XR Plug-in Management** settings to configure the Apple ARKit plug-in for your project. 
+Use the **XR Plug-in Management** settings to configure the Apple ARKit plug-in for your project.
 
 To get started, follow the instructions in [Enable the ARKit plug-in](#enable-arkit). This also installs the ARKit package, if needed. Once installed and enabled, you can configure your project settings as described in the [ARKit Project settings](#project-settings) section.
 
@@ -60,9 +60,9 @@ Refer to Apple's [Verifying Device Support and User Permission](https://develope
 <a name="camera-usage"></a>
 ### Set the Camera Usage Description
 
-The camera usage description is a message that tells the user why your app is requesting access to 
-the device’s camera. The string assigned to this field is added to your app's `Info.plist` file for 
-the `NSCameraUsageDescription` key. 
+The camera usage description is a message that tells the user why your app is requesting access to
+the device’s camera. The string assigned to this field is added to your app's `Info.plist` file for
+the `NSCameraUsageDescription` key.
 
 To set or change this setting:
 
@@ -110,7 +110,7 @@ To change this setting:
 4. For **Requirement**, choose either **Optional** or **Required**.
 
 > [!NOTE]
-> The Apple ARKit plug-in **Requirement** overrides the similar iOS Player setting, **Requires ARKit support**. When you have the ARKit plug-in installed, Unity ignores the Player **Requires ARKit support** setting and uses the plug-in **Requirement** value.  
+> The Apple ARKit plug-in **Requirement** overrides the similar iOS Player setting, **Requires ARKit support**. When you have the ARKit plug-in installed, Unity ignores the Player **Requires ARKit support** setting and uses the plug-in **Requirement** value.
 
 
 <a name="project-validation"></a>
@@ -127,7 +127,7 @@ To review the ARKit project validation rules:
 3. Select **Project Validation** in the list to view the validation page.
 4. Select the **iOS** tab to view the status of the validation checks for iOS XR plug-ins, including ARKit.
 
-Rules that pass validation aren't shown unless you enable **Show all**. 
+Rules that pass validation aren't shown unless you enable **Show all**.
 
 Some rules provide a **Fix** button that updates the configuration so that the rule passes validation. Other rules provide an **Edit** button that takes you to the relevant setting so that you can make the necessary adjustments yourself.
 

diff --git a/Editor/ARKitBuildProcessor.cs b/Editor/ARKitBuildProcessor.cs
@@ -47,7 +47,7 @@ class Preprocessor : IPreprocessBuildWithReport, IPreprocessShaders
             };
 
             public int callbackOrder => 0;
-        
+
             void IPreprocessShaders.OnProcessShader(Shader shader, ShaderSnippetData snippet, IList<ShaderCompilerData> data)
             {
 #if UNITY_IOS && UNITY_XR_ARKIT_LOADER_ENABLED
@@ -158,7 +158,7 @@ static void EnsureMinimumBuildTarget()
                 if (userSetTargetVersion < new OSVersion(11))
                 {
                     throw new BuildFailedException(
-                        $"You have selected a minimum target iOS version of {userSetTargetVersion} and have " + 
+                        $"You have selected a minimum target iOS version of {userSetTargetVersion} and have " +
                         " the Apple ARKit XR Plug-in package installed. ARKit requires at least iOS version 11.0. " +
                         "See Player Settings > Other Settings > Target minimum iOS Version.");
                 }
@@ -213,9 +213,9 @@ static bool ShouldIncludeRuntimePluginsInBuild(string path)
             }
         }
 
-// Our PostProcessor depends on UnityEditor.iOS.PlistDocument, a class in Unity's iOS module.
-// To ensure that this package successfully compiles in projects that don't have the iOS module installed, we must
-// wrap the PostProcessor with a UNITY_IOS preprocessor directive.
+        // Our PostProcessor depends on UnityEditor.iOS.PlistDocument, a class in Unity's iOS module.
+        // To ensure that this package successfully compiles in projects that don't have the iOS module installed, we must
+        // wrap the PostProcessor with a UNITY_IOS preprocessor directive.
 #if UNITY_IOS
         class PostProcessor : IPostprocessBuildWithReport
         {

diff --git a/Editor/AssemblyInfo.cs.meta b/Editor/AssemblyInfo.cs.meta
diff --git a/Editor/Cli.cs b/Editor/Cli.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Diagnostics;
 
 namespace UnityEditor.XR.ARKit

diff --git a/Editor/NoniOSBuildProcessor.cs.meta b/Editor/NoniOSBuildProcessor.cs.meta
diff --git a/Editor/Plist.cs.meta b/Editor/Plist.cs.meta
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-Apple ARKit XR Plug-in © 2024 Unity Technologies
+com.unity.xr.arkit copyright © 2024 Unity Technologies
 
 Licensed under the Unity Companion License for Unity-dependent projects (see [Unity Companion License](https://unity3d.com/legal/licenses/unity_companion_license)).
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Apple ARKit XR Plug-in Package
 
-The purpose of this package is to provide ARKit XR Support. 
+The purpose of this package is to provide ARKit XR Support.
 
 ## Package structure
 
@@ -19,13 +19,13 @@ The purpose of this package is to provide ARKit XR Support.
   └── Runtime
       ├── FaceTracking
       │   ├── ARKitFaceSubsystem.cs
-      │   ├── Unity.XR.ARKit.FaceTracking.asmdef 
+      │   ├── Unity.XR.ARKit.FaceTracking.asmdef
       ├── iOS
       │   ├── link.xml
-      │   ├── Resources 
-      │   │   └── ARKitShader.shader 
-      │   ├── UnityARKit.a 
-	  │   └── UnityARKit.m 
+      │   ├── Resources
+      │   │   └── ARKitShader.shader
+      │   ├── UnityARKit.a
+      │   └── UnityARKit.m
       ├── UnitySubsystemsManifest.json
       └── Unity.XR.ARKit.asmdef
 ```