הפעלת AR באפליקציית Android NDK

מפעילים את המציאות הרבודה כדי להשתמש בתכונות של מציאות רבודה באפליקציה החדשה או הקיימת.

הגדרת האפליקציה כחובה עם AR או כאופציונלית עם AR

כדי לחסוך מקום במכשירים מסוימים, כל תכונות ה-AR מאוחסנות באפליקציה שנקראת Google Play Services למציאות רבודה, שמתעדכנת בנפרד על ידי חנות Play. אפליקציות Android שמשתמשות בתכונות AR מתקשרות עם שירותי Google Play למציאות רבודה באמצעות ARCore SDK. אפשר להגדיר אפליקציה שתומכת בתכונות AR בשתי דרכים: חובה להשתמש ב-AR ואופציונלי להשתמש ב-AR. הסיווג הזה קובע את אופן האינטראקציה של האפליקציה עם אפליקציית 'Google Play Services למציאות רבודה'.

אפליקציה עם התווית נדרשת AR לא יכולה לפעול בלי ARCore. כדי להשתמש בה, צריך מכשיר נתמך של ARCore שבו מותקנים שירותי Google Play למציאות רבודה.

אפליקציות עם דרישת AR יהיו זמינות בחנות Google Play רק במכשירים שתומכים ב-ARCore.
כשמשתמשים מתקינים אפליקציה עם דרישת AR, שירותי Google Play למציאות רבודה מותקנים באופן אוטומטי במכשיר שלהם דרך חנות Google Play. עם זאת, האפליקציה עדיין צריכה לבצע בדיקות נוספות בסביבת זמן הריצה למקרה ש-Google Play Services for AR לא מעודכן או שהושבת באופן ידני.

אפליקציה עם אפשרות לשימוש ב-AR משתמשת ב-ARCore כדי לשפר את הפונקציונליות הקיימת. יש בה תכונות AR אופציונליות שמופעלות רק במכשירים נתמכים של ARCore שמותקן בהם Google Play Services למציאות רבודה.

אפשר להתקין אפליקציות AR אופציונליות ולהריץ אותן במכשירים שלא תומכים ב-ARCore.
כשמשתמשים מתקינים אפליקציה אופציונלית עם AR, לא מתבצעת התקנה אוטומטית של Google Play Services למציאות רבודה במכשיר דרך חנות Google Play.

	חובה להשתמש ב-AR	AR אופציונלי
שימוש בתכונת ה-AR	כדי שהאפליקציה תפעל באופן בסיסי, היא צריכה את ARCore.	ARCore משפר את הפונקציונליות של האפליקציה. האפליקציה יכולה לפעול בלי תמיכה ב-ARCore.
החשיפה בחנות Play	האפליקציה מופיעה בחנות Play רק במכשירים שתומכים ב-ARCore.	האפליקציה עומדת בנוהלי ההוספה הרגילים.
שיטת ההתקנה של שירותי Google Play למציאות רבודה	חנות Play מתקינה את Google Play Services למציאות רבודה לצד האפליקציה.	האפליקציה משתמשת ב- `ArCoreApk.requestInstall()` כדי להוריד ולהתקין את ARCore.
דרישות ל-`minSdkVersion` ב-Android	Android 7.0‏ (רמת API 24)	Android 4.4 (רמת API 19), אבל כדי להפעיל פונקציונליות של AR צריך לפחות Android 7.0 (רמת API 24)
צריך להשתמש ב-`ArCoreApk_checkAvailability()` או ב-`ArCoreApk_checkAvailabilityAsync()` כדי לבדוק את התמיכה ב-ARCore ואת סטטוס ההתקנה
צריך להשתמש ב- `ArCoreApk.requestInstall()` כדי להתקין את Google Play Services למציאות רבודה

כדי להגדיר את האפליקציה כחובה לשימוש ב-AR או כאופציונלית לשימוש ב-AR, מעדכנים את AndroidManifest.xml כך שיכלול את הרשומות הבאות:

חובה להשתמש ב-ARAR אופציונלי

<uses-permission android:name="android.permission.CAMERA" />

<!-- Limits app visibility in the Google Play Store to ARCore supported devices
     (https://developers.google.com/ar/devices). -->
<uses-feature android:name="android.hardware.camera.ar" />

<application …>
    …

    <!-- "AR Required" app, requires "Google Play Services for AR" (ARCore)
         to be installed, as the app does not include any non-AR features. -->
    <meta-data android:name="com.google.ar.core" android:value="required" />
</application>

<uses-permission android:name="android.permission.CAMERA" />

<!-- If your app was previously AR Required, don't forget to remove the
     `<uses-feature android:name="android.hardware.camera.ar" />` entry, as
     this would limit app visibility in the Google Play Store to only
     ARCore supported devices. -->

<application …>
    …

    <!-- "AR Optional" app, contains non-AR features that can be used when
         "Google Play Services for AR" (ARCore) is not available. -->
    <meta-data android:name="com.google.ar.core" android:value="optional" />
</application>

לאחר מכן, משנים את build.gradle של האפליקציה כך שיציין minSdkVersion של לפחות 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

הוספת יחסי תלות ב-build

מוודאים שקובץ build.gradle של הפרויקט כולל את מאגר Maven של Google.
```
allprojects {
    repositories {
        google()
        …
    }
}
```
מוסיפים משימה מותאמת אישית לקובץ build.gradle של המודול כדי לחלץ ספריות מקומיות כלולות מקובץ ה-AAR של ARCore. כך אפשר להפנות אליהם ישירות בפרויקט C או C++.
בספרייה app/build, מגדירים משתנה לספרייה שאליה הספריות המקומיות יישלפו.

יוצרים קובץ תצורה של Gradle שיאחסן את הנתונים ואת משימות החילוץ.

/*
The ARCore AAR library contains native shared libraries that are
extracted before building to a temporary directory.
*/
def arcore_libpath = "${buildDir}/arcore-native"

// Create a configuration to mark which aars to extract .so files from
configurations { natives }

יוצרים משימה להעתקת הספריות המקומיות מקובץ ה-AAR ומוסיפים אותה לקשרי התלות של ה-build.

// Extracts the shared libraries from AARs in the native configuration
// so that NDK builds can access these libraries.
task extractNativeLibraries() {
   // Extract every time.
   outputs.upToDateWhen { false }

   doFirst {
        configurations.natives.files.each { f ->
            copy {
                from zipTree(f)
                into arcore_libpath
                include "jni/**/*"
            }
        }
    }
}

tasks.whenTaskAdded {
    task-> if (task.name.contains("external") && !task.name.contains("Clean")) {
        task.dependsOn(extractNativeLibraries)
    }
}

מגדירים את הדגלים של ה-build המקומי כדי להעביר את המיקומים לכלים החיצוניים ל-build.

// From the sample app.
externalNativeBuild {
    cmake {
        cppFlags "-std=c++11", "-Wall"
        arguments "-DANDROID_STL=c++_static",
                "-DARCORE_LIBPATH=${arcore_libpath}/jni",
                "-DARCORE_INCLUDE=${project.rootDir}/../../libraries/include"
    }
}

מוסיפים את יחסי התלות של הספריות של Java ושל הספריות המקומיות.

dependencies {
     ...
     // Add Java and native dependencies to the ARCore library.
     implementation 'com.google.ar:core:1.33.0'
     natives 'com.google.ar:core:1.33.0'
     ...
}

בודקים את הספריות המקומיות ב-CMakeLists.txt.

# Import the ARCore library.
add_library(arcore SHARED IMPORTED)
set_target_properties(arcore PROPERTIES IMPORTED_LOCATION
              ${ARCORE_LIBPATH}/${ANDROID_ABI}/libarcore_sdk_c.so
              INTERFACE_INCLUDE_DIRECTORIES ${ARCORE_INCLUDE}
)

ביצוע בדיקות בזמן ריצה

במהלך זמן הריצה, יש לבצע את הפעולות הבאות כדי לוודא שתכונות ה-AR באפליקציה פועלות בצורה חלקה.

איך בודקים אם המכשיר תומך ב-ARCore

גם אפליקציות עם מציאות רבודה כחובה וגם אפליקציות עם מציאות רבודה כאופציונלי צריכות להשתמש ב-ArCoreApk_checkAvailability() או ב-ArCoreApk_checkAvailabilityAsync() כדי לקבוע אם המכשיר הנוכחי תומך ב-ARCore. במכשירים שלא תומכים ב-ARCore, האפליקציות צריכות להשבית את הפונקציונליות שקשורה ל-AR ולהסתיר את רכיבי ממשק המשתמש המשויכים.

אפליקציה של Android NDK עשויה להשתמש בכיתה ArCoreApk של Java כדי לבדוק את התאימות ולנהל את ההתקנה ב-ARCore Session API המקורי ב-C. בהתאם למבנה של האפליקציה, יכול להיות שזו תהיה דרך קלה יותר מאשר להשתמש בפונקציות ArCoreApk_, בגלל הכמות הגדולה של טיפול בטעויות ואינטראקציה עם ממשק המשתמש.

void maybeEnableArButton(JNIEnv env, jobject context) {
  // Likely called from Activity.onCreate() of an activity with AR buttons.
  ArAvailability availability
  ArCoreApk_checkAvailability(env, context, &availability);
  if (availability == AR_AVAILABILITY_UNKNOWN_CHECKING) {
    // Set a timer to call maybeEnableArButton() again after about 200ms.
  }
  if (availability == AR_AVAILABILITY_SUPPORTED_NOT_INSTALLED ||
      availability == AR_AVAILABILITY_SUPPORTED_APK_TOO_OLD ||
      availability == AR_AVAILABILITY_SUPPORTED_INSTALLED) {
    // Show or enable the AR button.
  } else {
    // Hide or disable the AR button.
  }
}

למרות ששירותי Google Play למציאות רבודה מותקנים לצד האפליקציה שלכם עם הדרישה ל-AR, משתמשים עם מכשירים לא נתמכים עשויים להתקין אותה ממקור חיצוני. כדי להבטיח חוויה עקבית, מומלץ להשתמש ב-ArCoreApk_checkAvailability() או ב-ArCoreApk_checkAvailabilityAsync() כדי לבדוק אם יש תמיכה ב-ARCore.

יכול להיות ש-ArCoreApk_checkAvailability() יצטרך לשלוח שאילתות למשאבי הרשת כדי לקבוע אם המכשיר תומך ב-ARCore. במהלך פרק הזמן הזה, המערכת תחזיר את הערך AR_AVAILABILITY_UNKNOWN_CHECKING. כדי לצמצם את זמן האחזור המשוער ואת הזמן שחולף מהקליק להצגת התוצאה, אפליקציות צריכות להפעיל את ArCoreApk_checkAvailability() פעם אחת בשלב מוקדם במחזור החיים שלהן כדי להתחיל את השאילתה, בלי להתחשב בערך המוחזר. כך, תוצאה ששמורה במטמון תהיה זמינה באופן מיידי כשרכיב ממשק משתמש שמוצג ב-AR עשוי להופיע.

בודקים אם שירותי Google Play למציאות רבודה מותקנים

גם אפליקציות עם דרישה ל-AR וגם אפליקציות עם אפשרות ל-AR חייבות להשתמש ב- ArCoreApk.requestInstall() לפני יצירת סשן ARCore כדי לבדוק אם (עדיין) מותקנת גרסה תואמת של שירותי Google Play למציאות רבודה, וכדי לוודא שכל נתוני פרופיל המכשיר הנדרשים ל-ARCore הורדתם.

// Tracks if an installation request has already been triggered.
bool install_requested_;

void nativeOnCreate() {
  // Do other setup here.

  install_requested_ = false;
}

void nativeOnResume(JNIEnv env, jobject activity) {
  if (ar_session_ == null) {
    bool user_requested_install = !install_requested_;

    ArInstallStatus install_status;
    // Ensure that Google Play Services for AR and ARCore device profile data are
    // installed and up to date.
    ArStatus error = ArCoreApk_requestInstall(
        env, activity, user_requested_install, &install_status);
    if (error != AR_SUCCESS) {
      // Inform user of error.
      return;
    }

    switch (install_status) {
      case AR_INSTALL_STATUS_INSTALLED:
        break;
      case AR_INSTALL_STATUS_INSTALL_REQUESTED:
        // When this method returns AR_INSTALL_STATUS_INSTALL_REQUESTED:
        // 1. This activity will be paused.
        // 2. The user is prompted to install or update Google Play
        //    Services for AR (market://details?id=com.google.ar.core).
        // 3. ARCore downloads the latest device profile data.
        // 4. This activity is resumed. The next invocation of
        //    ArCoreApk_requestInstall() will either return
        //    AR_INSTALL_STATUS_INSTALLED or throw an exception if the
        //    installation or update did not succeed.
        install_requested_ = true;
        return;
    }

    // Request camera permissions.

    error = ArSession_create(env, context, &ar_session_);
    if (error != AR_SUCCESS) {
      // Inform user of error.
      return;
    }

    // Configure the ARCore session.
  }

  // Normal onResume behavior.
}

עמידה בדרישות בנושא פרטיות המשתמשים

כדי לפרסם את האפליקציה ב-Play Store, חשוב לוודא שהיא עומדת בדרישות של ARCore בנושא פרטיות המשתמשים.

מה השלב הבא?

איך מגדירים סשן ARCore