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

PanelCreator Class

Extends PanelRegistration
 Modifiers: final
PanelCreator is a class that allows you to specify the panel creator function for a panel. The panel creator function is any customized function that takes an entity as input and returns the PanelSceneObject.

See Also

Signature

class PanelCreator(val registrationId: Int, panelCreator: (entity: Entity) -> PanelSceneObject) : PanelRegistration

Constructors

PanelCreator ( registrationId , panelCreator )
Signature 
constructor(registrationId: Int, panelCreator: (entity: Entity) -> PanelSceneObject)
Parameters
registrationId: Int
  The unique identifier for the panel.
panelCreator: Function1
  A function that takes an entity as input and returns a PanelSceneObject.
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]
The initialization block that will be called when the panel is created
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?
panelIntent : Intent?
[Get][Set]
Intent to launch the panel's activity if the panel is activity-based.
Signature 
var panelIntent: Intent
registrationId : Int
[Get]
The unique identifier for this panel
Signature 
val registrationId: Int

Functions

config ( overriding , block )
Signature 
fun config(overriding: Boolean = true, block: PanelConfigOptions.() -> Unit): PanelRegistration
Parameters
overriding: Boolean
block: Function1
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 )
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