UMRUKSubsystem Class

The status of the scene loading. When loading from device this is an asynchronous process so will be in the Busy state until it moves to Complete or Failed.

An event that will trigger when a scene is loaded either from Device or from JSON. The Success parameter indicates whether the scene was loaded successfully or not.

An event that gets fired after a room has been created.

An event that gets fired after a room has been updated.

An event that gets fired when a room gets removed.

An event that will trigger when the capture flow completed. The Success parameter indicates whether the scene was captured successfully or not.

Contains a list of rooms that are tracked by the mixed reality utility kit subsystem.

When world locking is enabled the position of the VR Pawn will be adjusted each frame to ensure the room anchors are where they should be relative to the camera position. This is necessary to ensure the position of the virtual objects in the world do not get out of sync with the real world.

Cast a ray and return the closest hit anchor in the scene.

Cast a ray and collect hits against the volumes and plane bounds in every room in the scene. The order of the hits in the array is not specified.

Return the room that the headset is currently in. If the headset is not in any given room then it will return the room the headset was last in when this function was called. If the headset hasn't been in a valid room yet then return the first room in the list. If no rooms have been loaded yet then return null.

Save all rooms and anchors to JSON. This JSON representation can than later be used by LoadSceneFromJsonString() to load the scene again.

Load rooms and anchors from a JSON representation. If the scene is already loaded the scene will be updated with the changes.

Load rooms and anchors from the device. If the scene is already loaded the scene will be updated with the changes.

Removes and clears every room.

Get the position on the surface that is closest to the given position with respect to the distance in all rooms.

Finds the closest seat given a ray.

Get a suggested pose (position & rotation) from a raycast to place objects on surfaces in the scene. There are different positioning modes available. Default just uses the position where the raycast hit the object. Edge snaps the position to the edge that is nearest to the user and Center simply centers the position on top of the surface.

Return the longest wall in the current room that has no other walls behind it.

Return the largest surface for a given label in the current room.

Checks if the given position is on or inside of any scene volume in the rooms. All rooms will be checked and the first anchors scene volume that has the point on or inside it will be returned.

Spawn meshes on the position of the anchors of each room. The actors should have Z as up Y as right and X as forward. The pivot point should be in the bottom center.

Spawn meshes on the position of the anchors of each room from a random stream. The actors should have Z as up Y as right and X as forward. The pivot point should be in the bottom center.

Launch the scene capture. After a successful capture the scene should be updated.

This function creates an environment raycaster, which is used to perform raycasting operations against the device depth. Unlike Raycast() and RaycastAll(), no space setup is required for performing these raycasts. It initializes the necessary components and resources required for the raycasting process. The environment raycaster may take a few frames to initialize. During this time, its status can be checked using the EnvironmentRaycasterStatus() function. Alternatively, you can directly call RaycastEnvironment(), which will return a status of NotReady if the raycaster is not yet ready.

Destroy the environment raycaster. This function is responsible for cleaning up and releasing any resources associated with the environment raycaster. It should be called when the raycaster is no longer needed to ensure proper resource management and avoid memory leaks.

Get the status of the environment raycaster. This function returns the current status of the environment raycaster, which indicates whether the raycaster is ready to perform raycasting operations, is still initializing, or has encountered an error.

Perform a raycast in the environment using the device's depth information.This function casts a ray from the specified origin in the given direction and returns the first hit encountered within the specified maximum distance. It is necessary to call CreateEnvironmentRaycaster() before using this function to ensure that the environment raycaster is properly initialized. After raycasting is finished, DestroyEnvironmentRaycaster() can be called to clean up any resources associated with the raycaster.The status of the returned FMRUKEnvironmentRaycastHit can be checked to determine if the raycast was successful.