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

StereoCanvasPanelRegistration Class

Modifiers: final
Panel registration for custom stereo canvas rendering.
This API keeps panel-style setup while exposing draw helpers for flat and stereo-offset content.

Signature

class StereoCanvasPanelRegistration(val registrationId: Int, settingsCreator: (entity: Entity) -> StereoCanvasPanelSettings, renderer: StereoCanvasPanelRenderer, panelSetup: (controller: StereoCanvasPanelController, panel: PanelSceneObject, entity: Entity) -> Unit = { _, _, _ ->
        }) : PanelRegistration

Constructors

StereoCanvasPanelRegistration ( registrationId , settingsCreator , renderer , panelSetup )
Signature
constructor(registrationId: Int, settingsCreator: (entity: Entity) -> StereoCanvasPanelSettings, renderer: StereoCanvasPanelRenderer, panelSetup: (controller: StereoCanvasPanelController, panel: PanelSceneObject, entity: Entity) -> Unit = { _, _, _ ->
        })
Parameters
registrationId: Int
settingsCreator: Function1
panelSetup: Function3

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

Methods

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