Skip to main content
Version: 20 Mar 2024

MLSpatialAnchorQueryFilter

Module: Magic Leap Spaces / Spatial Anchor

A collection of filters for Spatial Anchor queries. More...

#include <ml_spatial_anchor.h>

Public Attributes

TypeName
uint32_tversion
Version of the structure.
MLVec3fcenter
The center point of where a spatial query will originate.
floatradius_m
The radius in meters used for a spatial query, relative to the specified center.
const MLUUID *ids
A list of Spatial Anchor IDs to query for.
uint32_tids_count
The number of IDs provided.
uint32_tmax_results
The upper bound of expected results.
boolsorted
Indicate whether the results will be returned sorted by distance from center.

Detailed Description

struct MLSpatialAnchorQueryFilter;

A collection of filters for Spatial Anchor queries.

Filters that have been set will be combined via logical conjunction. E.g. results must match the ids filter AND fall within the radius constraint when both have been set.

This struct must be initialized by calling MLSpatialAnchorQueryFilterInit before use.

API Level:

  • 20

Public Attributes Documentation

version

uint32_t version;

Version of the structure.


center

MLVec3f center;

The center point of where a spatial query will originate.


radius_m

float radius_m;

The radius in meters used for a spatial query, relative to the specified center.

Only anchors inside this radius will be returned. Set to 0 for unbounded results.


ids

const MLUUID * ids;

A list of Spatial Anchor IDs to query for.


ids_count

uint32_t ids_count;

The number of IDs provided.


max_results

uint32_t max_results;

The upper bound of expected results.

Set to 0 for unbounded results.


sorted

bool sorted;

Indicate whether the results will be returned sorted by distance from center.

Sorting results by distance will incur a performance penalty.