Meta Developers

MR Utility Kit v68 Reference Guide

Unity

Select your SDK

Overview

FindSpawnPositions

MRUKAnchor Class

Meta::XR::MRUtilityKit::MRUKAnchor extends MonoBehaviour.

Overview

Public Types

enum

SceneLabels {

SceneLabels.FLOOR = 1 << OVRSemanticLabels.Classification.Floor, SceneLabels.CEILING = 1 << OVRSemanticLabels.Classification.Ceiling, SceneLabels.WALL_FACE = 1 << OVRSemanticLabels.Classification.WallFace, SceneLabels.TABLE = 1 << OVRSemanticLabels.Classification.Table, SceneLabels.COUCH = 1 << OVRSemanticLabels.Classification.Couch, SceneLabels.DOOR_FRAME = 1 << OVRSemanticLabels.Classification.DoorFrame, SceneLabels.WINDOW_FRAME = 1 << OVRSemanticLabels.Classification.WindowFrame, SceneLabels.OTHER = 1 << OVRSemanticLabels.Classification.Other, SceneLabels.STORAGE = 1 << OVRSemanticLabels.Classification.Storage, SceneLabels.BED = 1 << OVRSemanticLabels.Classification.Bed, SceneLabels.SCREEN = 1 << OVRSemanticLabels.Classification.Screen, SceneLabels.LAMP = 1 << OVRSemanticLabels.Classification.Lamp, SceneLabels.PLANT = 1 << OVRSemanticLabels.Classification.Plant, SceneLabels.WALL_ART = 1 << OVRSemanticLabels.Classification.WallArt, SceneLabels.GLOBAL_MESH = 1 << OVRSemanticLabels.Classification.SceneMesh, SceneLabels.INVISIBLE_WALL_FACE = 1 << OVRSemanticLabels.Classification.InvisibleWallFace

}

Properties

List< string >	AnchorLabels`[Get]` OVRSemanticLabels.DeprecationMessage
SceneLabels	Label`[Get]`
bool	HasPlane`[Get]`
bool	HasVolume`[Get]`
Mesh	GlobalMesh`[Get]`

Data Fields

Rect?	PlaneRect`[Get]`
Bounds?	VolumeBounds`[Get]`
List< Vector2 >	PlaneBoundary2D`[Get]`
OVRAnchor	Anchor`[Get]`
MRUKRoom	Room`[Get]`
MRUKAnchor	ParentAnchor`[Get]`
List< MRUKAnchor >	ChildAnchors`[Get]`

Public Member Functions

bool	Raycast ( Ray ray, float maxDist, out RaycastHit hitInfo ) We prefer to avoid colliders and Physics.Raycast because:
bool	IsPositionInBoundary ( Vector2 position )
void	AddChildReference ( MRUKAnchor childObj )
void	ClearChildReferences ( )
float	GetDistanceToSurface ( Vector3 position )
float	GetClosestSurfacePosition ( Vector3 testPosition, out Vector3 closestPosition )
float	GetClosestSurfacePosition ( Vector3 testPosition, out Vector3 closestPosition, out Vector3 normal )
Vector3	GetAnchorCenter ( )
Vector3	GetAnchorSize ( ) A convenience function to get a transform-friendly Vector3 size of an anchor.
Vector3[]	GetBoundsFaceCenters ( )
bool	IsPositionInVolume ( Vector3 worldPosition, bool testVerticalBounds, float distanceBuffer ) Test if a position is inside of this volume (couch, desk, etc.)
Mesh	LoadGlobalMeshTriangles ( )
bool	HasLabel ( string label )
bool	HasAnyLabel ( List< string > labels )
bool	HasAnyLabel ( SceneLabels labelFlags ) See if an anchor contains any of the SceneLabels passed as a parameter.
SceneLabels	GetLabelsAsEnum ( ) OVRSemanticLabels.DeprecationMessage
bool	Equals ( Data.AnchorData anchorData ) Compares the current MRUKAnchor object with another Data.AnchorData object for equality.

Details

Member Enumerations

enum Meta::XR::MRUtilityKit::MRUKAnchor.SceneLabels

Enumerator

FLOOR	= 1 << OVRSemanticLabels.Classification.Floor
CEILING	= 1 << OVRSemanticLabels.Classification.Ceiling
WALL_FACE	= 1 << OVRSemanticLabels.Classification.WallFace
TABLE	= 1 << OVRSemanticLabels.Classification.Table
COUCH	= 1 << OVRSemanticLabels.Classification.Couch
DOOR_FRAME	= 1 << OVRSemanticLabels.Classification.DoorFrame
WINDOW_FRAME	= 1 << OVRSemanticLabels.Classification.WindowFrame
OTHER	= 1 << OVRSemanticLabels.Classification.Other
STORAGE	= 1 << OVRSemanticLabels.Classification.Storage
BED	= 1 << OVRSemanticLabels.Classification.Bed
SCREEN	= 1 << OVRSemanticLabels.Classification.Screen
LAMP	= 1 << OVRSemanticLabels.Classification.Lamp
PLANT	= 1 << OVRSemanticLabels.Classification.Plant
WALL_ART	= 1 << OVRSemanticLabels.Classification.WallArt
GLOBAL_MESH	= 1 << OVRSemanticLabels.Classification.SceneMesh
INVISIBLE_WALL_FACE	= 1 << OVRSemanticLabels.Classification.InvisibleWallFace

Properties

List<string> Meta.XR.MRUtilityKit.MRUKAnchor.AnchorLabels
OVRSemanticLabels.DeprecationMessage

SceneLabels Meta.XR.MRUtilityKit.MRUKAnchor.Label
No description available.

bool Meta.XR.MRUtilityKit.MRUKAnchor.HasPlane
No description available.

bool Meta.XR.MRUtilityKit.MRUKAnchor.HasVolume
No description available.

Mesh Meta.XR.MRUtilityKit.MRUKAnchor.GlobalMesh
No description available.

Fields

Rect? Meta.XR.MRUtilityKit.MRUKAnchor.PlaneRect
No description available.

Bounds? Meta.XR.MRUtilityKit.MRUKAnchor.VolumeBounds
No description available.

List<Vector2> Meta.XR.MRUtilityKit.MRUKAnchor.PlaneBoundary2D
No description available.

OVRAnchor Meta.XR.MRUtilityKit.MRUKAnchor.Anchor
No description available.

MRUKRoom Meta.XR.MRUtilityKit.MRUKAnchor.Room
No description available.

MRUKAnchor Meta.XR.MRUtilityKit.MRUKAnchor.ParentAnchor
No description available.

List<MRUKAnchor> Meta.XR.MRUtilityKit.MRUKAnchor.ChildAnchors
No description available.

Member Functions

bool Meta.XR.MRUtilityKit.MRUKAnchor.Raycast ( Ray ray, float maxDist, out RaycastHit hitInfo )
We prefer to avoid colliders and Physics.Raycast because: It requires tags/layers to filter out Scene API object hits from general raycasts. This can be intrusive to a dev's pipeline by altering their project settings It requires specific Plane & Volume prefabs that MRUK instantiates with colliders as children It seems like overkill, since we already "know" where all the Scene API primitives are; no need to raycast everywhere to find them Instead, we use Plane.Raycast and other methods to see if the ray has hit the surface of the object

bool Meta.XR.MRUtilityKit.MRUKAnchor.Raycast
( Ray ray,
float maxDist,
out RaycastHit hitInfo )

We prefer to avoid colliders and Physics.Raycast because:

It requires tags/layers to filter out Scene API object hits from general raycasts. This can be intrusive to a dev's pipeline by altering their project settings
It requires specific Plane & Volume prefabs that MRUK instantiates with colliders as children
It seems like overkill, since we already "know" where all the Scene API primitives are; no need to raycast everywhere to find them Instead, we use Plane.Raycast and other methods to see if the ray has hit the surface of the object

bool Meta.XR.MRUtilityKit.MRUKAnchor.IsPositionInBoundary ( Vector2 position )
No description available.

void Meta.XR.MRUtilityKit.MRUKAnchor.AddChildReference ( MRUKAnchor childObj )
No description available.

void Meta.XR.MRUtilityKit.MRUKAnchor.ClearChildReferences ( )
No description available.

float Meta.XR.MRUtilityKit.MRUKAnchor.GetDistanceToSurface ( Vector3 position )
No description available.

float Meta.XR.MRUtilityKit.MRUKAnchor.GetClosestSurfacePosition ( Vector3 testPosition, out Vector3 closestPosition )
No description available.

float Meta.XR.MRUtilityKit.MRUKAnchor.GetClosestSurfacePosition ( Vector3 testPosition, out Vector3 closestPosition, out Vector3 normal )
No description available.

Vector3 Meta.XR.MRUtilityKit.MRUKAnchor.GetAnchorCenter ( )
No description available.

Vector3 Meta.XR.MRUtilityKit.MRUKAnchor.GetAnchorSize ( )
A convenience function to get a transform-friendly Vector3 size of an anchor.