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

VisibleSystem

VisibleSystem

class VisibleSystem : SystemBase
This System uses the Visible component to show/hide entity meshes.
This System comes default with Meta Spatial SDK and operates on entities with Visible component. It updates the visibility of com.meta.spatial.runtime.SceneObject commonly added via Mesh or Panel components.
It depends on SceneObjectSystem to access the SceneObjects associated with entities and must run after MeshCreationSystem to ensure visibility is set correctly when meshes are created.

Constructors

NameSummary
VisibleSystem
constructor()

Properties

NameSummary
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 fun delete(entity: Entity)

System should do any housekeeping based on entity being removed from the scene
destroy
open 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.
getDependencies
open override fun getDependencies(): SystemDependencies?

This system must run after the MeshCreationSystem.
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.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon