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

PanelRegistration Class

Modifiers: open
PanelRegistration is a class that allows you to register a panel with the Spatial Toolkit. To use panels in your app, you will need to:
  1. Register the panel definition
  2. Spawn the panel in the 3D scene
Details on how to use this class can be found in the Spatial Toolkit documentation.

See Also

Signature

open class PanelRegistration(val registrationId: Int, val init: PanelRegistration.(entity: Entity) -> Unit = {})

Constructors

PanelRegistration ( registrationId , init )
Signature 
constructor(registrationId: Int, init: PanelRegistration.(entity: Entity) -> Unit = {})
Parameters
registrationId: Int
The unique identifier for this panel
init: Function2
The initialization block that will be called when the panel is created
Returns

Properties

activityClass : Class?
[Get][Set]
Activity class if the panel is powered by an activity and its layout/logic.
Signature 
var activityClass: Class<*>?
init : Function2
[Get]
Signature 
val init: PanelRegistration.(entity: Entity) -> Unit
layoutResourceId : Int?
[Get][Set]
Layout resource id if the panel is view-based and created in the same immersive activity.
Signature 
var layoutResourceId: Int?
panelConfigOptions2 : Function2?
[Get][Set]
Signature 
var panelConfigOptions2: PanelConfigOptions2.(entity: Entity) -> PanelConfigOptions2?
panelIntent : Intent?
[Get][Set]
Intent to launch the panel's activity if the panel is activity-based.
Signature 
var panelIntent: Intent?
registrationId : Int
[Get]
Signature 
val registrationId: Int

Functions

composePanel ( composeViewFun )
Signature 
fun PanelRegistration.composePanel(composeViewFun: <Error class: unknown class>.() -> Unit): PanelRegistration
Parameters
composeViewFun: Function1
Returns
config ( overriding , block )
Signature 
fun config(overriding: Boolean = true, block: PanelConfigOptions.() -> Unit): PanelRegistration
Parameters
overriding: Boolean
block: Function1
Returns
fromConfigOptions2 ( panelConfigOptions2 )
Signature 
infix fun fromConfigOptions2(panelConfigOptions2: PanelConfigOptions2.(entity: Entity) -> PanelConfigOptions2): PanelRegistration
Parameters
panelConfigOptions2: Function2
Returns
panel ( overriding , block )
Signature 
fun panel(overriding: Boolean = true, block: PanelSceneObject.() -> Unit): PanelRegistration
Parameters
overriding: Boolean
block: Function1
Returns
panelComponent ()
Returns the Panel component that will be used to create the panel entity.
Signature 
fun panelComponent(): Panel
Returns
panelCreator ( scene , spatialContext )
Returns a function that takes an entity as input and returns a PanelSceneObject. This function will be used to create the panel scene object in PanelCreationSystem. Whenever you create Entity with Panel(registrationId) component, this function will be called to create the panel scene object.
Signature 
open fun panelCreator(scene: Scene, spatialContext: SpatialContext): (entity: Entity) -> PanelSceneObject
Parameters
scene: Scene
The scene in which the panel will be created.
spatialContext: SpatialContext
The spatial context of the panel.
Returns
Function1
A function that takes an entity as input and returns a PanelSceneObject.
view ( block )
Signature 
fun view(block: (<Error class: unknown class>) -> <Error class: unknown class>): PanelRegistration
Parameters
block: Function1
Returns
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta