API reference
API reference
Select your platform
No SDKs available
No versions available

ToolkitFeature Class

Implements SpatialFeature
Modifiers: final
ToolkitFeature is a SpatialFeature that provides core toolkit functionality for Spatial SDK applications. This feature is registered by default in AppSystemActivity, so you do not need to manually register it in your registerFeatures() method
The ToolkitFeature registers essential systems and components that provide common functionality for spatial applications, including:
  • Mesh creation through the Mesh component
  • Panel creation through the Panel component
  • Audio playback
  • Input handling
  • Animation
  • Transformation and scaling via the Transform and Scale components
  • Visibility control with the Visible component
  • Grabbable objects
  • Followable objects
  • GLXF asset loading and management
  • Other Default Spatial SDK Functionality

Constructors

ToolkitFeature ( glXFManager , spatial , systemManager , ctx )
Signature
constructor(glXFManager: GLXFManager, spatial: SpatialInterface, systemManager: SystemManager, ctx: Context)
Parameters
glXFManager: GLXFManager
  The GLXF manager for handling GLXF assets
  The spatial interface for interacting with the spatial runtime
systemManager: SystemManager
  The system manager for registering systems
ctx: Context
  The Android context (generally your Spatial SDK Immersive Activity)

Properties

glXFManager : GLXFManager
[Get]
The GLXF manager for handling GLXF assets
Signature
val glXFManager: GLXFManager

Functions

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
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 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 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 fun onPauseActivity()
onResume ()
Called when the application is resumed. Override this method to perform actions during the OnResume() lifecycle of the application.
Signature
open 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()
onStart ()
Called when the application is started. Override this method to perform actions during the OnStart() lifecycle of the application.
Signature
open 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 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.
Did you find this page helpful?