PlaneTrackingManager
Provides plane tracking functionalities, including managing and updating plane anchors.
This singleton object is responsible for handling plane anchor updates and providing asynchronous operations to load all plane anchors and subscribe to anchor update events. It facilitates the management of plane anchors in a 3D space by allowing developers to:
Subscribe to Updates: Developers can subscribe to anchor update events to receive real-time notifications whenever a plane anchor is added, updated, or removed. This is achieved through a listener mechanism that notifies registered subscribers of any anchor updates.
Load All Anchors: Developers can load all currently tracked plane anchors asynchronously. This operation returns a suspendable function that provides an array of
PlaneAnchorobjects.Start and Stop: The tracking manager can be started or stopped as needed. The manager needs to be in a running state to load anchors or receive updates.
Additionally, developers can check the current state of the tracking manager to determine whether it is running or stopped.
Example Usage
Below is an example demonstrating how to use PlaneTrackingManager:
runBlocking {
// Subscribe to anchor update events
val subscription = TrackingManager.subscribeAnchorUpdate { event ->
when (event.anchorUpdateEvent) {
AnchorUpdate.Event.ADDED -> println("Plane anchor added: ${event.anchor.anchorUUID}")
AnchorUpdate.Event.UPDATED -> println("Plane anchor updated: ${event.anchor.anchorUUID}")
AnchorUpdate.Event.REMOVED -> println("Plane anchor removed: ${event.anchor.anchorUUID}")
}
}
// Start the tracking manager
PlaneTrackingManager.start()
// Check the state of the tracking manager
when (PlaneTrackingManager.state) {
TrackingState.RUNNING -> {
// Only available when the tracking manager is running
// Load all currently tracked Plane anchors
val anchors = PlaneTrackingManager.loadAllAnchor()
println("Loaded Plane anchors: ${anchors.map { it.anchorUUID }}")
}
TrackingState.NONE -> println("Manager not initialized yet.")
TrackingState.INITIALIZED -> println("Manager initialized but not running.")
TrackingState.PAUSED -> println("Manager is paused due to an exception " +
"or stage transition. Resume tracking to continue.")
TrackingState.STOPPED -> println("Manager has been stopped. Restart required.")
TrackingState.INVALID -> println("Manager is in an invalid state. Functionality unavailable.")
}
// Stop the tracking manager
PlaneTrackingManager.stop()
// Unsubscribe from anchor updates
subscription.cancel()
}