Meta Developers

MR Utility Kit v71 Reference Guide

Unity

Select your SDK

Overview

MRUKRoom Class

Extends MonoBehaviour

Represents a room within MR Utility Kit, containing various anchors and providing a set of utility functions.

Fields

OVRAnchor Anchor[Get]

The primary anchor associated with the room.

MRUKAnchor FloorAnchor[Get]

The floor anchor in the room.

MRUKAnchor CeilingAnchor[Get]

The ceiling anchor in the room.

Properties

bool IsLocal[Get]

A room is considered local if it was loaded from device.

If it was loaded from some other source, e.g. JSON or Prefab then it is not local.

List< MRUKAnchor > Anchors[Get]

Contains all the scene anchors in the room.

List< MRUKAnchor > WallAnchors[Get]

Contains all the wall anchors in the room.

MRUKAnchor GlobalMeshAnchor[Get]

The global mesh anchor in the room.

List< CouchSeat > SeatPoses[Get]

Contains a list of suggested seat placements within the room, specifically on couch objects.

Each seat pose is defined relative to the couch anchor's space.

UnityEvent< MRUKAnchor > AnchorCreatedEvent[Get]

Gets fired when a new anchor of this room has been created.

UnityEvent< MRUKAnchor > AnchorUpdatedEvent[Get]

Gets fired after a component of the corresponding anchor has changed.

UnityEvent< MRUKAnchor > AnchorRemovedEvent[Get]

Gets fired when the anchor has been deleted.

Member Functions

void RegisterAnchorCreatedCallback

( UnityAction< MRUKAnchor > callback )

Registers a callback function to be called when an anchor is created.

Parameters

callback

The function to be called when an anchor is created. It takes one parameter:

MRUKAnchor The created anchor object.

void RegisterAnchorUpdatedCallback

( UnityAction< MRUKAnchor > callback )

Registers a callback function to be called before an anchor is updated.

Parameters

callback

The function to be called when an anchor is updated. It takes one parameter:

MRUKAnchor The updated anchor object.

void RegisterAnchorRemovedCallback

( UnityAction< MRUKAnchor > callback )

Registers a callback function to be called when an anchor is removed.

Parameters

callback

The function to be called when an anchor is removed. It takes one parameter:

MRUKAnchor The removed anchor object.

void UnRegisterAnchorCreatedCallback

( UnityAction< MRUKAnchor > callback )

UnRegisters a callback function to be called when an anchor is created.

Parameters

callback

The function to be called when an anchor is created. It takes one parameter:

MRUKAnchor The created anchor object.

void UnRegisterAnchorUpdatedCallback

( UnityAction< MRUKAnchor > callback )

UnRegisters a callback function to be called before an anchor is updated.

Parameters

callback

The function to be called when an anchor is updated. It takes one parameter:

MRUKAnchor The updated anchor object.

void UnRegisterAnchorRemovedCallback

( UnityAction< MRUKAnchor > callback )

UnRegisters a callback function to be called when an anchor is removed.

Parameters

callback

The function to be called when an anchor is removed. It takes one parameter:

MRUKAnchor The removed anchor object.

List< MRUKAnchor > GetRoomAnchors ( )

Returns all the Scene objects (anchors) in the room.

Useful if you want to do your own calculations within the Mixed Reality Utility Kit framework.

Returns

A list of MRUKAnchor objects representing the anchors in the room.

void RemoveAndDestroyAnchor

( MRUKAnchor anchor )

Removes an anchor from the internal list and destroys the gameobject and it's children.

Parameters

anchor

The Anchor to remove and destroy

MRUKAnchor GetFloorAnchor ( )

Retrieves the floor anchor of this room.

Returns

The floor anchor.

MRUKAnchor GetCeilingAnchor ( )

Retrieves the ceiling anchor of this room.

Returns

The ceiling anchor.

MRUKAnchor GetGlobalMeshAnchor ( )

Retrieves the global mesh anchor of this room.

Returns

The global mesh anchor.

stead")]

List< MRUKAnchor > GetWallAnchors ( )

Retrieves the list of wall anchors of this room.

Returns

A list of wall anchors.

List< Vector3 > GetRoomOutline ( )

Retrieves a clockwise (when viewed top-down) list of wall corner points at floor level.

This method is useful for obtaining the geometric outline of a room based on its walls.

Returns

A list of Vector3 points representing the corners of the room's walls at floor level, arranged in a clockwise order.

MRUKAnchor GetKeyWall

( out Vector2 wallScale,

float tolerance )

Identifies the key wall in the room.

A key wall is the longest wall with no other room points behind it, allowing for a more controlled artistic environment, akin to a stage. This method is useful for scenarios where a clear, unobstructed view of one wall is necessary. Can be used to craft a "stage-like" environment.

Parameters

wallScale

Outputs the scale of the key wall, if found.

tolerance

A tolerance value to account for precision issues in determining if points are behind the wall.

Returns

The anchor representing the key wall, or null if no suitable wall is found.

bool RaycastAll

( Ray ray,

float maxDist,

LabelFilter labelFilter,

List< RaycastHit > raycastHits,

List< MRUKAnchor > anchorList )

Casts a ray against ONLY Scene API objects, returning all results.

This method is used as a replacement for Physics.RaycastAll, specifically tailored to interact with Scene API objects.

Parameters

ray

The ray to cast.

maxDist

The maximum distance the ray should check for collisions.

labelFilter

The filter to apply to scene anchors to determine which ones should be considered.

raycastHits

A list to store the RaycastHit results.

anchorList

A list to store the MRUKAnchor objects hit by the ray.

Returns

True if one or more objects were hit, false otherwise.

bool Raycast

( Ray ray,

float maxDist,