Skip to content
Download
API reference

OpenXRSpatialComponentMarkerList

Inherits: OpenXRSpatialComponentData < Shared < Object

Object for storing the queries marker result data.

Object for storing the queries marker result data when calling OpenXRSpatialEntityExtension.query_snapshot().

ReturnsMethod
Variantget_marker_data(snapshot, index)
intget_marker_id(index)
OpenXRSpatialComponentMarkerList.MarkerTypeget_marker_type(index)

  • MARKER_TYPE_UNKNOWN = 0 — Unknown or unset marker type.

  • MARKER_TYPE_QRCODE = 1 — Marker based on a QR code.

  • MARKER_TYPE_MICRO_QRCODE = 2 — Marker based on a micro QR code.

  • MARKER_TYPE_ARUCO = 3 — Marker based on an Aruco code.

  • MARKER_TYPE_APRIL_TAG = 4 — Marker based on an April Tag.

  • MARKER_TYPE_MAX = 5 — Maximum value for this enum.

Variant get_marker_data(snapshot: RID, index: int) const

Returns either a String or a []u8 buffer with data for the marker at this index. Only applicable for QR code markers.

int get_marker_id(index: int) const

Returns the marker ID for the marker at this index. Only applicable for Aruco or April Tag markers.

OpenXRSpatialComponentMarkerList.MarkerType get_marker_type(index: int) const

Returns the marker type for the marker at this index.