reckfellENGINE

OpenXRSpatialMarkerTrackingCapability

Implementation for handling spatial entity marker tracking logic.

On this page
class OpenXRSpatialMarkerTrackingCapabilityReckfellSharpInherits OpenXRExtensionWrapper

Implementation for handling spatial entity marker tracking logic.

This class handles the OpenXR marker tracking spatial entity extension.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

OpenXRSpatialMarkerTrackingCapabilityConstructor
# OpenXRSpatialMarkerTrackingCapability
C#
public OpenXRSpatialMarkerTrackingCapability();

Methods9

DoEntityUpdatevoid
# DoEntityUpdate
C#
public void DoEntityUpdate(Rid spatialContext, Reckfell.Collections.Array<OpenXRSpatialComponentData> componentData, OpenXRStructureBase nextSnapshotCreate = null, OpenXRStructureBase nextSnapshotQuery = null);

Calls OpenXRSpatialEntityExtension.UpdateSpatialEntities and OpenXRSpatialEntityExtension.QuerySnapshot with the marker entities associated with spatial_context. component_data are the OpenXRSpatialComponentDatas to update for this marker capability. If next_snapshot_create is non-null, then pass this to the next parameter in OpenXRSpatialEntityExtension.UpdateSpatialEntities. If next_snapshot_query is non-null, then pass this to the next parameter in OpenXRSpatialEntityExtension.QuerySnapshot.

Parameters
NameTypeDefault
spatialContextRid—
componentDataReckfell.Collections.Array<OpenXRSpatialComponentData>—
nextSnapshotCreateOpenXRStructureBasenull
nextSnapshotQueryOpenXRStructureBasenull
GetBuiltInTrackingStateOpenXRSpatialEntityExtension.TrackingState
# GetBuiltInTrackingState
C#
public OpenXRSpatialEntityExtension.TrackingState GetBuiltInTrackingState();

Returns the state of the built-in tracking system.

Returns OpenXRSpatialEntityExtension.TrackingState
IsAprilTagSupportedbool
# IsAprilTagSupported
C#
public bool IsAprilTagSupported();

Returns true if April tag marker tracking is supported by the current device.

Returns bool
IsArucoSupportedbool
# IsArucoSupported
C#
public bool IsArucoSupported();

Returns true if ArUco marker tracking is supported by the current device.

Returns bool
IsMicroQrcodeSupportedbool
# IsMicroQrcodeSupported
C#
public bool IsMicroQrcodeSupported();

Returns true if micro QR code marker tracking is supported by the current device.

Returns bool
IsQrcodeSupportedbool
# IsQrcodeSupported
C#
public bool IsQrcodeSupported();

Returns true if QR code marker tracking is supported by the current device.

Returns bool
StartBuiltInTrackingbool
# StartBuiltInTracking
C#
public bool StartBuiltInTracking(OpenXRSpatialMarkerTrackingCapability.MarkerTypeFlags markerTypes);

Starts the built-in marker tracking logic for the specified marker types. This will fail if built-in tracking is already enabled.

Parameters
NameTypeDefault
markerTypesOpenXRSpatialMarkerTrackingCapability.MarkerTypeFlags—
Returns bool
StartEntityDiscoveryOpenXRFutureResult
# StartEntityDiscovery
C#
public OpenXRFutureResult StartEntityDiscovery(Rid spatialContext, Reckfell.Collections.Array<OpenXRSpatialComponentData> componentData, OpenXRStructureBase nextSnapshotCreate = null, OpenXRStructureBase nextSnapshotQuery = null, Callable userCallback = default);

Calls OpenXRSpatialEntityExtension.DiscoverSpatialEntities and OpenXRSpatialEntityExtension.QuerySnapshot with the marker entities associated with spatial_context. component_data are the OpenXRSpatialComponentDatas to discover for this marker capability. If next_snapshot_create is non-null, then pass this to the next parameter in OpenXRSpatialEntityExtension.DiscoverSpatialEntities. If next_snapshot_query is non-null, then pass this to the next parameter in OpenXRSpatialEntityExtension.QuerySnapshot. user_callback, when non-null, is called with two parameters usually twice. The first parameter is the Rid of the discovery snapshot and the second parameter is a boolean where false indicates the discovery snapshot is about to be processed, and true indicates the discovery snapshot has been processed and component_data has valid data. The second call is skipped if an error was encountered. The returned OpenXRFutureResult is identical to the return from OpenXRSpatialEntityExtension.DiscoverSpatialEntities.

Parameters
NameTypeDefault
spatialContextRid—
componentDataReckfell.Collections.Array<OpenXRSpatialComponentData>—
nextSnapshotCreateOpenXRStructureBasenull
nextSnapshotQueryOpenXRStructureBasenull
userCallbackCallabledefault
Returns OpenXRFutureResult
StopBuiltInTrackingvoid
# StopBuiltInTracking
C#
public void StopBuiltInTracking(bool clearTrackers = true);

Stops the built-in marker tracking logic.

Parameters
NameTypeDefault
clearTrackersbooltrue

OpenXRSpatialMarkerTrackingCapability.MarkerTypeFlags

ValueDescription
AprilTag = 8

April tag.

Aruco = 4

ArUco marker.

MicroQrCode = 2

Micro QR Code.

QrCode = 1

QR Code.

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.