Meta Developers

MR Utility Kit v68 Reference Guide

Unity

Select your SDK

This class contains convenience functions that allow you to query your scene.

Meta::XR::MRUtilityKit::MRUK extends MonoBehaviour.

See Also:

Overview

Public Types

enum	PositioningMethod { PositioningMethod.DEFAULT , PositioningMethod.CENTER , PositioningMethod.EDGE }
enum	SceneDataSource { SceneDataSource.Device , SceneDataSource.Prefab , SceneDataSource.DeviceWithPrefabFallback , SceneDataSource.Json , SceneDataSource.DeviceWithJsonFallback } Specify the source of the scene data.
enum	RoomFilter { RoomFilter.None , RoomFilter.CurrentRoomOnly , RoomFilter.AllRooms }
enum	LoadDeviceResult { LoadDeviceResult.Success = OVRAnchor.FetchResult.Success, LoadDeviceResult.NoScenePermission = 1, LoadDeviceResult.NoRoomsFound = 2, LoadDeviceResult.FailureDataIsInvalid = OVRAnchor.FetchResult.FailureDataIsInvalid, LoadDeviceResult.FailureInsufficientResources = OVRAnchor.FetchResult.FailureInsufficientResources, LoadDeviceResult.FailureInsufficientView = OVRAnchor.FetchResult.FailureInsufficientView, LoadDeviceResult.FailurePermissionInsufficient = OVRAnchor.FetchResult.FailurePermissionInsufficient, LoadDeviceResult.FailureRateLimited = OVRAnchor.FetchResult.FailureRateLimited, LoadDeviceResult.FailureTooDark = OVRAnchor.FetchResult.FailureTooDark, LoadDeviceResult.FailureTooBright = OVRAnchor.FetchResult.FailureTooBright } Return value from the call to LoadSceneFromDevice.
enum	SurfaceType { SurfaceType.FACING_UP = 1 << 0, SurfaceType.FACING_DOWN = 1 << 1, SurfaceType.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]`

Data 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]`

Public Member Functions

void	RegisterSceneLoadedCallback ( UnityAction callback ) Register to receive a callback when the scene is loaded.
void	RegisterRoomCreatedCallback ( UnityAction< MRUKRoom > callback ) Register to receive a callback when a new room has been created from scene capture.
void	RegisterRoomUpdatedCallback ( UnityAction< MRUKRoom > callback ) Register to receive a callback when a room has been updated from scene capture.
void	RegisterRoomRemovedCallback ( UnityAction< MRUKRoom > callback ) Registers a callback function to be called before the room is removed.
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.
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.
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.
void	LoadSceneFromJsonString ( string jsonString, bool removeMissingRooms ) Loads the scene from a JSON string representing the scene data.

Static Public Member Functions

static async Task< bool >

Checks whether any anchors can be loaded.

Details

Detailed Description

Use together with

See Also:

MRUKLoader

to load data via link, fake data, or on-device data.

Member Enumerations

enum Meta::XR::MRUtilityKit::MRUK.PositioningMethod

Enumerator

enum Meta::XR::MRUtilityKit::MRUK.SceneDataSource

Specify the source of the scene data.

Enumerator

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.

enum Meta::XR::MRUtilityKit::MRUK.RoomFilter

Enumerator

enum Meta::XR::MRUtilityKit::MRUK.LoadDeviceResult

Return value from the call to LoadSceneFromDevice.

Enumerator

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.