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

ActivityPanelRegistration Class

Modifiers: final
Panel registration for Activity-based panels that launch specific Activity classes.
This class is used when you want to create panels that display content from specific Android Activity classes. Unlike IntentPanelSettings which uses Intents, this directly references Activity classes, making it more suitable for internal activities within your application where you have direct class references. Activity-based panels are very powerful and can be used to build very complex UIs but are less performant than view-based panels.
Use this when:
  • You're launching activities within your own app and have direct class access
  • You don't need to pass information to the launched activity

Signature

class ActivityPanelRegistration(val registrationId: Int, classIdCreator: (entity: Entity) -> Class<*>?, settingsCreator: (entity: Entity) -> PanelSettings, panelSetup: (PanelSceneObject, Entity) -> Unit = { _, _ -> }) : PanelRegistration

Constructors

ActivityPanelRegistration ( registrationId , classIdCreator , settingsCreator , panelSetup )
Signature
constructor(registrationId: Int, classIdCreator: (entity: Entity) -> Class<*>?, settingsCreator: (entity: Entity) -> PanelSettings, panelSetup: (PanelSceneObject, Entity) -> Unit = { _, _ -> })
Parameters
registrationId: Int
Unique identifier for this panel registration
classIdCreator: Function1
Function that returns the Activity class for each panel instance, allowing dynamic Activity selection based on the entity. Can return null if no activity should be launched for a particular entity.
settingsCreator: Function1
Function that creates PanelSettings for each panel instance, allowing dynamic panel configuration (size, position, etc.)
panelSetup: Function2
Optional setup function called after panel creation for additional configuration of the PanelSceneObject

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?