Ekstensi OpenXR XR_ANDROID_trackables_object

String Nama

XR_ANDROID_trackables_object

Jenis Ekstensi

Ekstensi instance

Registered Extension Number

467

Revisi

1

Dependensi Ekstensi dan Versi

XR_ANDROID_trackables

Tanggal Terakhir Diubah

2024-11-01

Status IP

Tidak ada klaim IP yang diketahui.

Kontributor

Diego Tipaldi, Google

David Joseph Tan, Google

Christopher Doer, Google

Spencer Quin, Google

Jared Finder, Google

Levana Chen, Google

Kenny Vercaemer, Google

Ringkasan

Ekstensi ini memungkinkan pelacakan objek fisik. Misalnya, keyboard, mouse, dan objek lainnya di lingkungan.

Melacak objek

Ekstensi ini menambahkan XR_TRACKABLE_TYPE_OBJECT_ANDROID ke XrTrackableTypeANDROID.

Aplikasi dapat membuat XrTrackableTrackerANDROID dengan memanggil xrCreateTrackableTrackerANDROID dan menentukan XR_TRACKABLE_TYPE_OBJECT_ANDROID sebagai jenis yang dapat dilacak di XrTrackableTrackerCreateInfoANDROID::trackableType untuk melacak objek.

Struktur XrTrackableObjectConfigurationANDROID didefinisikan sebagai: 

typedef struct XrTrackableObjectConfigurationANDROID {
    XrStructureType                type;
    void*                          next;
    uint32_t                       labelCount;
    const XrObjectLabelANDROID*    activeLabels;
} XrTrackableObjectConfigurationANDROID;

Deskripsi Anggota

  • type adalah XrStructureType dari struktur ini.
  • next adalah NULL atau pointer ke struktur berikutnya dalam rantai struktur. Tidak ada struktur semacam itu yang ditentukan di OpenXR inti atau ekstensi ini.
  • labelCount adalah jumlah activeLabels.
  • activeLabels adalah pointer ke array XRObjectLabelANDROID yang menunjukkan objek aktif dalam pelacakan.

Aplikasi dapat menetapkan konfigurasi tambahan dengan menambahkan XrTrackableObjectConfigurationANDROID ke rantai berikutnya XrTrackableTrackerCreateInfoANDROID. Output dari xrGetAllTrackablesANDROID akan difilter agar cocok dengan activeLabels.

Jika aplikasi tidak menetapkan XrTrackableObjectConfigurationANDROID, semua objek yang telah diidentifikasi sistem akan dilacak.

Penggunaan yang valid (implisit)

Enum XrObjectLabelANDROID adalah label untuk objek XrTrackableANDROID. 

typedef enum XrObjectLabelANDROID {
    XR_OBJECT_LABEL_UNKNOWN_ANDROID = 0,
    XR_OBJECT_LABEL_KEYBOARD_ANDROID = 1,
    XR_OBJECT_LABEL_MOUSE_ANDROID = 2,
    XR_OBJECT_LABEL_LAPTOP_ANDROID = 3,
    XR_OBJECT_LABEL_MAX_ENUM_ANDROID = 0x7FFFFFFF
} XrObjectLabelANDROID;

Mendapatkan objek yang dapat dilacak

Fungsi xrGetTrackableObjectANDROID ditentukan sebagai:

XrResult xrGetTrackableObjectANDROID(
    XrTrackableTrackerANDROID                   tracker,
    const XrTrackableGetInfoANDROID*            getInfo,
    XrTrackableObjectANDROID*                   objectOutput);

Deskripsi Parameter

XR_ERROR_MISMATCHING_TRACKABLE_TYPE_ANDROID akan ditampilkan jika jenis XrTrackableANDROID yang dapat dilacak bukan XR_TRACKABLE_TYPE_OBJECT_ANDROID, atau jika jenis XrTrackableTrackerANDROID yang dapat dilacak bukan XR_TRACKABLE_TYPE_OBJECT_ANDROID.

Penggunaan yang valid (implisit)

Kode Status

Berhasil

  • XR_SUCCESS
  • XR_SESSION_LOSS_PENDING

Kegagalan

  • XR_ERROR_FUNCTION_UNSUPPORTED
  • XR_ERROR_VALIDATION_FAILURE
  • XR_ERROR_RUNTIME_FAILURE
  • XR_ERROR_HANDLE_INVALID
  • XR_ERROR_INSTANCE_LOST
  • XR_ERROR_SESSION_LOST
  • XR_ERROR_SESSION_NOT_RUNNING
  • XR_ERROR_TIME_INVALID
  • XR_ERROR_MISMATCHING_TRACKABLE_TYPE_ANDROID

Struktur XrTrackableObjectANDROID ditentukan sebagai: 

typedef struct XrTrackableObjectANDROID {
    XrStructureType           type;
    void*                     next;
    XrTrackingStateANDROID    trackingState;
    XrPosef                   centerPose;
    XrExtent3DfEXT            extents;
    XrObjectLabelANDROID      objectLabel;
    XrTime                    lastUpdatedTime;
} XrTrackableObjectANDROID;

Deskripsi Anggota

Penggunaan yang valid (implisit)

Contoh kode untuk mendapatkan objek yang dapat dilacak

Contoh kode berikut menunjukkan cara mendapatkan objek yang dapat dilacak.

XrSession session; // previously initialized

// The function pointers are previously initialized using xrGetInstanceProcAddr.
PFN_xrCreateTrackableTrackerANDROID xrCreateTrackableTrackerANDROID; // previously initialized
PFN_xrGetAllTrackablesANDROID xrGetAllTrackablesANDROID; // previously initialized
PFN_xrGetTrackableObjectANDROID xrGetTrackableObjectANDROID; // previously initialized
PFN_xrDestroyTrackableTrackerANDROID xrDestroyTrackableTrackerANDROID; // previously initialized

XrTime updateTime; // Time used for the current frame's simulation update.
XrSpace appSpace; // Space created for XR_REFERENCE_SPACE_TYPE_LOCAL.

XrTrackableTrackerCreateInfoANDROID
  createInfo{XR_TYPE_TRACKABLE_TRACKER_CREATE_INFO_ANDROID};
createInfo.trackableType = XR_TRACKABLE_TYPE_OBJECT_ANDROID;
XrTrackableTrackerANDROID objectTrackableTracker;
XrResult result = xrCreateTrackableTrackerANDROID(
  session,
  &createInfo,
  &objectTrackableTracker);
if (result != XR_SUCCESS) { /* Handle failures. */ }

uint32_t trackableCountOutput = 0;
std::vector<XrTrackableANDROID> allObjectTrackables;

// Query the number of trackables available.
result = xrGetAllTrackablesANDROID(
  objectTrackableTracker,
  0,
  &trackableCountOutput,
  nullptr
);

if (result == XR_SUCCESS) {
  allObjectTrackables.resize(trackableCountOutput, XR_NULL_TRACKABLE_ANDROID);

  // Fetch the actual trackable handles in the appropriately resized array.
  result = xrGetAllTrackablesANDROID(
    objectTrackableTracker,
    trackableCountOutput,
    &trackableCountOutput,
    allObjectTrackables.data());

  if (result == XR_SUCCESS) {
    for (XrTrackableANDROID trackable : allObjectTrackables) {

      // Object trackable query information
      XrTrackableGetInfoANDROID objectGetInfo;
      objectGetInfo.type = XR_TYPE_TRACKABLE_GET_INFO_ANDROID;
      objectGetInfo.next = nullptr;
      objectGetInfo.trackable = trackable;
      objectGetInfo.baseSpace = appSpace;
      objectGetInfo.time = updateTime;

      // Get the object trackable. Note that the tracker only returns object types.
      XrTrackableObjectANDROID object = { XR_TYPE_TRACKABLE_OBJECT_ANDROID };
      result = xrGetTrackableObjectANDROID(
        objectTrackableTracker,
        &objectGetInfo,
        &object
      );

      if (result == XR_SUCCESS) {
        /** Do Stuff with the object */
      }
    }
  }
}

// Release trackable tracker.
result = xrDestroyTrackableTrackerANDROID(objectTrackableTracker);

Konstanta Enum Baru

Enumerasi XrStructureType diperluas dengan:

  • XR_TYPE_TRACKABLE_OBJECT_ANDROID
  • XR_TYPE_TRACKABLE_OBJECT_CONFIGURATION_ANDROID

Enumerasi XrTrackableTypeANDROID diperluas dengan:

  • XR_TRACKABLE_TYPE_OBJECT_ANDROID

Enum Baru

Struktur Baru

Fungsi Baru

Masalah

Histori Versi

  • Revisi 1, 03-10-2024 (Kenny Vercaemer)
    • Deskripsi ekstensi awal.

OpenXR™ dan logo OpenXR adalah merek dagang yang dimiliki oleh The Khronos Group Inc. dan terdaftar sebagai merek dagang di China, Uni Eropa, Jepang, dan Inggris Raya.