API reference
API reference
Select your platform
No SDKs available
No versions available

OVRRoomMesh Struct

Extends IEquatable< OVRRoomMesh >
Represents the polyhedral mesh representation of a room.
This component can be accessed from an OVRAnchor that supports it by calling OVRAnchor.GetComponent<T> from the anchor.
The room mesh component is part of the Meta Quest Scene Model. Read more at Scene Overview.

Static Fields

Null : readonly OVRRoomMesh
A null representation of an OVRRoomMesh.
Use this to compare with another component to determine whether it is null.
Signature
readonly OVRRoomMesh Null

Properties

IsEnabled : bool
[Get]
True if this component is enabled and no change to its enabled status is pending.
Signature
bool IsEnabled
IsNull : bool
[Get]
Whether this object represents a valid anchor component.
Signature
bool IsNull

Methods

Equals ( other )
Compares this component for equality with other .
Signature
bool Equals(OVRRoomMesh other)
Parameters
other: OVRRoomMesh  The other component to compare with.
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.
Equals ( obj )
Compares this component for equality with obj .
Signature
override bool Equals(object obj)
Parameters
obj: object  The object to compare with.
Returns
override bool  True if obj is an OVRRoomMesh and Equals(OVRRoomMesh) is true, otherwise false.
GetHashCode ()
Gets a hashcode suitable for use in a Dictionary or HashSet.
Signature
override int GetHashCode()
Returns
override int  A hashcode for this component.
ToString ()
Gets a string representation of this component.
Signature
override string ToString()
Returns
override string  A string representation of this component.
TryGetRoomFaceIndexCount ( faceUuid , faceIndexCount )
Gets the number of indices for a given face of the room mesh.
Use this method to get the required size index buffer. Once the buffer has been created, use it in conjunction with TryGetRoomFaceIndices>.
The indices of the face are with respect to the global room mesh vertices, and they form a triangulated planar surface that may be convex and contain interior boundaries (holes).
Signature
bool TryGetRoomFaceIndexCount(Guid faceUuid, out int faceIndexCount)
Parameters
faceUuid: Guid  The uuid of the face in question.
faceIndexCount: out int  The number of indices in the face of the room mesh.
Returns
bool  Returns true if the count was retrieved; otherwise, false.
TryGetRoomFaceIndices ( faceUuid , faceIndices )
Gets the indices for a face in the room mesh.
The caller owns the memory of the input array and is responsible for allocating it to the appropriate size before passing it to this method. Use TryGetRoomFaceIndexCount to determine the required size of the array.
The index data provided by this method has been converted from the right-handed coordinate space defined by OpenXR to Unity's coordinate space.
The indices of the face are with respect to the global room mesh vertices, and they form a triangulated planar surface that may be convex and contain interior boundaries (holes).
Signature
bool TryGetRoomFaceIndices(Guid faceUuid, NativeArray< uint > faceIndices)
Parameters
faceUuid: Guid  The uuid of the face in question.
faceIndices: NativeArray< uint >  The triangle indices of the face of the room mesh.
Returns
bool  Returns true if the face index data was retrieved; otherwise, false.
TryGetRoomMesh ( vertices , faces )
Gets the room mesh by populating the provided arrays.
The caller owns the memory of the input arrays and is responsible for allocating them to the appropriate size before passing them to this method. Use TryGetRoomMeshCounts to determine the required size of each array.
The vertex data provided by this method has been converted from the right-handed coordinate space defined by OpenXR to Unity's coordinate space.
Signature
bool TryGetRoomMesh(NativeArray< Vector3 > vertices, NativeArray< Face > faces)
Parameters
vertices: NativeArray< Vector3 >  The vertex positions of the room mesh.
faces: NativeArray< Face >  The faces of the room mesh.
Returns
bool  Return true if the room mesh data was retrieved; otherwise, false.
TryGetRoomMeshCounts ( vertexCount , faceCount )
Gets the number of vertices and faces in the room mesh.
Use this method to get the required sizes of the vertex and face buffers. Once these buffers have been created, use these in conjunction with TryGetRoomMesh>.
Signature
bool TryGetRoomMeshCounts(out int vertexCount, out int faceCount)
Parameters
vertexCount: out int  The number of vertices in the room mesh.
faceCount: out int  The number of faces in the room mesh.
Returns
bool  Returns true if the counts were retrieved; otherwise, false.

Static Methods

operator!= ( lhs , rhs )
Compares two components for inequality.
Signature
static bool operator!=(OVRRoomMesh lhs, OVRRoomMesh rhs)
Parameters
lhs: OVRRoomMesh  The component to compare with rhs .
rhs: OVRRoomMesh  The component to compare with lhs .
Returns
bool  True if the components do not belong to the same OVRAnchor, otherwise false.
operator== ( lhs , rhs )
Compares two components for equality.
Signature
static bool operator==(OVRRoomMesh lhs, OVRRoomMesh rhs)
Parameters
lhs: OVRRoomMesh  The component to compare with rhs .
rhs: OVRRoomMesh  The component to compare with lhs .
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.

Inner Struct

Face Struct

Represents information about a single face within the OVRRoomMesh.
A face is uniquely identified with a Guid, and may optionally have a parent Guid if it is completely embedded within another face.
Each face is planar, may be convex and may contain interior boundaries (holes).

Fields

ParentUuid : Guid
Signature
Guid ParentUuid
Signature
OVRSemanticLabels.Classification SemanticLabel
Uuid : Guid
Signature
Guid Uuid