tracking/com.pico.spatial.tracking/DataProvider

DataProvider

@RequiredFullSpace

interface DataProvider<T>

Generic data provider for various types of tracking data.

Usage:

Call start to begin providing data and stop when data is no longer needed. Make sure to call stop to avoid potential memory leaks.
Check if the current data type is available via supportState.
Get the latest data via latestData, register a DataListener via addListener to receive data, or get data from dataFlow.

Parameters

T

The type of tracking data.

Inheritors

BodyTrackingProvider

ControllerTrackingProvider

EyeTrackingProvider

HandTrackingProvider

HMDTrackingProvider

MotionTrackingProvider

Types

fun interface DataListener<T>

The listener for receiving data from a DataProvider.

enum StartResult : Enum<DataProvider.StartResult>

The result of start, represent the state when start is called.

enum State : Enum<DataProvider.State>

Represents the state of the current DataProvider.

enum SupportState : Enum<DataProvider.SupportState>

Indicates whether the current type of data is supported now.

Properties

abstract val dataFlow: SharedFlow<T>

The SharedFlow of tracking data. This flow is a hot flow with no replay.

abstract val latestData: T

The latest tracking data.

abstract val state: DataProvider.State

The state of the current DataProvider.

abstract val supportState: DataProvider.SupportState

The support state of the data type.

Functions

abstract fun addListener(listener: DataProvider.DataListener<T>)

Adds a DataListener to receive data.

abstract fun removeListener(listener: DataProvider.DataListener<T>)

Removes a DataListener to stop receiving data.

abstract fun start(): DataProvider.StartResult

Starts providing tracking data.

abstract fun stop()

Stops providing tracking data.