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

OVRRoomLayout Struct

Represents a room described by its floor, ceiling and walls OVRAnchors.
OVRRoomLayout extends IOVRAnchorComponent< OVRRoomLayout >.
OVRRoomLayout extends IEquatable< OVRRoomLayout >.

Overview

Properties

SpaceComponentType IOVRAnchorComponent< OVRRoomLayout >.
Type[Get]
Handle[Get]
bool
IsNull[Get]
Whether this object represents a valid anchor component.
bool
True if this component is enabled and no change to its enabled status is pending.
SpaceComponentType
Type[Get]
ulong
Handle[Get]

Static Fields

static readonly OVRRoomLayout
Null[Get]
A null representation of an OVRRoomLayout.

Public Member Functions

FromAnchor
( OVRAnchor anchor )
SetEnabledAsync
( bool enabled,
double timeout )
bool
Compares this component for equality with other .
override bool
Equals
( object obj )
Compares this component for equality with obj .
override int
Gets a hashcode suitable for use in a Dictionary or HashSet.
override string
Gets a string representation of this component.
OVRTask< bool >
FetchLayoutAnchorsAsync
( List< OVRAnchor > anchors )
Asynchronous method that fetches anchors contained in the Room Layout.
bool
TryGetRoomLayout
( out Guid ceiling,
out Guid floor,
out Guid[] walls )
Tries to get the Ceiling, Floor and Walls unique identifiers.

Static Public Member Functions

static bool
Compares two components for equality.
static bool
Compares two components for inequality.

Details

Detailed Description

This component can be accessed from an OVRAnchor that supports it by calling OVRAnchor.GetComponent<T> from the anchor.

Properties

SpaceComponentType IOVRAnchorComponent<OVRRoomLayout>. OVRRoomLayout.Type
No description available.
ulong IOVRAnchorComponent<OVRRoomLayout>. OVRRoomLayout.Handle
No description available.
bool OVRRoomLayout.IsNull
Whether this object represents a valid anchor component.
bool OVRRoomLayout.IsEnabled
True if this component is enabled and no change to its enabled status is pending.
SpaceComponentType OVRRoomLayout.Type
No description available.
ulong OVRRoomLayout.Handle
No description available.

Public Statics

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

Member Functions

OVRRoomLayout IOVRAnchorComponent< OVRRoomLayout >. OVRRoomLayout.FromAnchor
( OVRAnchor anchor )
No description available.
OVRTask< bool > IOVRAnchorComponent< OVRRoomLayout >. OVRRoomLayout.SetEnabledAsync
( bool enabled,
double timeout )
No description available.
bool OVRRoomLayout.Equals
( OVRRoomLayout other )
Compares this component for equality with other .
Parameters
other
The other component to compare with.
Returns
True if both components belong to the same OVRAnchor, otherwise false.
override bool OVRRoomLayout.Equals
( object obj )
Compares this component for equality with obj .
Parameters
obj
The object to compare with.
Returns
True if obj is an OVRRoomLayout and Equals(OVRRoomLayout) is true, otherwise false.
override int OVRRoomLayout.GetHashCode ( )
Gets a hashcode suitable for use in a Dictionary or HashSet.
Returns
A hashcode for this component.
override string OVRRoomLayout.ToString ( )
Gets a string representation of this component.
Returns
A string representation of this component.
OVRTask< bool > OVRRoomLayout.FetchLayoutAnchorsAsync
( List< OVRAnchor > anchors )
Asynchronous method that fetches anchors contained in the Room Layout.
Parameters
anchors
List that will get cleared and populated with the requested anchors.
Dispose of the returned task if you don't use the results
Returns
A task that will eventually let you test if the fetch was successful or not. If the result is true, then the anchors parameter has been populated with the requested anchors.
Exceptions
InvalidOperationException
If it fails to retrieve the Room Layout
ArgumentNullException
If parameter anchors is null
bool OVRRoomLayout.TryGetRoomLayout
( out Guid ceiling,
out Guid floor,
out Guid[] walls )
Tries to get the Ceiling, Floor and Walls unique identifiers.
These can then be used to Fetch their anchors.
Parameters
ceiling
Out Guid representing the ceiling of the room.
floor
Out Guid representing the floor of the room.
walls
Out array of Guids representing the walls of the room.
Returns
bool true if the request succeeds and false if it fails.

Static Member Functions

static bool OVRRoomLayout.operator==
( OVRRoomLayout lhs,
Compares two components for equality.
Parameters
lhs
The component to compare with rhs .
rhs
The component to compare with lhs .
Returns
True if both components belong to the same OVRAnchor, otherwise false.
static bool OVRRoomLayout.operator!=
( OVRRoomLayout lhs,
Compares two components for inequality.
Parameters
lhs
The component to compare with rhs .
rhs
The component to compare with lhs .
Returns
True if the components do not belong to the same OVRAnchor, otherwise false.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon