Meta Developers

OVRAnchor Struct

Represents an anchor.

OVRAnchor extends IEquatable< OVRAnchor >.

OVRAnchor extends IDisposable.

See Also:

Overview

Public Types

enum	SaveResult { SaveResult.Success = Result.Success, SaveResult.Failure = Result.Failure, SaveResult.FailureInvalidAnchor = Result.Failure_HandleInvalid, SaveResult.FailureDataIsInvalid = Result.Failure_DataIsInvalid, SaveResult.FailureInsufficientResources = Result.Failure_SpaceInsufficientResources, SaveResult.FailureStorageAtCapacity = Result.Failure_SpaceStorageAtCapacity, SaveResult.FailureInsufficientView = Result.Failure_SpaceInsufficientView, SaveResult.FailurePermissionInsufficient = Result.Failure_SpacePermissionInsufficient, SaveResult.FailureRateLimited = Result.Failure_SpaceRateLimited, SaveResult.FailureTooDark = Result.Failure_SpaceTooDark, SaveResult.FailureTooBright = Result.Failure_SpaceTooBright, SaveResult.FailureUnsupported = Result.Failure_Unsupported, SaveResult.FailurePersistenceNotEnabled = Result.Failure_SpaceComponentNotEnabled }
enum	EraseResult { EraseResult.Success = Result.Success, EraseResult.Failure = Result.Failure, EraseResult.FailureInvalidAnchor = Result.Failure_HandleInvalid, EraseResult.FailureDataIsInvalid = Result.Failure_DataIsInvalid, EraseResult.FailureInsufficientResources = Result.Failure_SpaceInsufficientResources, EraseResult.FailurePermissionInsufficient = Result.Failure_SpacePermissionInsufficient, EraseResult.FailureRateLimited = Result.Failure_SpaceRateLimited, EraseResult.FailureUnsupported = Result.Failure_Unsupported, EraseResult.FailurePersistenceNotEnabled = Result.Failure_SpaceComponentNotEnabled }
enum	FetchResult { FetchResult.Success = Result.Success, FetchResult.Failure = Result.Failure, FetchResult.FailureDataIsInvalid = Result.Failure_DataIsInvalid, FetchResult.FailureInvalidOption = Result.Failure_InvalidParameter, FetchResult.FailureInsufficientResources = Result.Failure_SpaceInsufficientResources, FetchResult.FailureInsufficientView = Result.Failure_SpaceInsufficientView, FetchResult.FailurePermissionInsufficient = Result.Failure_SpacePermissionInsufficient, FetchResult.FailureRateLimited = Result.Failure_SpaceRateLimited, FetchResult.FailureTooDark = Result.Failure_SpaceTooDark, FetchResult.FailureTooBright = Result.Failure_SpaceTooBright, FetchResult.FailureUnsupported = Result.Failure_Unsupported }
enum	ShareResult { ShareResult.Success = Result.Success, ShareResult.Failure = Result.Failure, ShareResult.FailureHandleInvalid = Result.Failure_HandleInvalid, ShareResult.FailureDataIsInvalid = Result.Failure_DataIsInvalid, ShareResult.FailureNetworkTimeout = Result.Failure_SpaceNetworkTimeout, ShareResult.FailureNetworkRequestFailed = Result.Failure_SpaceNetworkRequestFailed, ShareResult.FailureMappingInsufficient = Result.Failure_SpaceMappingInsufficient, ShareResult.FailureLocalizationFailed = Result.Failure_SpaceLocalizationFailed, ShareResult.FailureSharableComponentNotEnabled = Result.Failure_SpaceComponentNotEnabled, ShareResult.FailureCloudStorageDisabled = Result.Failure_SpaceCloudStorageDisabled, ShareResult.FailureUnsupported = Result.Failure_Unsupported }

Static Fields

static readonly OVRAnchor	Null`[Get]`
static readonly Dictionary< DeferredKey, List< DeferredValue > >	_deferredTasks`[Get]`

Properties

ulong	Handle`[Get]`
Guid	Uuid`[Get]` Unique Identifier representing the anchor.

Static Public Member Functions

static OVRTask< TaskResult >	FetchAnchorsAsync ( List< OVRAnchor > anchors, FetchOptions options, Action< List< OVRAnchor >, int > incrementalResultsCallback ) Fetch anchors matching a query.
static OVRTask< OVRAnchor >	CreateSpatialAnchorAsync ( Pose trackingSpacePose ) Creates a new spatial anchor.
static OVRTask< OVRAnchor >	CreateSpatialAnchorAsync ( Transform transform, Camera centerEyeCamera ) Creates a new spatial anchor.
static OVRTask< OVRResult< SaveResult > >	SaveAsync ( IEnumerable< OVRAnchor > anchors ) Save a collection of anchors.
static OVRTask< OVRResult< EraseResult > >	EraseAsync ( IEnumerable< OVRAnchor > anchors, IEnumerable< Guid > uuids ) Erase a collection of anchors.
static unsafe OVRTask< OVRResult< EraseResult > >	EraseSpacesAsync ( int spaceCount, ulong * spaces, int uuidCount, Guid * uuids )
static OVRTask< OVRResult< ShareResult > >	ShareAsync ( IEnumerable< OVRAnchor > anchors, IEnumerable< OVRSpaceUser > users ) Share a collection of anchors with a collection of users.
static unsafe OVRTask< OVRResult< ShareResult > >	ShareSpacesAsync ( int spaceCount, ulong * spaces, int userCount, ulong * users )
static bool	operator== ( OVRAnchor lhs, OVRAnchor rhs )
static bool	operator!= ( OVRAnchor lhs, OVRAnchor rhs )
static OVRTask< bool >	FetchAnchorsAsync< T > ( IList< OVRAnchor > anchors, OVRSpace.StorageLocation location, int maxResults, double timeout ) (Obsolete) Asynchronous method that fetches anchors with a specific component.
static OVRTask< bool >	FetchAnchorsAsync ( IEnumerable< Guid > uuids, IList< OVRAnchor > anchors, OVRSpace.StorageLocation location, double timeout ) (Obsolete) Asynchronous method that fetches anchors with specifics uuids.

Public Member Functions

OVRTask< OVRResult< SaveResult > >	SaveAsync ( ) Save this anchor.
OVRTask< OVRResult< EraseResult > >	EraseAsync ( ) Erases this anchor.
OVRTask< OVRResult< ShareResult > >	ShareAsync ( IEnumerable< OVRSpaceUser > users ) Share this anchor with the specified users.
T	GetComponent< T > ( ) Gets the anchor's component of a specific type.
bool	TryGetComponent< T > ( out T component ) Tries to get the anchor's component of a specific type.
bool	SupportsComponent< T > ( ) Tests whether or not the anchor supports a specific type of component.
bool	GetSupportedComponents ( List< SpaceComponentType > components ) Get all the supported components of an anchor.
bool	Equals ( OVRAnchor other )
override bool	Equals ( object obj )
override int	GetHashCode ( )
override string	ToString ( )
void	Dispose ( ) Disposes of an anchor.

Details

Detailed Description

Scenes anchors are uniquely identified with their Uuid.

You may dispose of an anchor by calling their Dispose method.

Member Enumerations

enum OVRAnchor.SaveResult

Enumerator

Success	The operation succeeded.
Failure	The operation failed.
FailureInvalidAnchor	At least one anchor is invalid.
FailureDataIsInvalid	Invalid data.
FailureInsufficientResources	Resource limitation prevented this operation from executing.
FailureStorageAtCapacity	Operation could not be completed until resources used are reduced or storage expanded.
FailureInsufficientView	Insufficient view.
FailurePermissionInsufficient	Insufficient permission.
FailureRateLimited	Operation canceled due to rate limiting.
FailureTooDark	Too dark.
FailureTooBright	Too bright.
FailureUnsupported	Save is not supported.
FailurePersistenceNotEnabled	Persistence not enabled.

enum OVRAnchor.EraseResult

Enumerator

Success	The operation succeeded.
Failure	The operation failed.
FailureInvalidAnchor	At least one anchor is invalid.
FailureDataIsInvalid	Invalid data.
FailureInsufficientResources	Resource limitation prevented this operation from executing.
FailurePermissionInsufficient	Insufficient permission.
FailureRateLimited	Operation canceled due to rate limiting.
FailureUnsupported	Erase is not supported.
FailurePersistenceNotEnabled	Persistence not enabled.

enum OVRAnchor.FetchResult

Enumerator

Success	The operation succeeded.
Failure	The operation failed.
FailureDataIsInvalid	Invalid data.
FailureInvalidOption	One of the FetchOptions was invalid.
FailureInsufficientResources	Resource limitation prevented this operation from executing.
FailureInsufficientView	Insufficient view.
FailurePermissionInsufficient	Insufficient permission.
FailureRateLimited	Operation canceled due to rate limiting.
FailureTooDark	Too dark.
FailureTooBright	Too bright.
FailureUnsupported	Fetch is not supported.

enum OVRAnchor.ShareResult

Enumerator

Success	The operation succeeded.
Failure	The operation failed.
FailureHandleInvalid	Invalid handle.
FailureDataIsInvalid	Invalid data.
FailureNetworkTimeout	A network timeout occurred.
FailureNetworkRequestFailed	Network request failed.
FailureMappingInsufficient	The device has not built a sufficient map of the environment to share the anchor(s).
FailureLocalizationFailed	The device was not able to localize the anchor(s) being shared.
FailureSharableComponentNotEnabled	Sharable component not enabled on the anchor(s) being shared.
FailureCloudStorageDisabled	Sharing failed because device has not enabled the Share Point Cloud Data setting.
FailureUnsupported	Anchor Sharing is not supported.

Public Statics

readonly OVRAnchor OVRAnchor.Null
No description available.

readonly Dictionary<DeferredKey, List<DeferredValue> > OVRAnchor._deferredTasks
No description available.

Properties

ulong OVRAnchor.Handle
No description available.

Guid OVRAnchor.Uuid
Unique Identifier representing the anchor.

Static Member Functions

static OVRTask< TaskResult > OVRAnchor.FetchAnchorsAsync ( List< OVRAnchor > anchors, FetchOptions options, Action< List< OVRAnchor >, int > incrementalResultsCallback )
Fetch anchors matching a query. This method queries for anchors that match the corresponding options . This method is asynchronous; use the returned OVRTask<TResult> to check for completion. Anchors may be returned in batches. If incrementalResultsCallback is not null, then this delegate is invoked whenever results become available prior to the completion of the entire operation. New anchors are appended to anchors . The delegate receives a reference to anchors and the starting index of the anchors that have been added. The parameters are: anchors: The same List provided by anchors . index: The starting index of the newly available anchors Parameters anchors Container to store the results. The list is cleared before adding any anchors. options Options describing which anchors to fetch. incrementalResultsCallback (Optional) A callback invoked when incremental results are available. Returns An OVRTask<TResult> that can be used to track the asynchronous fetch. Exceptions ArgumentNullException Thrown if anchors is null.

static OVRTask< TaskResult > OVRAnchor.FetchAnchorsAsync
( List< OVRAnchor > anchors,
FetchOptions options,
Action< List< OVRAnchor >, int > incrementalResultsCallback )

Fetch anchors matching a query.

This method queries for anchors that match the corresponding options . This method is asynchronous; use the returned OVRTask<TResult> to check for completion.

Anchors may be returned in batches. If incrementalResultsCallback is not null, then this delegate is invoked whenever results become available prior to the completion of the entire operation. New anchors are appended to anchors . The delegate receives a reference to anchors and the starting index of the anchors that have been added. The parameters are:

anchors: The same List provided by anchors .
index: The starting index of the newly available anchors

Parameters

anchors

Container to store the results. The list is cleared before adding any anchors.

options

Options describing which anchors to fetch.

incrementalResultsCallback

(Optional) A callback invoked when incremental results are available.

Returns

An OVRTask<TResult> that can be used to track the asynchronous fetch.

Exceptions

ArgumentNullException

Thrown if anchors is null.

static OVRTask< OVRAnchor > OVRAnchor.CreateSpatialAnchorAsync ( Pose trackingSpacePose )
Creates a new spatial anchor. Spatial anchor creation is asynchronous. This method initiates a request to create a spatial anchor at trackingSpacePose . The returned OVRTask<TResult> can be awaited or used to track the completion of the request. If spatial anchor creation fails, the resulting OVRAnchor will be OVRAnchor.Null. Parameters trackingSpacePose The pose, in tracking space, at which you wish to create the spatial anchor. Returns A task which can be used to track completion of the request.

static OVRTask< OVRAnchor > OVRAnchor.CreateSpatialAnchorAsync
( Pose trackingSpacePose )

Creates a new spatial anchor.

Spatial anchor creation is asynchronous. This method initiates a request to create a spatial anchor at trackingSpacePose . The returned OVRTask<TResult> can be awaited or used to track the completion of the request.

If spatial anchor creation fails, the resulting OVRAnchor will be OVRAnchor.Null.

Parameters

trackingSpacePose

The pose, in tracking space, at which you wish to create the spatial anchor.

Returns

A task which can be used to track completion of the request.

static OVRTask< OVRAnchor > OVRAnchor.CreateSpatialAnchorAsync ( Transform transform, Camera centerEyeCamera )
Creates a new spatial anchor. Spatial anchor creation is asynchronous. This method initiates a request to create a spatial anchor at transform . The returned OVRTask<TResult> can be awaited or used to track the completion of the request. If spatial anchor creation fails, the resulting OVRAnchor will be OVRAnchor.Null. Parameters transform The transform at which you wish to create the spatial anchor. centerEyeCamera The Camera associated with the Meta Quest's center eye. Returns A task which can be used to track completion of the request. Exceptions ArgumentNullException Thrown when transform is null. ArgumentNullException Thrown when centerEyeCamera is null.

static OVRTask< OVRAnchor > OVRAnchor.CreateSpatialAnchorAsync
( Transform transform,
Camera centerEyeCamera )

Creates a new spatial anchor.

Spatial anchor creation is asynchronous. This method initiates a request to create a spatial anchor at transform . The returned OVRTask<TResult> can be awaited or used to track the completion of the request.

If spatial anchor creation fails, the resulting OVRAnchor will be OVRAnchor.Null.

Parameters

transform

The transform at which you wish to create the spatial anchor.

centerEyeCamera

The Camera associated with the Meta Quest's center eye.

Returns

A task which can be used to track completion of the request.

Exceptions

ArgumentNullException

Thrown when transform is null.

ArgumentNullException

Thrown when centerEyeCamera is null.

static OVRTask< OVRResult< SaveResult > > OVRAnchor.SaveAsync ( IEnumerable< OVRAnchor > anchors )
Save a collection of anchors. This method persists up to 32 anchors so that they may be retrieved later. This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation. Parameters anchors A collection of anchors to persist. Returns An awaitable OVRTask<TResult> representing the asynchronous request. See Also: FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>,int>), SaveAsync(), EraseAsync(IEnumerable<OVRAnchor>,IEnumerable<Guid>) Exceptions ArgumentException Thrown if anchors contains more than 32 anchors.

static OVRTask< OVRResult< SaveResult > > OVRAnchor.SaveAsync
( IEnumerable< OVRAnchor > anchors )

Save a collection of anchors.

This method persists up to 32 anchors so that they may be retrieved later.

This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation.

Parameters

anchors

A collection of anchors to persist.

Returns

An awaitable OVRTask<TResult> representing the asynchronous request.

Exceptions

ArgumentException

Thrown if anchors contains more than 32 anchors.

static OVRTask< OVRResult< EraseResult > > OVRAnchor.EraseAsync ( IEnumerable< OVRAnchor > anchors, IEnumerable< Guid > uuids )
Erase a collection of anchors. This method removes up to 32 anchors from persistent storage. This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation. Parameters anchors (Optional) A collection of anchors to remove from persistent storage. uuids (Optional) A collection of uuids to remove from persistent storage. Returns An awaitable OVRTask<TResult> representing the asynchronous request. Exceptions ArgumentException Thrown if both anchors and uuids are null. See Also: SaveAsync(IEnumerable<OVRAnchor>) Exceptions ArgumentException Thrown if the combined number of anchors and uuids is greater than 32.

static OVRTask< OVRResult< EraseResult > > OVRAnchor.EraseAsync
( IEnumerable< OVRAnchor > anchors,
IEnumerable< Guid > uuids )

Erase a collection of anchors.

This method removes up to 32 anchors from persistent storage.

This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation.

Parameters

anchors

(Optional) A collection of anchors to remove from persistent storage.

uuids

(Optional) A collection of uuids to remove from persistent storage.

Returns

An awaitable OVRTask<TResult> representing the asynchronous request.

Exceptions

ArgumentException

Thrown if both anchors and uuids are null.

See Also:

SaveAsync(IEnumerable<OVRAnchor>)

Exceptions

ArgumentException

Thrown if the combined number of anchors and uuids is greater than 32.

static unsafe OVRTask< OVRResult< EraseResult > > OVRAnchor.EraseSpacesAsync ( int spaceCount, ulong * spaces, int uuidCount, Guid * uuids )
No description available.

static OVRTask< OVRResult< ShareResult > > OVRAnchor.ShareAsync ( IEnumerable< OVRAnchor > anchors, IEnumerable< OVRSpaceUser > users )
Share a collection of anchors with a collection of users. This method shares a collection of anchors with a collection of users. This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation. Parameters anchors A collection of anchors to share. users A collection of users with whom anchors will be shared. Returns An awaitable OVRTask<TResult> representing the asynchronous request. Exceptions ArgumentNullException Thrown if anchors or users are null. ArgumentException Thrown if users count is less than one. See Also: ShareAsync(IEnumerable<OVRSpaceUser>)

static OVRTask< OVRResult< ShareResult > > OVRAnchor.ShareAsync
( IEnumerable< OVRAnchor > anchors,
IEnumerable< OVRSpaceUser > users )

Share a collection of anchors with a collection of users.

This method shares a collection of anchors with a collection of users.

This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation.

Parameters

anchors

A collection of anchors to share.

users

A collection of users with whom anchors will be shared.

Returns

An awaitable OVRTask<TResult> representing the asynchronous request.

Exceptions

ArgumentNullException

Thrown if anchors or users are null.

ArgumentException

Thrown if users count is less than one.

See Also:

ShareAsync(IEnumerable<OVRSpaceUser>)

static unsafe OVRTask< OVRResult< ShareResult > > OVRAnchor.ShareSpacesAsync ( int spaceCount, ulong * spaces, int userCount, ulong * users )
No description available.

static bool OVRAnchor.operator== ( OVRAnchor lhs, OVRAnchor rhs )
No description available.

static bool OVRAnchor.operator!= ( OVRAnchor lhs, OVRAnchor rhs )
No description available.

static OVRTask< bool > OVRAnchor.FetchAnchorsAsync< T > ( IList< OVRAnchor > anchors, OVRSpace.StorageLocation location, int maxResults, double timeout )
(Obsolete) Asynchronous method that fetches anchors with a specific component. Others T The type of component the fetched anchor must have. Parameters anchors IList that will get cleared and populated with the requested anchors. s Parameters location Storage location to query maxResults The maximum number of results the query can return timeout Timeout in seconds for the query. Deprecated This method is obsolete. Use FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>, int>) instead. Dispose of the returned OVRTask<T> if you don't use the results 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 System.ArgumentNullException Thrown if anchors is null.

static OVRTask< bool > OVRAnchor.FetchAnchorsAsync< T >
( IList< OVRAnchor > anchors,
OVRSpace.StorageLocation location,
int maxResults,
double timeout )

(Obsolete) Asynchronous method that fetches anchors with a specific component.

Others

The type of component the fetched anchor must have.

Parameters

anchors

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

Parameters

location

Storage location to query

maxResults

The maximum number of results the query can return

timeout

Timeout in seconds for the query.

Deprecated

This method is obsolete. Use FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>, int>) instead.

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

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

System.ArgumentNullException

Thrown if anchors is null.

static OVRTask< bool > OVRAnchor.FetchAnchorsAsync ( IEnumerable< Guid > uuids, IList< OVRAnchor > anchors, OVRSpace.StorageLocation location, double timeout )
(Obsolete) Asynchronous method that fetches anchors with specifics uuids. Parameters uuids Enumerable of uuids that anchors fetched must verify anchors IList that will get cleared and populated with the requested anchors. s Parameters location Storage location to query timeout Timeout in seconds for the query. Deprecated This method is obsolete. Use FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>, int>) instead. Dispose of the returned OVRTask<T> if you don't use the results 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 System.ArgumentNullException Thrown if uuids is null. System.ArgumentNullException Thrown if anchors is null.

static OVRTask< bool > OVRAnchor.FetchAnchorsAsync
( IEnumerable< Guid > uuids,
IList< OVRAnchor > anchors,
OVRSpace.StorageLocation location,
double timeout )

(Obsolete) Asynchronous method that fetches anchors with specifics uuids.

Parameters

uuids

Enumerable of uuids that anchors fetched must verify

anchors

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

Parameters

location

Storage location to query

timeout

Timeout in seconds for the query.

Deprecated

This method is obsolete. Use FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>, int>) instead.

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

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

System.ArgumentNullException

Thrown if uuids is null.

System.ArgumentNullException

Thrown if anchors is null.

Member Functions

OVRTask< OVRResult< SaveResult > > OVRAnchor.SaveAsync ( )
Save this anchor. This method persists the anchor so that it may be retrieved later, e.g., by using FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>,int>). This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation. NOTE: When saving multiple anchors, it is more efficient to save them in a batch using SaveAsync(IEnumerable<OVRAnchor>). Returns An awaitable OVRTask<TResult> representing the asynchronous request. See Also: FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>,int>), SaveAsync(IEnumerable<OVRAnchor>), EraseAsync()

OVRTask< OVRResult< SaveResult > > OVRAnchor.SaveAsync ( )

Save this anchor.

This method persists the anchor so that it may be retrieved later, e.g., by using FetchAnchorsAsync(List<OVRAnchor>,FetchOptions,Action<List<OVRAnchor>,int>).

This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation.

NOTE: When saving multiple anchors, it is more efficient to save them in a batch using SaveAsync(IEnumerable<OVRAnchor>).

Returns

An awaitable OVRTask<TResult> representing the asynchronous request.

OVRTask< OVRResult< EraseResult > > OVRAnchor.EraseAsync ( )
Erases this anchor. This method removes the anchor from persistent storage. Note this does not destroy the current instance. This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation. NOTE: When erasing multiple anchors, it is more efficient to erase them in a batch using EraseAsync(IEnumerable<OVRAnchor>,IEnumerable<Guid>). Returns An awaitable OVRTask<TResult> representing the asynchronous request. See Also: SaveAsync(), EraseAsync(IEnumerable<OVRAnchor>,IEnumerable<Guid>)

OVRTask< OVRResult< EraseResult > > OVRAnchor.EraseAsync ( )

Erases this anchor.

This method removes the anchor from persistent storage. Note this does not destroy the current instance.

This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation.

NOTE: When erasing multiple anchors, it is more efficient to erase them in a batch using EraseAsync(IEnumerable<OVRAnchor>,IEnumerable<Guid>).

Returns

An awaitable OVRTask<TResult> representing the asynchronous request.

OVRTask< OVRResult< ShareResult > > OVRAnchor.ShareAsync ( IEnumerable< OVRSpaceUser > users )
Share this anchor with the specified users. This method shares the anchor with a collection of OVRSpaceUser. This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation. Parameters users A collection of users with whom anchors will be shared. Returns An awaitable OVRTask<TResult> representing the asynchronous request. Exceptions ArgumentNullException Thrown if users is null. ArgumentException Thrown if users count is less than one. See Also: ShareAsync(IEnumerable<OVRAnchor>)

OVRTask< OVRResult< ShareResult > > OVRAnchor.ShareAsync
( IEnumerable< OVRSpaceUser > users )

Share this anchor with the specified users.

This method shares the anchor with a collection of OVRSpaceUser.

This operation is asynchronous. Use the returned OVRTask<TResult> to track the result of the asynchronous operation.

Parameters

users

A collection of users with whom anchors will be shared.

Returns

An awaitable OVRTask<TResult> representing the asynchronous request.

Exceptions

ArgumentNullException

Thrown if users is null.

ArgumentException

Thrown if users count is less than one.

See Also:

ShareAsync(IEnumerable<OVRAnchor>)

T OVRAnchor.GetComponent< T > ( )
Gets the anchor's component of a specific type. Others T The type of the component. Returns The requested component. Make sure the anchor supports the specified type of component using SupportsComponent<T> Exceptions InvalidOperationException Thrown if the anchor doesn't support the specified type of component. See Also: TryGetComponent<T>, SupportsComponent<T>

bool OVRAnchor.TryGetComponent< T > ( out T component )
Tries to get the anchor's component of a specific type. Parameters component The requested component, as an out parameter. Others T The type of the component. Returns Whether or not the request succeeded. It may fail if the anchor doesn't support this type of component. See Also: GetComponent<T>

bool OVRAnchor.SupportsComponent< T > ( )
Tests whether or not the anchor supports a specific type of component. For performance reasons, we use xrGetSpaceComponentStatusFB, which can result in an error in the logs when the component is not available. This error does not have impact on the control flow. The alternative method, See Also: GetSupportedComponents(List<SpaceComponentType>) avoids this error reporting, but does have performance constraints. Others T The type of the component. Returns Whether or not the specified type of component is supported.

bool OVRAnchor.SupportsComponent< T > ( )

Tests whether or not the anchor supports a specific type of component.

For performance reasons, we use xrGetSpaceComponentStatusFB, which can result in an error in the logs when the component is not available.

This error does not have impact on the control flow. The alternative method,

avoids this error reporting, but does have performance constraints.

Others

The type of the component.

Returns

Whether or not the specified type of component is supported.

bool OVRAnchor.GetSupportedComponents ( List< SpaceComponentType > components )
Get all the supported components of an anchor. Parameters components The list to populate with the supported components. The list is cleared first. Returns True if the supported components could be retrieved, otherwise False.

bool OVRAnchor.Equals ( OVRAnchor other )
No description available.

override bool OVRAnchor.Equals ( object obj )
No description available.

override int OVRAnchor.GetHashCode ( )
No description available.

override string OVRAnchor.ToString ( )
No description available.

void OVRAnchor.Dispose ( )
Disposes of an anchor. Calling this method will destroy the anchor so that it won't be managed by internal systems until the next time it is fetched again.

Did you find this page helpful?