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

MRUKSystem Class

Extends SystemBase
 Modifiers: final
System responsible for managing Mixed Reality Utility Kit (MRUK) operations within the spatial scene.
The MRUKSystem handles core MRUK functionality including scene ticking and entity cleanup for MRUK-related components. It extends SystemBase and integrates with the spatial SDK system architecture to provide seamless mixed reality scene management.
Key responsibilities:
  • Ticks the MR scene and global context on each execution cycle
  • Cleans up entity-to-material mappings when entities are deleted
  • Maintains synchronization between the spatial scene and MRUK native layer

Signature

class MRUKSystem : SystemBase

Constructors

MRUKSystem ()
Signature 
constructor()
Returns

Properties

executeCount : Long
[Get]
The number of times the system has been executed.
Signature 
var executeCount: Long
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 ( entity )
Handles cleanup when an entity is deleted from the scene.
Removes any associated scene material mappings for the deleted entity from the AnchorProceduralMesh cache to prevent memory leaks and stale references.
Signature 
open override fun delete(entity: Entity)
Parameters
entity: Entity
  The entity being deleted from the scene.
destroy ()
System should clean up any and all resources for shutdown
Signature 
open 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 ()
Executes the MRUK system update cycle.
This method is called each frame to tick the MR scene and update the global MRUK context, ensuring synchronization between the spatial scene and the native MRUK layer.
Signature 
open override fun execute()
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?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta