Integrates Jetpack Compose lifecycle management with the Spatial SDK runtime. Register this feature with your SpatialContext to enable Compose-based UI panels. It manages a PanelViewLifecycleOwner that bridges Android activity lifecycle events (onCreate, onStart, onResume, onPause, onStop, onDestroy) to the Compose composition, ensuring proper initialization and teardown of Compose content displayed on spatial panels.

Signature

class ComposeFeature : SpatialFeature

Constructors

ComposeFeature ()

Signature

constructor()

Returns

ComposeFeature

Properties

panelViewLifecycleOwner : PanelViewLifecycleOwner

[Get]

The lifecycle owner that bridges Android activity lifecycle events to Compose compositions running on spatial panels. Manages state for ViewModels and SavedStateRegistry within panel content.

Signature

val panelViewLifecycleOwner: PanelViewLifecycleOwner

Methods

componentsToRegister ()	Override this function to define a list of components that should be used by the application. Signature open fun componentsToRegister(): List<ComponentRegistration> Returns `List` A list of ComponentRegistration objects representing the components to register.
earlySystemsToRegister ()	Override this method to register your systems that should be executed with PriorityGroup EARLY. Signature open fun earlySystemsToRegister(): List<SystemBase> Returns `List` A list of SystemBase objects
getDependencies ()	Override this method to define a list of dependencies required by this feature. This will be verified at runtime. Example: // MyCustomFeature.kt override fun getDependencies(): List<KClass<out SpatialFeature>> { return listOf(ToolkitFeature::class) } @return A list of SpatialFeature classes representing the dependencies. Signature open fun getDependencies(): List<KClass<out SpatialFeature>> Returns `List`
lateSystemsToRegister ()	Override this method to register your systems that should be executed with PriorityGroup LATE. Signature open fun lateSystemsToRegister(): List<SystemBase> Returns `List` A list of SystemBase objects
loadLibrary ( libName )	Loads a native library into the application. Signature open fun loadLibrary(libName: String) Parameters `libName: String` The name of the library to load.
onCreate ( savedInstanceState )	Called when the application is created. Override this method to perform actions during the OnCreate() lifecycle of the application. Signature open override fun onCreate(savedInstanceState: Bundle?) Parameters `savedInstanceState: Bundle?` The saved instance state of the application.
onDestroy ()	Called when the application is in onDestroy callback. Be aware that onDestroy() is not guaranteed to be called. Override this method to perform actions during the OnDestroy() lifecycle of the application. Signature open override fun onDestroy()
onPauseActivity ()	Called when the activity is in onPause callback. Override this method to perform actions during the OnPause() lifecycle of the application. Signature open override fun onPauseActivity()
onResume ()	Called when the application is resumed. Override this method to perform actions during the OnResume() lifecycle of the application. Signature open override fun onResume()
onSceneReady ()	Called when the scene is ready. Override this method to perform actions during the OnSceneReady() lifecycle of the application. Signature open fun onSceneReady()
onSpatialShutdown ()	Called when the application is shutting down. Clean up all Spatial resources for your feature, e.g. entites.destroy(), in this callback. Signature open fun onSpatialShutdown()
onStart ()	Called when the application is started. Override this method to perform actions during the OnStart() lifecycle of the application. Signature open override fun onStart()
onStopActivity ()	Called when the activity is in onStop callback. Be aware that onStop() is not guaranteed to be called. Override this method to perform actions during the OnStop() lifecycle of the application. Signature open override fun onStopActivity()
onVRPause ()	Called when the VR mode is paused. Override this method to perform actions during the OnVRPause() lifecycle of the application. Signature open fun onVRPause()
onVRReady ()	Called when the VR mode is ready. Override this method to perform actions during the onVRReady() lifecycle of the application. Signature open fun onVRReady()
preRuntimeOnCreate ( savedInstanceState )	Called before the application's onCreate() method is called. Override this method to perform actions before the rest of the OnCreate() lifecycle of the application. Signature open fun preRuntimeOnCreate(savedInstanceState: Bundle?) Parameters `savedInstanceState: Bundle?` The saved instance state of the application.
registerRequiredOpenXRExtensions ()	Override this function to define a list of required OpenXR extensions that should be enabled by your application. Signature open fun registerRequiredOpenXRExtensions(): List<String> Returns `List` A list of strings representing the required OpenXR extensions.
systemsToRegister ()	Override this method to register your systems that should be executed PriorityGroup NORMAL. Signature open fun systemsToRegister(): List<SystemBase> Returns `List` A list of SystemBase objects