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

PanelCreationSystem

PanelCreationSystem

class PanelCreationSystem(val panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>) : SystemBase
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

NameSummary
PanelCreationSystem
constructor(panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>)

Types

NameSummary
Companion
object Companion

Properties

NameSummary
panelCreator
val panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>
systemManager
lateinit var systemManager: SystemManager

The system manager that this system is associated with.

Functions

NameSummary
associateSystemManager
fun associateSystemManager(systemManager: SystemManager)

Associates this system with a system manager, used in the Spatial SDK.
delete
open override fun delete(ent: Entity)

System should do any housekeeping based on entity being removed from the scene
destroy
open override fun destroy()

System should clean up any and all resources for shutdown
equals
open operator override fun equals(other: Any?): Boolean

Checks if this system is equal to another object.
execute
open override fun execute()

System should perform all the operations based on relevant entities.
forEachPanel
fun forEachPanel(action: (Entity, CompletableFuture<PanelSceneObject>) -> Unit)

Iterate over all panels.
getDependencies
open fun getDependencies(): SystemDependencies?

Returns the dependencies of this system.
getScene
fun getScene(): Scene

Returns the scene that this system is associated with.
hashCode
open override fun hashCode(): Int

Returns the hash code of this system.

Companion

object Companion
Did you find this page helpful?
Thumbs up icon
Thumbs down icon