ar_flutter_plugin

The plugin includes several example implementations in the Example app to demonstrate different capabilities:

• Debug Options: Visualizes world origin, feature points, and tracked planes.
• Local & Online Objects: Places GLTF/GLB objects from assets, web URLs, or the app's Documents directory. Includes controls for scale, position, and orientation.
• Objects & Anchors on Planes: Creates an anchor with a 3D model attached when tapping on a detected plane.
• Object Transformation Gestures: Extends the plane anchor example by allowing users to pan and rotate objects using gestures.
• Screenshots: Demonstrates using the snapshot function to capture the AR scene.
• Cloud Anchors: Enables shared AR experiences using Google Cloud Anchor Service and Firebase. Allows uploading/downloading anchors and objects within a 100m radius.
• External Object Management: Uses Firestore to manage a database of models (requiring fields name, image, and uri pointing to a GLB file) for dynamic model selection in AR.

To use shared AR features with long-lived anchors (up to 365 days), you must use OAuth 2.0 authentication instead of a simple API key.

1. Google Cloud Console Setup

1. Activate the Cloud Anchor API.
2. Create an OAuth 2.0 Client ID:
   • Go to Credentials in the Google Cloud Console.
   • Select New Credentials > OAuth client ID.
   • Set Application type to Android.
   • Ensure the Package name matches your AndroidManifest.xml.
   • Provide your SHA-1 certificate fingerprint. For development, use:

     keytool -keystore ~/.android/debug.keystore -list -v

3. Configure the OAuth Consent Screen if required:
   • Add a product name and support email.
   • Add the ARCore Cloud Anchor API scope.

2. Android Project Configuration

Add the Google Play Services Auth dependency to your build.gradle:

implementation 'com.google.android.gms:play-services-auth:16+'

If using ProGuard, add these rules to your proguard-rules.pro to prevent stripping necessary classes:

-keep class com.google.android.gms.common.** { *; }
-keep class com.google.android.gms.auth.** { *; }
-keep class com.google.android.gms.tasks.** { *; }

The plugin's sample apps use Firebase to manage and distribute shared anchor IDs. While you can implement your own distribution method, following these steps allows you to use the provided examples.

1. Android Setup

1. Register your Android app in the Firebase Console using the package name from AndroidManifest.xml and your SHA-1 fingerprint.
2. Download google-services.json and place it in the android/app directory.
3. Add the Google services classpath to your top-level build.gradle:

   classpath 'com.google.gms:google-services:4.3.3'

4. Apply the plugin in your app-level build.gradle:

   apply plugin: 'com.google.gms.google-services'

2. iOS Setup

1. Register your iOS app in the Firebase Console using the Bundle ID from Xcode's General tab.
2. Download GoogleService-Info.plist and move it to the ios/Runner directory.
3. In Xcode, right-click the Runner directory, select Add Files to "Runner", and select the .plist file, ensuring the Runner target is checked.

3. Firestore

• Enable Cloud Firestore in your Firebase project console.

// Top-level build.gradle
classpath 'com.google.gms:google-services:4.3.3'

// App-level build.gradle
apply plugin: 'com.google.gms.google-services'

If you encounter issues on iOS (such as the camera view not appearing despite having camera access), you must explicitly define permission groups in your ios/Podfile.

Add the following configuration within the post_install block of your Podfile to enable the necessary preprocessor definitions for camera, photos, location, sensors, and bluetooth permissions.

  post_install do |installer|
    installer.pods_project.targets.each do |target|
      flutter_additional_ios_build_settings(target)
      target.build_configurations.each do |config|
        # Additional configuration options could already be set here

        # BEGINNING OF WHAT YOU SHOULD ADD
        config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
          '$(inherited)',

          ## dart: PermissionGroup.camera
          'PERMISSION_CAMERA=1',

          ## dart: PermissionGroup.photos
          'PERMISSION_PHOTOS=1',

          ## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse]
          'PERMISSION_LOCATION=1',

          ## dart: PermissionGroup.sensors
          'PERMISSION_SENSORS=1',

          ## dart: PermissionGroup.bluetooth
          'PERMISSION_BLUETOOTH=1',

          # add additional permission groups if required
        ]
        # END OF WHAT YOU SHOULD ADD
      end
    end
  end

The ARView constructor accepts several parameters to customize the user experience and AR capabilities: