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

OVRBounded2D Struct

Represents a plane described by its Rect and boundary points.
OVRBounded2D extends IOVRAnchorComponent< OVRBounded2D >.
OVRBounded2D extends IEquatable< OVRBounded2D >.

Overview

Properties

SpaceComponentType IOVRAnchorComponent< OVRBounded2D >.
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]
Rect
Bounding Box.

Static Fields

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

Public Member Functions

FromAnchor
( OVRAnchor anchor )
SetEnabledAsync
( bool enabled,
double timeout )
bool
Equals
( OVRBounded2D other )
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.
bool
TryGetBoundaryPointsCount
( out int count )
Retrieves the number of boundary points contained in an Anchor with an enabled Bounded2D component.
bool
TryGetBoundaryPoints
( NativeArray< Vector2 > positions )
Retrieves the boundary points contained in an Anchor with an enabled Bounded2D component.

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<OVRBounded2D>. OVRBounded2D.Type
No description available.
ulong IOVRAnchorComponent<OVRBounded2D>. OVRBounded2D.Handle
No description available.
bool OVRBounded2D.IsNull
Whether this object represents a valid anchor component.
bool OVRBounded2D.IsEnabled
True if this component is enabled and no change to its enabled status is pending.
SpaceComponentType OVRBounded2D.Type
No description available.
ulong OVRBounded2D.Handle
No description available.
Rect OVRBounded2D.BoundingBox
Bounding Box.
Returns
Rect representing the 2D Bounding Box of the Anchor this component is attached to.
Exceptions
InvalidOperationException
If it fails to retrieve the Bounding Box.

Public Statics

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

Member Functions

OVRBounded2D IOVRAnchorComponent< OVRBounded2D >. OVRBounded2D.FromAnchor
( OVRAnchor anchor )
No description available.
OVRTask< bool > IOVRAnchorComponent< OVRBounded2D >. OVRBounded2D.SetEnabledAsync
( bool enabled,
double timeout )
No description available.
bool OVRBounded2D.Equals
( OVRBounded2D 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 OVRBounded2D.Equals
( object obj )
Compares this component for equality with obj .
Parameters
obj
The object to compare with.
Returns
True if obj is an OVRBounded2D and Equals(OVRBounded2D) is true, otherwise false.
override int OVRBounded2D.GetHashCode ( )
Gets a hashcode suitable for use in a Dictionary or HashSet.
Returns
A hashcode for this component.
override string OVRBounded2D.ToString ( )
Gets a string representation of this component.
Returns
A string representation of this component.
bool OVRBounded2D.TryGetBoundaryPointsCount
( out int count )
Retrieves the number of boundary points contained in an Anchor with an enabled Bounded2D component.
Parameters
count
The number of boundary points contained in the Bounded2D component of the Anchor, as an out parameter.
Returns
true if it successfully retrieves the count, false otherwise.
This is the first part of the two-calls idiom for retrieving boundary points. TryGetBoundaryPoints to actually get those points.
bool OVRBounded2D.TryGetBoundaryPoints
( NativeArray< Vector2 > positions )
Retrieves the boundary points contained in an Anchor with an enabled Bounded2D component.
Parameters
positions
The array that will get populated with the boundary points contained in the Bounded2D component of the Anchor.
Returns
true if it successfully populates the positions array with the boundary points.
Exceptions
ArgumentException
Thrown when positions has not been created.
This is the second part of the two-calls idiom for retrieving boundary points. It is expected for the positions to be created and with enough capacity to contain the boundary points.

Static Member Functions

static bool OVRBounded2D.operator==
( OVRBounded2D 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 OVRBounded2D.operator!=
( OVRBounded2D 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