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

PanelCreationSystem Class

Extends SystemBase
Modifiers: final
PanelCreationSystem is responsible for creating PanelSceneObjects for Entities with the Panel component. The PanelCreationSystem takes the registrations from AppSystemActivity.registerPanels(), uses the PanelConfigOptions to create PanelSceneObjects, and then links them with the Entity.
This System comes default with Meta Spatial SDK and operates on entities with Panel components.

Constructors

PanelCreationSystem ( panelCreator )
Signature
constructor(panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>, (ent: Entity) -> PanelSceneObject>)
Parameters
panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>  A map of panel registration IDs to functions that create panels.

Properties

executeCount : Long
[Get]
The number of times this system's SystemBase.execute method has been called by the system manager. Incremented automatically before each execution cycle. Useful for performance monitoring.
Signature
var executeCount: Long
panelCreator : HashMap<Int, (ent: Entity) -> PanelSceneObject>
[Get]
A map of panel registration IDs to functions that create panels.
Signature
val panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>
systemManager : SystemManager
[Get][Set]
The SystemManager that this system is registered with. Provides access to other systems and the scene. Initialized during system registration.
Signature
lateinit var systemManager: SystemManager

Methods

associateSystemManager ( systemManager )
Associates this system with a SystemManager. Called during registration. Throws RuntimeException if the system is already associated — each system instance can only belong to one manager.
Signature
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager  The system manager that will own and execute this system.
delete ( ent )
Called when an entity is removed from the scene. Override to clean up any per-entity state this system maintains, such as cached components, tracking maps, or native resource handles.
Signature
open override fun delete(ent: Entity)
Parameters
ent: Entity
destroy ()
Called during system shutdown to release all resources held by this system. Override to dispose of native handles, close streams, and clear any global state accumulated during the session.
Signature
open override fun destroy()
equals ( other )
Checks if this system is equal to another object. Two systems are considered equal if they are the same instance or share the same Kotlin class, regardless of configuration state.
Signature
open operator override fun equals(other: Any?): Boolean
Parameters
other: Any?  The object to compare with.
Returns
Boolean  True if the other object is the same system instance or the same system class.
execute ()
Called each frame by the SystemManager to perform this system's per-tick logic. Override to query entities with relevant components and apply updates.
Signature
open override fun execute()
forEachPanel ( action )
Iterate over all panels.
Signature
fun forEachPanel(action: (Entity, CompletableFuture<PanelSceneObject>) -> Unit)
Parameters
action: Function2
getDependencies ()
Returns the execution ordering dependencies for this system. Override to declare which other systems must run before or after this one using SystemDependencies.
Signature
open fun getDependencies(): SystemDependencies?
Returns
SystemDependencies?  The dependency configuration, or null if this system has no ordering constraints.
getScene ()
Returns the Scene that this system operates within. Delegates to the associated SystemManager to retrieve the active scene instance.
Signature
fun getScene(): Scene
Returns
Scene  The scene containing the entities and rendering state for this system.
hashCode ()
Returns the hash code of this system, based on its Kotlin class identity. Consistent with the SystemBase.equals implementation — systems of the same class produce the same hash code.
Signature
open override fun hashCode(): Int
Returns
Int  The hash code derived from this system's Kotlin class.