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

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

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

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

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

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

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

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

	נדרש AR	AR אופציונלי
שימוש בתכונות AR	לאפליקציה שלך נדרש ARCore לפונקציונליות בסיסית.	בעזרת ARCore אפשר לשפר את הפונקציונליות של האפליקציה. האפליקציה יכולה לפעול בלי תמיכה ב-ARCore.
הרשאות הגישה לחנות Play	האפליקציה שלך מופיעה בחנות Play רק במכשירים שתומכים ב-ARCore.	האפליקציה פועלת לפי ההליכים הרגילים של כרטיסי מוצר.
שיטת ההתקנה של Google Play Services למציאות רבודה	חנות Play מתקינה את Google Play Services למציאות רבודה לצד האפליקציה שלכם.	האפליקציה שלך משתמשת `ArCoreApk.requestInstall()` כדי להוריד ולהתקין את ARCore.
דרישות עבור Android `minSdkVersion`	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 אופציונלי, צריך לעדכן את AndroidManifest.xml כך שיכלול את הרשומות הבאות:

נדרש AR

<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>

AR אופציונלי

<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, מגדירים משתנה של הספרייה שאליה יחולצו ספריות ה-Native.

ליצור הגדרה של 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 וגם של ספריות ה-Native.

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

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

אפליקציה ל-Android NDK יכולה להשתמש במחלקה ArCoreApk של Java כדי לבדוק את התאימות ולנהל את ההתקנה בממשק ה-API המקורי של C ARCore Session. בהתאם למבנה האפליקציה, יכול להיות שיהיה קל יותר להשתמש בפונקציות 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 Services למציאות רבודה מותקנת לצד האפליקציה 'נדרשת AR', אבל משתמשים עם מכשירים שלא נתמכים עשויים להתקין אותה ממקור חיצוני. כדי לבדוק אם יש תמיכה ב-ARCore באמצעות ArCoreApk_checkAvailability() או ArCoreApk_checkAvailabilityAsync(), חוויית השימוש תהיה עקבית.

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

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

חובה להשתמש גם באפליקציות AR נדרשות וגם באפליקציות AR אופציונליות ArCoreApk.requestInstall() לפני שיוצרים סשן ARCore כדי לבדוק אם מותקנת גרסה תואמת של Google Play Services למציאות רבודה (עדיין) ולוודא שכל נתוני הפרופיל הנדרשים של מכשיר 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, צריך לוודא שהיא תואמת ל-ARCore דרישות בנושא פרטיות המשתמשים.

מה השלב הבא?

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