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

Options Struct

Represents options used to generate an OVRSpaceQuery.

Constructors

Options ( other )
Creates a copy of other .
Signature
OVRSpaceQuery.Options.Options(Options other)
Parameters
other: Options  The options to copy.

Static Fields

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

Properties

ActionType : OVRPlugin.SpaceQueryActionType
[Get][Set]
The type of action to perform.
Signature
OVRPlugin.SpaceQueryActionType OVRSpaceQuery.Options.ActionType
ComponentFilter : OVRPlugin.SpaceComponentType
[Get][Set]
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.
Signature
OVRPlugin.SpaceComponentType OVRSpaceQuery.Options.ComponentFilter
[Get][Set]
The storage location to query.
Signature
OVRSpace.StorageLocation OVRSpaceQuery.Options.Location
MaxResults : int
[Get][Set]
The maximum number of results the query can return.
Signature
int OVRSpaceQuery.Options.MaxResults
QueryType : OVRPlugin.SpaceQueryType
[Get][Set]
The type of query to perform.
Signature
OVRPlugin.SpaceQueryType OVRSpaceQuery.Options.QueryType
Timeout : double
[Get][Set]
The timeout, in seconds for the query.
Zero indicates the query does not timeout.
Signature
double OVRSpaceQuery.Options.Timeout
UuidFilter : IEnumerable< Guid >
[Get][Set]
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.
Signature
IEnumerable<Guid> OVRSpaceQuery.Options.UuidFilter

Methods

ToQueryInfo ()
Creates a new OVRPlugin.SpaceQueryInfo from this.
Signature
OVRPlugin.SpaceQueryInfo OVRSpaceQuery.Options.ToQueryInfo()
Returns
OVRPlugin.SpaceQueryInfo  The newly created info.
TryQuerySpaces ( requestId )
Initiates a space query.
Signature
bool OVRSpaceQuery.Options.TryQuerySpaces(out ulong requestId)
Parameters
requestId: out ulong  When this method returns, requestId will represent a valid request if successful, or an invalid request if not. This parameter is passed initialized.
Returns
bool true if the query was successfully started; otherwise, false.