API reference

Data Class

Provides a container for various data structures used in MR Utility Kit.

Inner Structs

AnchorData Struct

Contains data related to an anchor including its UUID and associated properties.

Fields

Anchor : OVRAnchor
The UUID of the anchor, used for serialization.
remarks> When serializing the Anchor, we only serialize its UUID. The handle is not preserved as this is only valid on the device where it is loaded and not across sessions.
Signature
OVRAnchor Anchor
GlobalMesh : GlobalMeshData?
Optional global GlobalMeshData associated with the anchor.
Signature
GlobalMeshData? GlobalMesh
PlaneBoundary2D : List< Vector2 >
A list of 2D vectors representing the boundary of the plane.
Signature
List<Vector2> PlaneBoundary2D
PlaneBounds : PlaneBoundsData?
Optional PlaneBoundsData associated with the anchor.
Signature
PlaneBoundsData? PlaneBounds
SemanticClassifications : List< String >
A list of semantic classifications associated with the anchor.
Signature
List<String> SemanticClassifications
Transform : TransformData
The transformation data associated with the anchor.
Signature
TransformData Transform
VolumeBounds : VolumeBoundsData?
Optional VolumeBoundsData associated with the anchor.
Signature
VolumeBoundsData? VolumeBounds

GlobalMeshData Struct

Represents the mesh data of a global mesh anchor.

Fields

Indices : int[]
Array of indices that define the triangles of the mesh.
Signature
int [] Indices
Positions : Vector3[]
Array of indices that define the vertices of the mesh.
Signature
Vector3 [] Positions

PlaneBoundsData Struct

Defines the 2D bounds of a plane using minimum and maximum vectors.

Fields

Max : Vector2
The maximum vector of the plane bounds.
Signature
Vector2 Max
Min : Vector2
The minimum vector of the plane bounds.
Signature
Vector2 Min

RoomData Struct

Contains data related to a room including its layout and associated anchors.

Fields

Anchor : OVRAnchor
The UUID of the room anchor.
When serializing the Anchor, we only serialize its UUID. The handle is not preserved as this is only valid on the device where it is loaded and not across sessions.
Signature
OVRAnchor Anchor
Anchors : List< AnchorData >
A list of rooms within the scene.
Signature
List<AnchorData> Anchors
RoomLayout : RoomLayoutData
The layout of the room, detailing the floor, ceiling, and walls.
Signature
RoomLayoutData RoomLayout

RoomLayoutData Struct

Contains UUIDs for different components of a room layout such as floor, ceiling, and walls.

Fields

CeilingUuid : Guid
The UUID of the ceiling component.
Signature
Guid CeilingUuid
FloorUuid : Guid
The UUID of the floor component.
Signature
Guid FloorUuid
WallsUuid : List< Guid >
A list of UUIDs for the walls.
Signature
List<Guid> WallsUuid

SceneData Struct

Represents the entire scene data including coordinate system and rooms.

Fields

The coordinate system used in the scene.
Signature
SerializationHelpers.CoordinateSystem CoordinateSystem
Rooms : List< RoomData >
A list of rooms within the scene.
Signature
List<RoomData> Rooms

TransformData Struct

Represents transformation data including translation, rotation, and scale.

Fields

Rotation : Vector3
The rotation vector representing orientation in three-dimensional space.
Signature
Vector3 Rotation
Scale : Vector3
The scale vector representing the size in three-dimensional space.
Signature
Vector3 Scale
Translation : Vector3
The translation vector representing position in three-dimensional space.
Signature
Vector3 Translation

VolumeBoundsData Struct

Defines the 3D volume bounds using minimum and maximum vectors.

Fields

Max : Vector3
The maximum vector of the volume bounds.
Signature
Vector3 Max
Min : Vector3
The minimum vector of the volume bounds.
Signature
Vector3 Min