API reference
MRUK Class
Extends MonoBehaviour
This class contains convenience functions that allow you to query your scene.
Member Enumerations
Enumeration PositioningMethod
DEFAULT | No description available |
CENTER | No description available |
EDGE | No description available |
Enumeration SceneDataSource
Specify the source of the scene data.
Device | Load scene data from the device. |
Prefab | Load scene data from prefabs. |
DeviceWithPrefabFallback | First try to load data from the device and if none can be found fall back to loading from a prefab. |
Json | Load Scene from a Json file. |
DeviceWithJsonFallback | First try to load data from the device and if none can be found fall back to loading from a Json file. |
Enumeration RoomFilter
None | No description available |
CurrentRoomOnly | No description available |
AllRooms | No description available |
Enumeration LoadDeviceResult
Return value from the call to LoadSceneFromDevice.
Success | Scene data loaded successfully. |
NoScenePermission | User did not grant scene permissions. |
NoRoomsFound | No rooms were found (e.g. |
FailureDataIsInvalid | Invalid data. |
FailureInsufficientResources | Resource limitation prevented this operation from executing. |
FailureInsufficientView | Insufficient view. |
FailurePermissionInsufficient | Insufficient permission. |
FailureRateLimited | Operation canceled due to rate limiting. |
FailureTooDark | Too dark. |
FailureTooBright | Too bright. |
Enumeration SurfaceType
FACING_ | = 1 << 0 |
FACING_ | = 1 << 1 |
VERTICAL | = 1 << 2 |
Properties
bool IsInitialized[Get]
UnityEvent SceneLoadedEvent[Get]
Event that is triggered when the scene is loaded.
UnityEvent< MRUKRoom > RoomCreatedEvent[Get]
Event that is triggered when a room is created.
UnityEvent< MRUKRoom > RoomUpdatedEvent[Get]
Event that is triggered when a room is updated.
UnityEvent< MRUKRoom > RoomRemovedEvent[Get]
Event that is triggered when a room is removed.
OVRCameraRig _cameraRig[Get]
List< MRUKRoom > Rooms[Get]
List of all the rooms in the scene.
static Instance[Get]
Fields
bool EnableWorldLock[Get]
When world locking is enabled the position of the camera rig 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.
MRUKSettings SceneSettings[Get]
Member Functions
void RegisterSceneLoadedCallback
( UnityAction callback )
Register to receive a callback when the scene is loaded.
If the scene is already loaded at the time this is called, the callback will be invoked immediatly.
Parameters
callback
void RegisterRoomCreatedCallback
( UnityAction< MRUKRoom > callback )
Register to receive a callback when a new room has been created from scene capture.
Parameters
callback
- MRUKRoom The created room object.
void RegisterRoomUpdatedCallback
( UnityAction< MRUKRoom > callback )
Register to receive a callback when a room has been updated from scene capture.
Parameters
callback
- MRUKRoom The updated room object.
void RegisterRoomRemovedCallback
( UnityAction< MRUKRoom > callback )
Registers a callback function to be called before the room is removed.
Parameters
callback
The function to be called when the room is removed. It takes one parameter:
- MRUKRoom The removed room object.
List< MRUKRoom > GetRooms ( )
Get a list of all the rooms in the scene.
List< MRUKAnchor > GetAnchors ( )
Get a flat list of all Anchors in the scene.
MRUKRoom GetCurrentRoom ( )
Returns the current room the headset is 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.
void ClearScene ( )
Destroys the rooms and all children.
async Task< LoadDeviceResult > LoadSceneFromDevice
( bool requestSceneCaptureIfNoDataFound,
bool removeMissingRooms )
Loads the scene from the data stored on the device.
The user must have granted ScenePermissions or this will fail. In order to check if the user has granted permissions use the following call: Permission
Parameters
requestSceneCaptureIfNoDataFound
If true and no rooms are found when loading from device, the request space setup flow will be started.
removeMissingRooms
When enabled, rooms that are already loaded but are not found in newSceneData will be removed. This is to support the case where a user deletes a room from their device and the change needs to be reflected in the app.
Returns
An enum indicating whether loading was successful or not.
void LoadSceneFromPrefab
( GameObject scenePrefab,
bool clearSceneFirst )
This simulates the creation of a scene in the Editor, using transforms and names from our prefab rooms.
string SaveSceneToJsonString
( SerializationHelpers.CoordinateSystem coordinateSystem )
Serializes the current scene into a JSON string using the specified coordinate system for serialization.
Parameters
coordinateSystem
The coordinate system to be used for serialization (Unity/Unreal).
Returns
A JSON string representing the serialized scene data.
void LoadSceneFromJsonString
( string jsonString,
bool removeMissingRooms )
Loads the scene from a JSON string representing the scene data.
Parameters
jsonString
The JSON string containing the serialized scene data.
removeMissingRooms
When enabled, rooms that are already loaded but are not found in JSON the string will be removed.
Static Member Functions
static async Task< bool > HasSceneModel ( )
Checks whether any anchors can be loaded.
Returns
Returns a task-based bool, which is true if there are any scene anchors in the system, and false otherwise. If false is returned, then either the scene permission needs to be set, or the user has to run Scene Capture.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta