Quickstart for Cloud Anchors in Unity for iOS

Use Cloud Anchors to build AR experiences that Android and iOS users can share.

Prerequisites

  • This guide assumes that you have already downloaded the ARCore SDK for Unity and imported it into a Unity project targeting iOS.

    If not, see the Quickstart for iOS for installation and configuration instructions.

  • If you are new to working with anchors, see Working with Anchors for an introduction.

Requirements

See Requirements in the Quickstart for iOS.

Use Cloud Anchors

Set up your development environment for working with Cloud Anchors and try out the sample app.

About Cloud Anchors ID sharing

The CloudAnchors sample app uses Unity's Networking feature for sharing Cloud Anchor IDs between devices on the same network.

You can use a different solution in your own apps.

Add an API Key

To use the ARCore Cloud Anchor API in your app, you'll need an API Key.

  1. Obtain an API Key. See Setting up API keys in the Google Cloud Platform Console Help Center if you are new to working with API keys.

  2. Enable the ARCore Cloud Anchor API for your Google Cloud Platform project.

  3. Add your API key to your project:

    • In Unity, go to Edit > Project Settings > ARCore
    • Add your API key to the Cloud Services API Key field.

Open the sample scene

The CloudAnchors sample is included with the ARCore SDK for Unity.

  1. In the Unity Project window, you can find the CloudAnchors.unity sample in:
    Assets > GoogleARCore > Examples > CloudAnchors > Scenes

Configure build and platform settings

  1. Add the sample scene to your build:

    • Go to File > Build Settings and click Add open scene.
    • Select CloudAnchors. Disable any other scenes in the build.
  2. Follow the Configure build and platform settings steps in the Quickstart for iOS.

Try out the sample app

Launch the app

  1. Go to your Xcode output folder and open the Unity-iPhone.xcworkspace file in Xcode.
    To avoid build errors, do not build or launch from the included Unity-iPhone.xcodeproj project file.

  2. In Xcode, select the Unity-iPhone project in the left pane, connect your phone, and launch the app.

Host and resolve Cloud Anchors

  1. The sample app launches on your phone and starts detecting planes in front of your camera.

  2. Tap a plane to anchor an Andy Android object on it.

  3. Tap the HOST button to host the anchor.

    A host request is sent to the Google Cloud Anchor service. The host request includes data representing the anchor's position relative to the visual features near it. A successful host request establishes a Cloud Anchor here and assigns it a Cloud Anchor ID.

    The app displays a room code after the hosting request succeeds. You can use the code to access previously hosted Cloud Anchors for this room, using the same device or another device.

  4. Tap RESOLVE and enter a previously returned room code to access hosted Cloud Anchors for this room.

    A resolve request is sent to the Google Cloud Anchor service and, if successful, returns Cloud Anchors currently hosted in the room. The sample app uses the transforms of returned Cloud Anchors to render the Andy Android objects attached to them.

Next steps

Send feedback about...