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

ViewPanelRegistration Class

Modifiers: final
Panel registration for dynamically created View-based panels.
This class is used when you want to create panels with Views that are generated programmatically at runtime rather than from static layout resources. View-based panels are more performant than Activity-based panels.
Use this when:
  • You want to dynamically construct a View-based UIs based on data or other runtime conditions
  • You want to quickly prototype a UI idea

Signature

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

Constructors

ViewPanelRegistration ( registrationId , dynamicViewCreator , settingsCreator , panelSetupWithRootView )
Signature
constructor(registrationId: Int, dynamicViewCreator: (entity: Entity, <Error class: unknown class>) -> <Error class: unknown class>, settingsCreator: (entity: Entity) -> PanelSettings, panelSetupWithRootView: (<Error class: unknown class>, PanelSceneObject, Entity) -> Unit = { _, _, _ -> })
Parameters
registrationId: Int
Unique identifier for this panel registration
dynamicViewCreator: Function2
Function that creates a View for each panel instance, receiving both the entity and Android context for maximum flexibility in View creation
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 created root View, PanelSceneObject, and Entity for additional configuration

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
fromConfigOptions2 ( panelConfigOptions2 )
Signature
infix fun fromConfigOptions2(panelConfigOptions2: PanelConfigOptions2.(entity: Entity) -> PanelConfigOptions2): PanelRegistration
Parameters
panelConfigOptions2: Function2
panel ( overriding , block )
Signature
fun panel(overriding: Boolean = true, block: PanelSceneObject.() -> Unit): PanelRegistration
Parameters
overriding: Boolean
block: Function1
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 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
Did you find this page helpful?