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

OVRAnchorContainer Struct

Extends 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

Static Fields

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

Properties

[Get]
Signature
ulong IOVRAnchorComponent<OVRAnchorContainer>. OVRAnchorContainer.Handle
IsEnabled : bool
[Get]
True if this component is enabled and no change to its enabled status is pending.
Signature
bool OVRAnchorContainer.IsEnabled
IsNull : bool
[Get]
Whether this object represents a valid anchor component.
Signature
bool OVRAnchorContainer.IsNull
Type : SpaceComponentType IOVRAnchorComponent< OVRAnchorContainer >.
[Get]
Signature
SpaceComponentType IOVRAnchorComponent<OVRAnchorContainer>. OVRAnchorContainer.Type
Uuids : Guid[]
[Get]
Uuids of the anchors contained by this Anchor Container.
Signature
Guid [] OVRAnchorContainer.Uuids

Methods

Equals ( other )
Compares this component for equality with other .
Signature
bool OVRAnchorContainer.Equals(OVRAnchorContainer other)
Parameters
other: OVRAnchorContainer  The other component to compare with.
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.
Equals ( obj )
Compares this component for equality with obj .
Signature
override bool OVRAnchorContainer.Equals(object obj)
Parameters
obj: object  The object to compare with.
Returns
override bool  True if obj is an OVRAnchorContainer and Equals(OVRAnchorContainer) is true, otherwise false.
FetchAnchorsAsync ( anchors )
Fetches anchors contained by this Anchor Container.
Dispose of the returned OVRTask<T> if you don't use the results
Signature
OVRTask< OVRResult< List< OVRAnchor >, OVRAnchor.FetchResult > > OVRAnchorContainer.FetchAnchorsAsync(List< OVRAnchor > anchors)
Parameters
anchors: List< OVRAnchor >  List that will get cleared and populated with the requested anchors.
Returns
OVRTask< OVRResult< List< OVRAnchor >, OVRAnchor.FetchResult > >  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.
Throws
InvalidOperationException  If it fails to retrieve the Uuids ArgumentNullException  If parameter anchors is null
FetchChildrenAsync ( anchors )
(Obsolete) Asynchronous method that fetches anchors contained by this Anchor Container.
DeprecatedThis method is obsolete. Use FetchAnchorsAsync instead.
Dispose of the returned OVRTask<T> if you don't use the results
Signature
OVRTask< bool > OVRAnchorContainer.FetchChildrenAsync(List< OVRAnchor > anchors)
Parameters
anchors: List< OVRAnchor >  List that will get cleared and populated with the requested anchors.
Returns
OVRTask< bool >  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.
Throws
InvalidOperationException  If it fails to retrieve the Uuids ArgumentNullException  If parameter anchors is null
FromAnchor ( anchor )
Signature
OVRAnchorContainer IOVRAnchorComponent< OVRAnchorContainer >. OVRAnchorContainer.FromAnchor(OVRAnchor anchor)
Parameters
anchor: OVRAnchor
GetHashCode ()
Gets a hashcode suitable for use in a Dictionary or HashSet.
Signature
override int OVRAnchorContainer.GetHashCode()
Returns
override int  A hashcode for this component.
SetEnabledAsync ( enabled , timeout )
Signature
OVRTask< bool > IOVRAnchorComponent< OVRAnchorContainer >. OVRAnchorContainer.SetEnabledAsync(bool enabled, double timeout)
Parameters
enabled: bool
timeout: double
ToString ()
Gets a string representation of this component.
Signature
override string OVRAnchorContainer.ToString()
Returns
override string  A string representation of this component.

Static Methods

operator!= ( lhs , rhs )
Compares two components for inequality.
Signature
static bool OVRAnchorContainer.operator!=(OVRAnchorContainer lhs, OVRAnchorContainer rhs)
Parameters
lhs: OVRAnchorContainer  The component to compare with rhs .
rhs: OVRAnchorContainer  The component to compare with lhs .
Returns
bool  True if the components do not belong to the same OVRAnchor, otherwise false.
operator== ( lhs , rhs )
Compares two components for equality.
Signature
static bool OVRAnchorContainer.operator==(OVRAnchorContainer lhs, OVRAnchorContainer rhs)
Parameters
lhs: OVRAnchorContainer  The component to compare with rhs .
rhs: OVRAnchorContainer  The component to compare with lhs .
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.