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

OVRAnchorContainer Struct

Represents a container for other OVRAnchors.
OVRAnchorContainer extends IOVRAnchorComponent< OVRAnchorContainer >.
OVRAnchorContainer extends IEquatable< OVRAnchorContainer >.

Overview

Properties

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]
Guid[]
Uuids[Get]
Uuids of the anchors contained by this Anchor Container.

Static Fields

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

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 >
FetchChildrenAsync
( List< OVRAnchor > anchors )
Asynchronous method that fetches anchors contained by this Anchor Container.

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.s

Properties

SpaceComponentType IOVRAnchorComponent<OVRAnchorContainer>. OVRAnchorContainer.Type
No description available.
ulong IOVRAnchorComponent<OVRAnchorContainer>. OVRAnchorContainer.Handle
No description available.
bool OVRAnchorContainer.IsNull
Whether this object represents a valid anchor component.
bool OVRAnchorContainer.IsEnabled
True if this component is enabled and no change to its enabled status is pending.
SpaceComponentType OVRAnchorContainer.Type
No description available.
ulong OVRAnchorContainer.Handle
No description available.
Guid [] OVRAnchorContainer.Uuids
Uuids of the anchors contained by this Anchor Container.
See Also:
OVRAnchor.FetchAnchorsAsync(System.Collections.Generic.IEnumerable<System.Guid>,System.Collections.Generic.IList<OVRAnchor>,OVRSpace.StorageLocation,double)
Exceptions
InvalidOperationException
If it fails to retrieve the Uuids, which could happen if the component is not supported or enabled.

Public Statics

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

Member Functions

OVRAnchorContainer IOVRAnchorComponent< OVRAnchorContainer >. OVRAnchorContainer.FromAnchor
( OVRAnchor anchor )
No description available.
OVRTask< bool > IOVRAnchorComponent< OVRAnchorContainer >. OVRAnchorContainer.SetEnabledAsync
( bool enabled,
double timeout )
No description available.
bool OVRAnchorContainer.Equals
( OVRAnchorContainer 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 OVRAnchorContainer.Equals
( object obj )
Compares this component for equality with obj .
Parameters
obj
The object to compare with.
Returns
True if obj is an OVRAnchorContainer and Equals(OVRAnchorContainer) is true, otherwise false.
override int OVRAnchorContainer.GetHashCode ( )
Gets a hashcode suitable for use in a Dictionary or HashSet.
Returns
A hashcode for this component.
override string OVRAnchorContainer.ToString ( )
Gets a string representation of this component.
Returns
A string representation of this component.
OVRTask< bool > OVRAnchorContainer.FetchChildrenAsync
( List< OVRAnchor > anchors )
Asynchronous method that fetches anchors contained by this Anchor Container.
Parameters
anchors
IList that will get cleared and populated with the requested anchors.
Dispose of the returned OVRTask<bool> if you don't use the results
Returns
An OVRTask<bool> 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 Uuids
ArgumentNullException
If parameter anchors is null

Static Member Functions

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