Anchor
class Anchor
An anchor describes a fixed location and orientation in the real world. To stay at a fixed location in physical space, the numerical description of this position may update as ARCore for XR updates its understanding of the physical world.
Summary
Nested types |
|---|
class Anchor.StateThe representation of the current state of an |
Public companion functions |
|
|---|---|
AnchorCreateResult |
|
List<UUID> |
getPersistedAnchorUuids(session: Session)Retrieves all the |
AnchorCreateResult |
|
Anchor |
loadFromNativePointer(session: Session, nativePointer: Long)Loads an |
Unit |
Deletes a persisted Anchor denoted by |
Public functions |
|
|---|---|
Unit |
detach()Detaches this anchor. |
open operator Boolean |
|
open Int |
hashCode() |
suspend UUID |
persist()Stores this anchor in the application's local storage so that it can be shared across sessions. |
open suspend Unit |
update()Updates the state of the |
Public properties |
|
|---|---|
Anchor |
|
StateFlow<Anchor.State> |
The current |
Public companion functions
create
fun create(session: Session, pose: Pose): AnchorCreateResult
Creates and attaches an Anchor at the given pose.
| Parameters | |
|---|---|
session: Session |
the |
pose: Pose |
the |
| Returns | |
|---|---|
AnchorCreateResult |
the result of the operation. Can be |
getPersistedAnchorUuids
fun getPersistedAnchorUuids(session: Session): List<UUID>
Retrieves all the UUID instances from Anchor objects that have been persisted by persist that are still present in the local storage.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if |
load
fun load(session: Session, uuid: UUID): AnchorCreateResult
Loads an Anchor from local storage, using the given uuid. The anchor will attempt to be attached in the same physical location as the anchor that was previously persisted. The uuid should be the return value of a previous call to persist.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if |
loadFromNativePointer
fun loadFromNativePointer(session: Session, nativePointer: Long): Anchor
Loads an Anchor of the given native pointer.
unpersist
fun unpersist(session: Session, uuid: UUID): Unit
Deletes a persisted Anchor denoted by uuid from local storage.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if |
Public constructors
Public functions
detach
fun detach(): Unit
Detaches this anchor. This anchor will no longer be updated or tracked.
persist
suspend fun persist(): UUID
Stores this anchor in the application's local storage so that it can be shared across sessions.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if |