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

MRUKSystem

MRUKSystem

class MRUKSystem : SystemBase---

Deprecated

The functionality exposed in MRUKSystem has been moved to the MRUKFeature class. Please migrate to avoid future issues

Types

NameSummary
Companion
object Companion

Properties

NameSummary
rooms
val rooms: MutableList<MRUKRoom>
systemManager
lateinit var systemManager: SystemManager
The system manager that this system is associated with.

Functions

NameSummary
addOnAnchorAddedListener
fun addOnAnchorAddedListener(listener: (MRUKRoom, Entity) -> Unit)
Add a listener that gets executed whenever a new anchor has been added to a room. The listener gets executed after the room data has been updated but not necessarly all rooms have been processed yet.
addOnAnchorRemovedListener
fun addOnAnchorRemovedListener(listener: (MRUKRoom, Entity) -> Unit)
Add a listener that gets executed whenever a anchor has been removed in a room. The listener gets executed after the room data has been updated but not necessarly all rooms have been processed yet. In addition, it will get executed whenever a room gets removed.
addOnAnchorUpdatedListener
fun addOnAnchorUpdatedListener(listener: (MRUKRoom, Entity) -> Unit)
Add a listener that gets executed whenever a new anchor has been updated in a room. The listener gets executed after the room data has been updated but not necessarly all rooms have been processed yet.
addOnRoomAddedListener
fun addOnRoomAddedListener(listener: (MRUKRoom) -> Unit)
Add a listener that gets executed whenever a new room has been added. The listener gets executed after all room data has been updated.
addOnRoomRemovedListener
fun addOnRoomRemovedListener(listener: (MRUKRoom) -> Unit)
Add a listener that gets executed whenever a room gets removed. The listener gets executed before the room gets removed from MRUKSystem.
addOnRoomUpdatedListener
fun addOnRoomUpdatedListener(listener: (MRUKRoom) -> Unit)
Add a listener that gets executed whenever a room has been updated. The listener gets executed after all room data has been updated.
associateSystemManager
fun associateSystemManager(systemManager: SystemManager)
Associates this system with a system manager, used in the Spatial SDK.
clearRooms
fun clearRooms()
delete
open override 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.
findRoom
fun findRoom(roomUuid: UUID): MRUKRoom?
getCurrentRoom
fun getCurrentRoom(): MRUKRoom?
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.
loadSceneFromDevice
fun loadSceneFromDevice(requestSceneCaptureIfNoDataFound: Boolean = true, removeMissingRooms: Boolean = true): CompletableFuture<MRUKLoadDeviceResult>
loadSceneFromJsonString
fun loadSceneFromJsonString(jsonString: String, removeMissingRooms: Boolean = true)
removeOnAnchorAddedListener
fun removeOnAnchorAddedListener(listener: (MRUKRoom, Entity) -> Unit)
Remove a listener.
removeOnAnchorRemovedListener
fun removeOnAnchorRemovedListener(listener: (MRUKRoom, Entity) -> Unit)
Remove a listener.
removeOnAnchorUpdatedListener
fun removeOnAnchorUpdatedListener(listener: (MRUKRoom, Entity) -> Unit)
Remove a listener.
removeOnRoomAddedListener
fun removeOnRoomAddedListener(listener: (MRUKRoom) -> Unit)
Remove a listener.
removeOnRoomRemovedListener
fun removeOnRoomRemovedListener(listener: (MRUKRoom) -> Unit)
Remove a listener.
removeOnRoomUpdatedListener
fun removeOnRoomUpdatedListener(listener: (MRUKRoom) -> Unit)
Remove a listener.
requestSceneCapture
fun requestSceneCapture(): CompletableFuture<Unit>

Companion

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