Skip to main content
Version: 14 Oct 2024

TrackerSettings

Public Methods

TrackerSettings Create

public static TrackerSettings Create(
bool enableMarkerScanning =false,
MarkerType markerTypes =MarkerType.None,
float qRCodeSize =0.1f,
ArucoDictionaryName arucoDicitonary =ArucoDictionaryName.DICT_5X5_100,
float arucoMarkerSize =0.1f,
Profile profile =Profile.Default,
CustomProfile customProfile =default
)

Parameters

TypeNameDescription
boolenableMarkerScanning
MarkerTypemarkerTypesRepresents the different marker types supported by the API
floatqRCodeSize
ArucoDictionaryNamearucoDicitonarySupported pre-defined ArUco dictionary and AprilTags. Marker Tracker supports pre-defined ArUco dictionary and AprilTags. ArUco dictionaries can be looked up and markers can be generated for them here: http://chev.me/arucogen/ Note: Due to 4X4 dictionaries suffering from frequent false detections, we discourage their use.
floatarucoMarkerSize
ProfileprofileRepresents the different tracker profiles used to optimize marker tracking in difference use cases.
CustomProfilecustomProfile

override string ToString

public override string ToString()

Public Attributes

ArucoDicitonary

Aruco dictionary to use.


public ArucoDictionaryName ArucoDicitonary;

TypeDescription
ArucoDictionaryNameSupported pre-defined ArUco dictionary and AprilTags. Marker Tracker supports pre-defined ArUco dictionary and AprilTags. ArUco dictionaries can be looked up and markers can be generated for them here: http://chev.me/arucogen/ Note: Due to 4X4 dictionaries suffering from frequent false detections, we discourage their use.

ArucoMarkerSize

Aruco marker size to use (in meters).


public float ArucoMarkerSize;


CustomTrackerProfile

The custom tracker profile to be used if the TrackerProfile member is set to Custom.


public CustomProfile CustomTrackerProfile;


EnableMarkerScanning

If true , Marker Scanner will detect markers and track QR codes. Marker Scanner should be disabled when app is paused and enabled when app resumes. When enabled, Marker Scanner will gain access to the camera and start scanning markers. When disabled Marker Scanner will release the camera and stop scanning markers. Internal state of the scanner will be maintained.


public bool EnableMarkerScanning;


MarkerTypes

The marker types that are enabled for this scanner. Enable markers by combining any number of MarkerType flags using '|' (bitwise 'or').


public MarkerType MarkerTypes;

TypeDescription
MarkerTypeRepresents the different marker types supported by the API

QRCodeSize

The physical size of the QR code that shall be tracked (in meters). The physical size is important to know, because once a QR code is detected we can only determine its 3D position when we know its correct size. The size of the QR code is given in meters and represents the length of one side of the square code(without the outer margin). Min size: As a rule of thumb the size of a QR code should be at least a 10th of the distance you intend to scan it with a camera device. Higher version markers with higher information density might need to be larger than that to be detected reliably. Max size: Our camera needs to see the whole marker at once. If it's too large, we won't detect it.


public float QRCodeSize;


TrackerProfile

Tracker profile to be used.


public Profile TrackerProfile;

TypeDescription
ProfileRepresents the different tracker profiles used to optimize marker tracking in difference use cases.