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

Options Struct

Represents options used to generate an OVRSpaceQuery.

Overview

Static Fields

static const int
The maximum number of UUIDs which can be used in a UuidFilter.

Properties

int
The maximum number of results the query can return.
double
Timeout[Get]
The timeout, in seconds for the query.
The storage location to query.
OVRPlugin.SpaceQueryType
The type of query to perform.
OVRPlugin.SpaceQueryActionType
The type of action to perform.
OVRPlugin.SpaceComponentType
The components which must be present on the space in order to match the query.
IEnumerable< Guid >
A set of UUIDs used to filter the query.

Public Member Functions

Options
( Options other )
Creates a copy of other .
OVRPlugin.SpaceQueryInfo
Creates a new OVRPlugin.SpaceQueryInfo from this.
bool
TryQuerySpaces
( out ulong requestId )
Initiates a space query.

Details

Public Statics

const int OVRSpaceQuery.Options.MaxUuidCount
The maximum number of UUIDs which can be used in a UuidFilter.

Properties

int OVRSpaceQuery.Options.MaxResults
The maximum number of results the query can return.
double OVRSpaceQuery.Options.Timeout
The timeout, in seconds for the query.
Zero indicates the query does not timeout.
OVRSpace.StorageLocation OVRSpaceQuery.Options.Location
The storage location to query.
OVRPlugin.SpaceQueryType OVRSpaceQuery.Options.QueryType
The type of query to perform.
OVRPlugin.SpaceQueryActionType OVRSpaceQuery.Options.ActionType
The type of action to perform.
OVRPlugin.SpaceComponentType OVRSpaceQuery.Options.ComponentFilter
The components which must be present on the space in order to match the query.
The query will be limited to spaces that have this set of components. You may filter by component type or UUID (see UuidFilter), but not both at the same time.
Currently, only one component is allowed at a time.
Exceptions
InvalidOperationException
Thrown if UuidFilter is not null.
IEnumerable<Guid> OVRSpaceQuery.Options.UuidFilter
A set of UUIDs used to filter the query.
The query will look for this set of UUIDs and only return matching UUIDs up to MaxResults. You may filter by component type (see ComponentFilter) or UUIDs, but not both at the same time.
Exceptions
InvalidOperationException
Thrown if ComponentFilter is not 0.
ArgumentException
Thrown if UuidFilter is set to a value that contains more than
See Also:
MaxUuidCount
UUIDs.

Member Functions

OVRSpaceQuery.Options.Options
( Options other )
Creates a copy of other .
Parameters
other
The options to copy.
OVRPlugin.SpaceQueryInfo OVRSpaceQuery.Options.ToQueryInfo ( )
Creates a new OVRPlugin.SpaceQueryInfo from this.
Returns
The newly created info.
bool OVRSpaceQuery.Options.TryQuerySpaces
( out ulong requestId )
Initiates a space query.
Parameters
requestId
When this method returns, requestId will represent a valid request if successful, or an invalid request if not. This parameter is passed initialized.
Returns
true if the query was successfully started; otherwise, false.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon