OVRAnchorContainer Struct

Extends IOVRAnchorComponent< OVRAnchorContainer >, IEquatable< OVRAnchorContainer >

Represents a container for other OVRAnchors.

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

See Also

Uuids, FetchChildrenAsync

Properties

SpaceComponentType IOVRAnchorComponent< OVRAnchorContainer >. Type[Get]

ulong IOVRAnchorComponent< OVRAnchorContainer >. Handle[Get]

bool IsNull[Get]

Whether this object represents a valid anchor component.

bool IsEnabled[Get]

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.

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

static readonly OVRAnchorContainer Null[Get]

A null representation of an OVRAnchorContainer.

Use this to compare with another component to determine whether it is null.

Member Functions

OVRAnchorContainer IOVRAnchorComponent< OVRAnchorContainer >. FromAnchor

( OVRAnchor anchor )

OVRTask< bool > IOVRAnchorComponent< OVRAnchorContainer >. SetEnabledAsync

( bool enabled,

double timeout )

bool 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 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 GetHashCode ( )

Gets a hashcode suitable for use in a Dictionary or HashSet.

Returns

A hashcode for this component.

override string ToString ( )

Gets a string representation of this component.

Returns

A string representation of this component.

OVRTask< bool > FetchChildrenAsync

( List< OVRAnchor > anchors )

(Obsolete) Asynchronous method that fetches anchors contained by this Anchor Container.

Dispose of the returned OVRTask<T> if you don't use the results

Parameters

anchors

List that will get cleared and populated with the requested anchors.

Deprecated

This method is obsolete. Use FetchAnchorsAsync instead.

Returns

An OVRTask<T> 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

OVRTask< OVRResult< List< OVRAnchor >, OVRAnchor.FetchResult > > FetchAnchorsAsync

( List< OVRAnchor > anchors )

Fetches anchors contained by this Anchor Container.

Dispose of the returned OVRTask<T> if you don't use the results

Parameters

anchors

List that will get cleared and populated with the requested anchors.

Returns

An OVRTask<T> 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 operator==

( OVRAnchorContainer lhs,

OVRAnchorContainer rhs )

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 operator!=

( OVRAnchorContainer lhs,

OVRAnchorContainer rhs )

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?