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 @see PanelSceneObject.

Signature

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

Constructors

PanelCreator ( registrationId , panelCreator ) : 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

PanelCreator

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