This class is used when you want to create panels from predefined XML layout files stored in your app's resources. View-based panels are more performant than Activity-based panels.

Use this when:

You prefer XML layouts over more modern UI frameworks like Jetpack Compose

Signature

class LayoutXMLPanelRegistration(val registrationId: Int, layoutIdCreator: (entity: Entity) -> Int, settingsCreator: (entity: Entity) -> PanelSettings, panelSetupWithRootView: (<Error class: unknown class>, PanelSceneObject, Entity) -> Unit = { _, _, _ -> }) : PanelRegistration

Constructors

LayoutXMLPanelRegistration ( registrationId , layoutIdCreator , settingsCreator , panelSetupWithRootView )

Signature

constructor(registrationId: Int, layoutIdCreator: (entity: Entity) -> Int, settingsCreator: (entity: Entity) -> PanelSettings, panelSetupWithRootView: (<Error class: unknown class>, PanelSceneObject, Entity) -> Unit = { _, _, _ -> })

Parameters

                                                    registrationId:

        Int

Unique identifier for this panel registration

                                                    layoutIdCreator:

        Function1

Function that returns the layout resource ID for each panel instance, allowing dynamic layout selection based on the entity

                                                    settingsCreator:

        Function1

Function that creates PanelSettings for each panel instance, allowing dynamic panel configuration (size, position, etc.)

                                                    panelSetupWithRootView:

        Function3

Optional setup function called after panel creation with access to the inflated root View, PanelSceneObject, and Entity for additional configuration like setting up click listeners, binding data, etc.

Returns

LayoutXMLPanelRegistration

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

config ( overriding , block )	Signature fun config(overriding: Boolean = true, block: PanelConfigOptions.() -> Unit): PanelRegistration Parameters overriding: Boolean block: Function1 Returns PanelRegistration
fromConfigOptions2 ( panelConfigOptions2 )	Signature infix fun fromConfigOptions2(panelConfigOptions2: PanelConfigOptions2.(entity: Entity) -> PanelConfigOptions2): PanelRegistration Parameters panelConfigOptions2: Function2 Returns PanelRegistration
panel ( overriding , block )	Signature fun panel(overriding: Boolean = true, block: PanelSceneObject.() -> Unit): PanelRegistration Parameters overriding: Boolean block: Function1 Returns PanelRegistration
panelComponent ()	Returns the Panel component that will be used to create the panel entity. Signature fun panelComponent(): Panel Returns Panel
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 override 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 PanelRegistration