AugmentedImageDatabase

Kotlin |Java

class AugmentedImageDatabase

Defines an augmented image database that is going to be used by the image tracker to detect images by setting it through the androidx.xr.runtime.Config.augmentedImageDatabase parameter

Summary

Public constructors
`AugmentedImageDatabase()`

Public functions
`Int`	`addAugmentedImageDatabaseEntry( mode: AugmentedImageDatabaseEntryMode, bitmap: Bitmap, widthInMeters: Float )` Creates a new augmented image database entry from a bitmap and adds it to the augmented image database
`AugmentedImageDatabase`	`copy()` Creates a copy of this `AugmentedImageDatabase`
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`

Public properties
`List<AugmentedImageDatabaseEntry>`	`entries` The list of `AugmentedImageDatabaseEntry` objects currently in the database

AugmentedImageDatabase()

fun addAugmentedImageDatabaseEntry(
    mode: AugmentedImageDatabaseEntryMode,
    bitmap: Bitmap,
    widthInMeters: Float = 0.0f
): Int

Creates a new augmented image database entry from a bitmap and adds it to the augmented image database

Parameters
`mode: AugmentedImageDatabaseEntryMode`	The mode used to detect the image
`bitmap: Bitmap`	The bitmap of the image in `android.graphics.Bitmap.Config.ARGB_8888` format
`widthInMeters: Float = 0.0f`	The physical width of the image in meters. If zero, the physical width will be estimated if the device supports it. If physical size estimation is not supported, configuring the `Session` adding an entry with widthInMeters being 0f or lower will throw an `IllegalArgumentException`

Returns
`Int`	The zero-based positional index of the image within the database

Throws
`IllegalArgumentException`	if the bitmap format is different from `ARGB_8888`

fun copy(): AugmentedImageDatabase

Creates a copy of this AugmentedImageDatabase

Returns
`AugmentedImageDatabase`	A new `AugmentedImageDatabase` instance with the same entries

open operator fun equals(other: Any?): Boolean

open fun hashCode(): Int

val entries: List<AugmentedImageDatabaseEntry>

The list of AugmentedImageDatabaseEntry objects currently in the database