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.

Signature

class PanelCreationSystem(val panelCreator: HashMap<Int, (ent: Entity) -> PanelSceneObject>) : SystemBase

Constructors

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

Properties

executeCount : Long
[Get]
The number of times the system has been executed.
Signature
var executeCount: Long
panelCreator : HashMap
[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 system manager that this system is associated with.
Signature
lateinit var systemManager: SystemManager

Functions

associateSystemManager ( systemManager )
Associates this system with a system manager, used in the Spatial SDK.
Signature
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager
  The system manager to associate with.
delete ( ent )
System should do any housekeeping based on entity being removed from the scene
Signature
open override fun delete(ent: Entity)
Parameters
ent: Entity
destroy ()
System should clean up any and all resources for shutdown
Signature
open override fun destroy()
equals ( other )
Checks if this system is equal to another object.
Signature
open operator override fun equals(other: Any?): Boolean
Parameters
other: Any?
  The object to compare with.
Returns
Boolean
  True if this system is equal to the other object, false otherwise.
execute ()
System should perform all the operations based on relevant entities.
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 dependencies of this system.
Signature
open fun getDependencies(): SystemDependencies?
Returns
  The dependencies of this system, or null if there are no dependencies.
getScene ()
Returns the scene that this system is associated with.
Signature
fun getScene(): Scene
Returns
  The scene that this system is associated with.
hashCode ()
Returns the hash code of this system.
Signature
open override fun hashCode(): Int
Returns
Int
  The hash code of this system.
Did you find this page helpful?