Share via

Class AnchorLocateCriteria

  • Article

Declaration

struct winrt::Microsoft::Azure::SpatialAnchors::AnchorLocateCriteria

Description

Specifies a set of criteria for locating anchors.

Remarks

Within the object, the properties Identifiers, NearAnchor, and NearDevice help specify which anchors should be found. BypassCache and Strategy help specify how anchors should be found, while RequestedCategories helps specify the type of data requested. Identifiers, NearAnchor, and NearDevice properties work exclusive of each other, and only one of them should be provided. Properties for exactly ONE of either Identifiers, NearAnchor, or NearDevice is required. Providing none or more than one is prohibited. See "How-to" and "Concepts" pages for more information and examples.

Properties

BypassCache

Whether locate should bypass the local cache of anchors.

bool BypassCache();
void BypassCache(bool const& value);

Identifiers

Indicates the CloudSpatialAnchor identifiers to locate. Maximum limit of 35 anchors per watcher. Any anchors within this list will match this criteria.

com_array<hstring> Identifiers();
void Identifiers(array_view<hstring const> value);

NearAnchor

Indicates that anchors to locate should be close to a specific anchor.

winrt::Microsoft::Azure::SpatialAnchors::NearAnchorCriteria NearAnchor();
void NearAnchor(winrt::Microsoft::Azure::SpatialAnchors::NearAnchorCriteria const& value);

NearDevice

Indicates that anchors to locate should be close to the device. Any enabled sensors will be used to help discover anchors around your device. To have the best chance of finding anchors, you should configure the SensorCapabilities to give the session access to all appropriate sensors.

winrt::Microsoft::Azure::SpatialAnchors::NearDeviceCriteria NearDevice();
void NearDevice(winrt::Microsoft::Azure::SpatialAnchors::NearDeviceCriteria const& value);

RequestedCategories

Categories of data that are requested.

winrt::Microsoft::Azure::SpatialAnchors::AnchorDataCategory RequestedCategories();
void RequestedCategories(winrt::Microsoft::Azure::SpatialAnchors::AnchorDataCategory const& value);

Strategy

Indicates the strategy by which anchors will be located.

winrt::Microsoft::Azure::SpatialAnchors::LocateStrategy Strategy();
void Strategy(winrt::Microsoft::Azure::SpatialAnchors::LocateStrategy const& value);