About MARS AR Foundation Providers
Use MARS AR Foundation Providers to support MARS applications on smartphones and AR HMDs. This package contains a set of wrapper classes for AR Foundation to manage the AR Session and update the MARS database with device data.
This package integrates with AR Foundation to provide MARS support for the following platforms:
- ARKit (iOS)
- ARCore (Android)
- Magic Leap (Lumin OS)
- Hololens (WSA)
The following features are available on each platform:
ARKit
- Camera tracking
- Plane finding
- Point cloud
- Raycasting
- Image markers
- Face tracking
- Light estimation
ARCore
- Camera tracking
- Plane finding
- Point cloud
- Raycasting
- Image markers
- Face tracking
- Light estimation
Magic Leap
- Camera tracking
- Plane finding
- Raycasting
Hololens
- Camera tracking
Package contents
The following table describes the package folder structure under Packages/MARS AR Foundation Providers/:
| Location | Description |
|---|---|
| Default Island.asset | A functionality island that contains all of the AR Foundation providers as defaults. Use this to ensure that these providers are used if multiple packages provide overlapping functionality. |
| Editor | Contains Unity.ARFoundationProviders.Editor assembly definition and related Editor code. |
| Runtime | Contains Unity.ARFoundationProviders assembly definition and related runtime code. |
Installation
To install this package, follow the instructions in the Package Manager documentation.
AR Foundation compatibility
This package references AR Foundation 2.1.8 as a dependency, but you can select any later version in the Package Manager depending on what your Project needs. Any minor version of AR Foundation 2.x, 3.x or 4.x should work. This package has been tested specifically with the following versions and their matching XR plug-ins:
- 2.1.8
- 3.0.1
- 3.1.3
- 4.0.0-preview.3
Platform plug-ins
To function on devices in Player builds, AR Foundation requires a platform plug-in (for example, com.unity.xr.arcore for AR Core on Android). For ARKit support on iOS, use com.unity.xr.arkit. Face tracking on ARKit requires an additional package: com.unity.xr.arkit-face-tracking. For the most part, there is an XR plug-in version that matches the AR Foundation version, but there are some exceptions. Unity recommends the following versions:
com.unity.xr.arfoundation@2.1.8com.unity.xr.arcore@2.1.8com.unity.xr.arkit@2.1.9com.unity.xr.arkit-face-tracking@1.0.7com.unity.xr.windowsmr@2.1.5com.unity.xr.magicleap@4.1.3
Note that Magic Leap and Windows Mixed Reality plugins only exist for AR Foundation 2.x. You will not be able to make HoloLens or Magic Leap builds if you are using AR Foundation 3.0+
Remember to check your project settings for permissions and required player settings based on what your Project needs. For example, plane detection on Magic Leap requires the WorldReconstruction permission.
Note: The version of the AR Foundation package you're using has to match with the version of ARKit, ARCore, Magic Leap or Hololens unless noted otherwise. If the versions don't match, this leads to compiler errors. For example, if you are using AR Foundation 4.0.0 preview 3 and ARKit, you must ensure that ARKit is set to version 4.0.0 preview 3 as well.
Requirements
This version of MARS AR Foundation Providers is compatible with the following versions of the Unity Editor:
- 2019.3 and later (recommended)
Known limitations
MARS AR Foundation Providers version 0.1.19-preview includes the following known limitations:
- Hololens support is limited to camera tracking.
- Camera facing direction is not implemented for AR Foundation 4.x.
- Hololens builds fail to deploy in Unity 2019.3.0f6. Use the latest 2019.3.x patch version.
- The
Force Multipassoption is required Magic Leap to work around an issue where content is only drawn in one eye. Enable this from the Project Settings window (menu: Project Settings > XR Plugin Management > Magic Leap Settings), which is available when the Magic Leap XR plug-in is installed.