documentation

vlSDK.h
Go to the documentation of this file.
1 // Copyright (c) Visometry GmbH.
2 
17 #ifndef VL_SDK_H
18 #define VL_SDK_H
19 
20 #include "vlSDKDef.h"
21 #include "vlSDKVersion.h"
22 
23 struct vlAbstractApplicationWrapper_s;
30 typedef struct vlAbstractApplicationWrapper_s vlAbstractApplicationWrapper_t;
31 
32 struct vlImageWrapper_s;
39 typedef struct vlImageWrapper_s vlImageWrapper_t;
40 
41 struct vlExtrinsicDataWrapper_s;
48 typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t;
49 
50 struct vlSimilarityTransformWrapper_s;
57 typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t;
58 
59 struct vlIntrinsicDataWrapper_s;
66 typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t;
67 
68 struct vlWorker_s;
75 typedef struct vlWorker_s vlWorker_t;
76 
80 typedef enum
81 {
94 } vlLogLevel;
95 
99 typedef enum
100 {
101  VL_RENDER_ROTATION_CCW_0 = 0,
102  VL_RENDER_ROTATION_CCW_90 = 2,
103  VL_RENDER_ROTATION_CCW_180 = 1,
104  VL_RENDER_ROTATION_CCW_270 = 3,
106 
110 typedef enum
111 {
120 } vlImageFormat;
121 
130 typedef void (VL_CALLINGCONVENTION *vlCallbackZString)(
131  const char data[], void* clientData);
132 
146 typedef void (VL_CALLINGCONVENTION *vlCallbackJsonString)(
147  const char error[], const char data[], void* clientData);
148 
164 typedef void (VL_CALLINGCONVENTION *vlCallbackJsonAndBinaryString)(
165  const char description[], const char data[], unsigned int size,
166  void* clientData);
167 
179 typedef void (VL_CALLINGCONVENTION *vlCallbackImageWrapper)(
180  vlImageWrapper_t* image, void* clientData);
181 
194 typedef void (VL_CALLINGCONVENTION *vlCallbackExtrinsicDataWrapper)(
195  vlExtrinsicDataWrapper_t* extrinsicData, void* clientData);
196 
209 typedef void (VL_CALLINGCONVENTION *vlCallbackSimilarityTransformWrapper)(
210  vlSimilarityTransformWrapper_t* similarityTransform, void* clientData);
211 
224 typedef void (VL_CALLINGCONVENTION *vlCallbackIntrinsicDataWrapper)(
225  vlIntrinsicDataWrapper_t* intrinsicData, void* clientData);
226 
227 #ifdef __cplusplus
228 extern "C"
229 {
230 #endif // __cplusplus
231 
242  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMajor();
243 
248  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMinor();
249 
254  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionRevision();
263  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionString(
264  char version[], unsigned int maxSize);
265 
274  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionHashString(
275  char version[], unsigned int maxSize);
276 
285  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionTimestampString(
286  char versionTimeStamp[], unsigned int maxSize);
287 
301  VL_SDK_API bool VL_CALLINGCONVENTION vlGetHostId(
302  char hostIdBuffer[], unsigned int maxSize);
303 
317  VL_SDK_API bool VL_CALLINGCONVENTION vlGetBundleId(
318  char bundleIdBuffer[], unsigned int maxSize);
319 
330  VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener(
331  vlCallbackZString fn, void* clientData);
332 
341  VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener(
342  vlCallbackZString fn, void* clientData);
343 
350  VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners();
351 
367  VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer();
368 
382  VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer();
383 
395  VL_SDK_API void VL_CALLINGCONVENTION vlSetLogBufferSize(
396  unsigned int maxEntries);
397 
413  VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer();
414 
422  VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel();
423 
438  VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel(int level);
439 
449  VL_SDK_API bool VL_CALLINGCONVENTION vlLog(
450  const char message[], int level);
451 
470  VL_SDK_API vlAbstractApplicationWrapper_t* VL_CALLINGCONVENTION
472 
480  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_AbstractApplicationWrapper(
481  vlAbstractApplicationWrapper_t* abstractApplicationWrapper);
482 
493  VL_SDK_API bool VL_CALLINGCONVENTION
495  vlAbstractApplicationWrapper_t* abstractApplicationWrapper);
496 
508  VL_SDK_API bool VL_CALLINGCONVENTION
510  vlAbstractApplicationWrapper_t* abstractApplicationWrapper);
511 
527  VL_SDK_API bool VL_CALLINGCONVENTION
529  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
530  char hostID[], unsigned int maxSize);
531 
548  VL_SDK_API bool VL_CALLINGCONVENTION
550  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
551  char bundleID[], unsigned int maxSize);
552 
567  VL_SDK_API bool VL_CALLINGCONVENTION
569  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
570  const char *licenseFilePath);
571 
588  VL_SDK_API bool VL_CALLINGCONVENTION
590  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
591  const char *licenseFileData);
592 
608  VL_SDK_API bool VL_CALLINGCONVENTION
610  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
611  char licenseInfo[], unsigned int maxSize);
612 
629  VL_SDK_API bool VL_CALLINGCONVENTION
631  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
632  const char pluginPath[]);
633 
649  VL_SDK_API bool VL_CALLINGCONVENTION
651  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
652  char trackerType[], unsigned int maxSize);
653 
665  VL_SDK_API bool VL_CALLINGCONVENTION
667  vlAbstractApplicationWrapper_t* abstractApplicationWrapper);
668 
681  VL_SDK_API bool VL_CALLINGCONVENTION
683  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
684  const char filename[]);
685 
701  VL_SDK_API bool VL_CALLINGCONVENTION
703  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
704  const char str[], const char fakeFilename[]);
705 
714  VL_SDK_API bool VL_CALLINGCONVENTION
716  vlAbstractApplicationWrapper_t* abstractApplicationWrapper);
717 
760  VL_SDK_API bool VL_CALLINGCONVENTION
762  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
763  char buffer[], unsigned int maxSize);
764 
787  VL_SDK_API bool VL_CALLINGCONVENTION
789  vlAbstractApplicationWrapper_t* abstractApplicationWrapper,
790  const char uri[]);
791 
812  VL_SDK_API bool VL_CALLINGCONVENTION
814  vlAbstractApplicationWrapper_t* abstractApplicationWrapper);
815 
832  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlNew_ImageWrapper(vlImageFormat imageFormat);
833 
842  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
843  vlImageWrapper_Clone(vlImageWrapper_t* imageWrapper);
844 
854  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper(
855  vlImageWrapper_t* imageWrapper);
856 
865  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat(
866  vlImageWrapper_t* imageWrapper);
867 
875  VL_SDK_API unsigned int VL_CALLINGCONVENTION
877  vlImageWrapper_t* imageWrapper);
878 
886  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth(
887  vlImageWrapper_t* imageWrapper);
888 
896  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight(
897  vlImageWrapper_t* imageWrapper);
898 
899 
915  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyToBuffer(
916  vlImageWrapper_t* imageWrapper,
917  unsigned char buffer[], unsigned int bufferSize);
918 
936  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBuffer(
937  vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
938  unsigned int width, unsigned int height);
939 
956  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBufferWithFormat(
957  vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
958  unsigned int width, unsigned int height,vlImageFormat imageFormat);
959 
978  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper();
979 
988  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
990 
1000  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(
1001  vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
1002 
1012  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid(
1013  vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
1014 
1024  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetValid(
1025  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, bool value);
1026 
1049  VL_SDK_API bool VL_CALLINGCONVENTION
1051  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float matrix[],
1052  unsigned int matrixElementCount);
1053 
1070  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetT(
1071  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float t[],
1072  unsigned int elementCount);
1073 
1090  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetT(
1091  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float t[],
1092  unsigned int elementCount);
1093 
1110  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR(
1111  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float q[],
1112  unsigned int elementCount);
1113 
1130  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetR(
1131  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float q[],
1132  unsigned int elementCount);
1133 
1150  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetCamPosWorld(
1151  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float t[],
1152  unsigned int elementCount);
1153 
1170  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetCamPosWorld(
1171  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float t[],
1172  unsigned int elementCount);
1173 
1191  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION vlNew_SimilarityTransformWrapper();
1192 
1201  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
1203 
1213  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper(
1214  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
1215 
1225  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid(
1226  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
1227 
1237  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(
1238  vlSimilarityTransformWrapper_t* similarityTransformWrapper, bool value);
1239 
1254  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetT(
1255  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float t[],
1256  unsigned int elementCount);
1257 
1272  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetT(
1273  vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float t[],
1274  unsigned int elementCount);
1275 
1290  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetR(
1291  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float q[],
1292  unsigned int elementCount);
1293 
1308  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetR(
1309  vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float q[],
1310  unsigned int elementCount);
1311 
1323  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetS(
1324  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float s);
1325 
1336  VL_SDK_API float VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetS(
1337  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
1338 
1357  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper();
1358 
1367  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1369 
1379  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(
1380  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1381 
1389  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth(
1390  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1391 
1401  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetWidth(
1402  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, unsigned int value);
1403 
1411  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetHeight(
1412  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1413 
1423  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetHeight(
1424  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, unsigned int value);
1436  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFxNorm(
1437  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1438 
1449  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFxNorm(
1450  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1451 
1463  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm(
1464  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1465 
1476  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFyNorm(
1477  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1488  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetSkewNorm(
1489  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1490 
1500  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetSkewNorm(
1501  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1502 
1513  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm(
1514  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1515 
1526  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCxNorm(
1527  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1538  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm(
1539  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1540 
1551  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCyNorm(
1552  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1553 
1564  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrated(
1565  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1566 
1576  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCalibrated(
1577  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, bool value);
1578 
1589  VL_SDK_API double VL_CALLINGCONVENTION
1591  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1592 
1604  VL_SDK_API bool VL_CALLINGCONVENTION
1606  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double k[],
1607  unsigned int elementCount);
1608 
1620  VL_SDK_API bool VL_CALLINGCONVENTION
1622  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, const double k[],
1623  unsigned int elementCount);
1624 
1664  VL_SDK_API bool VL_CALLINGCONVENTION
1666  vlIntrinsicDataWrapper_t* intrinsicDataWrapper,
1667  float nearFact, float farFact, unsigned int screenWidth,
1668  unsigned int screenHeight, unsigned int renderRotation,
1669  unsigned int mode, float matrix[], unsigned int matrixElementCount);
1670 
1689  VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_Worker(
1691 
1708  VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_SyncWorker(
1710 
1717  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t* worker);
1718 
1726  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Start(vlWorker_t* worker);
1727 
1735  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Stop(vlWorker_t* worker);
1736 
1749  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RunOnceSync(
1750  vlWorker_t* worker);
1751 
1773  VL_SDK_API bool VL_CALLINGCONVENTION
1774  vlWorker_AddCameraCalibrationDB(vlWorker_t* worker, const char uri[]);
1775 
1795  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ResetCameraCalibrationDB(vlWorker_t* worker);
1796 
1813  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonCommandSync(
1814  vlWorker_t* worker, const char jsonString[],
1815  vlCallbackJsonString callback, void* clientData);
1816 
1838  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonAndBinaryCommandSync(
1839  vlWorker_t* worker,
1840  const char jsonString[],
1841  const char data[],
1842  unsigned int size,
1844  void* clientData);
1845 
1885  VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetDeviceInfo(vlWorker_t* worker);
1886 
1900  VL_SDK_API bool VL_CALLINGCONVENTION
1901  vlWorker_SetLicenseFilePath(vlWorker_t* worker, const char licenseFilePath[]);
1902 
1918  VL_SDK_API bool VL_CALLINGCONVENTION
1919  vlWorker_SetLicenseFileData(vlWorker_t* worker, const char licenseFileData[]);
1920 
1932  VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetLicenseInformation(
1933  vlWorker_t* worker);
1934 
1944  VL_SDK_API bool VL_CALLINGCONVENTION
1945  vlWorker_LoadPlugin(vlWorker_t* worker, const char pluginName[]);
1946 
1963  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlWorker_GetImageSync(
1964  vlWorker_t* worker);
1965 
1983  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1985  vlWorker_t* worker, const char* image_name);
1986 
1987 
2005  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
2006  vlWorker_GetNodeImageSync(vlWorker_t* worker, const char node[], const char key[]);
2007 
2023  VL_SDK_API bool VL_CALLINGCONVENTION
2024  vlWorker_SetNodeImageSync(vlWorker_t* worker, vlImageWrapper_t* image, const char node[], const char key[]);
2025 
2043  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
2045  vlWorker_t* worker,
2046  const char node[],
2047  const char key[]);
2048 
2064  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeExtrinsicDataSync(
2065  vlWorker_t* worker,
2066  vlExtrinsicDataWrapper_t* extrinsicData,
2067  const char node[],
2068  const char key[]);
2069 
2087  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
2089  vlWorker_t* worker,
2090  const char node[],
2091  const char key[]);
2092 
2108  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeSimilarityTransformSync(
2109  vlWorker_t* worker,
2110  vlSimilarityTransformWrapper_t* similarityTransform,
2111  const char node[],
2112  const char key[]);
2113 
2131  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
2133  vlWorker_t* worker,
2134  const char node[],
2135  const char key[]);
2136 
2152  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeIntrinsicDataSync(
2153  vlWorker_t* worker,
2154  vlIntrinsicDataWrapper_t* intrinsicData,
2155  const char node[],
2156  const char key[]);
2157 
2165  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning(
2166  vlWorker_t* worker);
2167 
2317  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonCommand(
2318  vlWorker_t* worker, const char jsonString[],
2319  vlCallbackJsonString callback, void* clientData);
2320 
2343  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonAndBinaryCommand(
2344  vlWorker_t* worker, const char jsonString[], const char data[],
2345  unsigned int size, vlCallbackJsonAndBinaryString callback,
2346  void* clientData);
2347 
2359  VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer(const char data[]);
2360 
2372  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks(
2373  vlWorker_t* worker);
2374 
2387  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddImageListener(
2388  vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
2389 
2400  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener(
2401  vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
2402 
2415  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener(
2416  vlWorker_t* worker,
2417  vlCallbackImageWrapper listener,
2418  void* clientData);
2419 
2430  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveDebugImageListener(
2431  vlWorker_t* worker,
2432  vlCallbackImageWrapper listener,
2433  void* clientData);
2434 
2447  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddExtrinsicDataListener(
2448  vlWorker_t* worker, vlCallbackExtrinsicDataWrapper listener,
2449  void* clientData);
2450 
2461  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveExtrinsicDataListener(
2462  vlWorker_t* worker, vlCallbackExtrinsicDataWrapper listener,
2463  void* clientData);
2464 
2477  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddIntrinsicDataListener(
2478  vlWorker_t* worker, vlCallbackIntrinsicDataWrapper listener,
2479  void* clientData);
2480 
2491  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveIntrinsicDataListener(
2492  vlWorker_t* worker, vlCallbackIntrinsicDataWrapper listener,
2493  void* clientData);
2494 
2507  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddTrackingStateListener(
2508  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2509 
2520  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveTrackingStateListener(
2521  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2522 
2535  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddPerformanceInfoListener(
2536  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2537 
2548  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemovePerformanceInfoListener(
2549  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2550 
2565  VL_SDK_API bool VL_CALLINGCONVENTION
2567  vlWorker_t* worker,
2568  const char anchorName[],
2570  void* clientData);
2571 
2585  VL_SDK_API bool VL_CALLINGCONVENTION
2587  vlWorker_t* worker,
2588  const char anchorName[],
2590  void* clientData);
2591 
2604  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromCameraTransformListener(
2605  vlWorker_t* worker,
2607  void* clientData);
2608 
2619  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromCameraTransformListener(
2620  vlWorker_t* worker,
2622  void* clientData);
2623 
2640  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataImageListener(
2641  vlWorker_t* worker, const char node[], const char key[],
2642  vlCallbackImageWrapper listener, void* clientData);
2643 
2659  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataImageListener(
2660  vlWorker_t* worker, const char node[], const char key[],
2661  vlCallbackImageWrapper listener, void* clientData);
2662 
2679  VL_SDK_API bool VL_CALLINGCONVENTION
2680  vlWorker_AddNodeDataExtrinsicDataListener(
2681  vlWorker_t* worker, const char node[], const char key[],
2682  vlCallbackExtrinsicDataWrapper listener, void* clientData);
2683 
2699  VL_SDK_API bool VL_CALLINGCONVENTION
2700  vlWorker_RemoveNodeDataExtrinsicDataListener(
2701  vlWorker_t* worker, const char node[], const char key[],
2702  vlCallbackExtrinsicDataWrapper listener, void* clientData);
2703 
2720  VL_SDK_API bool VL_CALLINGCONVENTION
2721  vlWorker_AddNodeDataSimilarityTransformListener(
2722  vlWorker_t* worker, const char node[], const char key[],
2723  vlCallbackSimilarityTransformWrapper listener, void* clientData);
2724 
2740  VL_SDK_API bool VL_CALLINGCONVENTION
2741  vlWorker_RemoveNodeDataSimilarityTransformListener(
2742  vlWorker_t* worker, const char node[], const char key[],
2743  vlCallbackSimilarityTransformWrapper listener, void* clientData);
2744 
2761  VL_SDK_API bool VL_CALLINGCONVENTION
2762  vlWorker_AddNodeDataIntrinsicDataListener(
2763  vlWorker_t* worker, const char node[], const char key[],
2764  vlCallbackIntrinsicDataWrapper listener, void* clientData);
2765 
2781  VL_SDK_API bool VL_CALLINGCONVENTION
2782  vlWorker_RemoveNodeDataIntrinsicDataListener(
2783  vlWorker_t* worker, const char node[], const char key[],
2784  vlCallbackIntrinsicDataWrapper listener, void* clientData);
2785 
2803  VL_SDK_API bool VL_CALLINGCONVENTION
2804  vlWorker_AddNodeTrackingStateListener(vlWorker_t* worker,
2805  const char node[], vlCallbackZString listener, void* clientData);
2806 
2822  VL_SDK_API char* VL_CALLINGCONVENTION
2823  vlWorker_GetNodeTrackingStateJsonSync(vlWorker_t* worker, const char node[]);
2824 
2839  VL_SDK_API bool VL_CALLINGCONVENTION
2840  vlWorker_RemoveNodeTrackingStateListener(vlWorker_t* worker,
2841  const char node[], vlCallbackZString listener, void* clientData);
2842 
2850  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners(
2851  vlWorker_t* worker);
2852 
2864  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents(
2865  vlWorker_t* worker);
2866 
2883  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_WaitEvents(
2884  vlWorker_t* worker, unsigned int timeout);
2885 
2890  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Lock(vlWorker_t* worker);
2891 
2896  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t* worker);
2897 
2925  VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_get(
2926  const char *uri, unsigned long *size, const char *options=0);
2927 
2946  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_set(
2947  const char* uri, const void* data, unsigned long size,
2948  const char* options=0);
2949 
2963  VL_SDK_API bool VL_CALLINGCONVENTION
2964  vlSDKUtil_registerScheme(const char* name, const char* uri);
2965 
2980  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(
2981  const char* prefName, char *newName, unsigned int maxSize);
2982 
2997  VL_SDK_API char* VL_CALLINGCONVENTION
2998  //VL_SDK_API float* VL_CALLINGCONVENTION
3000  const char* geometryJson, unsigned long* size);
3001 
3016  VL_SDK_API char* VL_CALLINGCONVENTION
3017  // VL_SDK_API float* VL_CALLINGCONVENTION
3019  const char* workspaceJson,
3020  unsigned long* size);
3021 
3029  VL_SDK_API double VL_CALLINGCONVENTION
3031  vlImageWrapper_t* imageWrapper);
3032 
3048  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath(
3049  const char uri[],
3050  char physicalPath[],
3051  unsigned int maxSize);
3052 
3062  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelHash(
3063  const char modelURI[],
3064  char modelHash[],
3065  unsigned int maxSize);
3066 
3067 #ifdef __cplusplus
3068 }
3069 #endif // __cplusplus
3070 
3073 #endif // VL_SDK_H
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromAnchorTransformListener(vlWorker_t *worker, const char anchorName[], vlCallbackSimilarityTransformWrapper listener, void *clientData)
Register a listener for world from anchor transform events (SimilarityTransform events) produced by a...
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetR(vlSimilarityTransformWrapper_t *similarityTransformWrapper, float q[], unsigned int elementCount)
Returns the rotation of the contained transform.
VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer(const char data[])
Helper function for releasing a binary memory block.
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlImageWrapper_Clone(vlImageWrapper_t *imageWrapper)
Creates a copy of the image and returns a pointer to it.
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_get(const char *uri, unsigned long *size, const char *options=0)
Retrieves a file and its data from a given URI.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners(vlWorker_t *worker)
Removes all listeners.
VL_SDK_API double VL_CALLINGCONVENTION vlSDKUtil_getPosterQuality(vlImageWrapper_t *imageWrapper)
Estimates the quality of a given image as a PosterTracker reference.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_registerScheme(const char *name, const char *uri)
Creates an internal file scheme relative to the given uri.
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_GetImageSync(vlWorker_t *worker)
Returns a pointer to the camera image.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrated(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns whether the intrinsic parameters are valid.
VL_SDK_API vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlWorker_GetNodeSimilarityTransformSync(vlWorker_t *worker, const char node[], const char key[])
Returns a pointer to the SimilarityTransform with the given name from a given node.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMinor()
Returns the minor version number of the VisionLib plugin.
VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionHashString(char version[], unsigned int maxSize)
Copies the version hash of the VisionLib plugin into a buffer.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetT(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float t[], unsigned int elementCount)
Returns the translation from the world coordinate system to the camera coordinate system...
VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel()
Gets the current log level.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetModelViewMatrix(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float matrix[], unsigned int matrixElementCount)
Returns the current camera pose as model-view matrix.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddExtrinsicDataListener(vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
Registers a listener for ExtrinsicData events.
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlExtrinsicDataWrapper_Clone(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Creates a copy of the ExtrinsicDataWrapper object and returns a pointer to it.
VL_SDK_API bool VL_CALLINGCONVENTION vlGetBundleId(char bundleIdBuffer[], unsigned int maxSize)
Copies the bundle ID of the current application into the provided buffer as zero terminated string...
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCyNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double value)
Sets the normalized y-component of the principal point of the given IntrinsicDataWrapper object to th...
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlIntrinsicDataWrapper_Clone(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Creates a copy of the IntrinsicDataWrapper object and returns a pointer to it.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetHeight(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the height of the intrinsic camera calibration.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_GetDeviceInfo(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, char buffer[], unsigned int maxSize)
Copies a JSON string with information about the current device into the provided buffer.
Definition: vlSDK.h:93
vlImageFormat
Definition: vlSDK.h:110
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlNew_ImageWrapper(vlImageFormat imageFormat)
Creates a new Image object and returns a pointer to it.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetHeight(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, unsigned int value)
Sets height of the given IntrinsicDataWrapper object to the given value.
VL_SDK_API bool VL_CALLINGCONVENTION vlLog(const char message[], int level)
Logs the given message as VisionLib log.
void(VL_CALLINGCONVENTION * vlCallbackExtrinsicDataWrapper)(vlExtrinsicDataWrapper_t *extrinsicData, void *clientData)
A pointer to a callback function which receives a pointer to an ExtrinsicDataWrapper object as parame...
Definition: vlSDK.h:194
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddIntrinsicDataListener(vlWorker_t *worker, vlCallbackIntrinsicDataWrapper listener, void *clientData)
Registers a listener for IntrinsicData events.
VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBuffer(vlImageWrapper_t *imageWrapper, const unsigned char buffer[], unsigned int width, unsigned int height)
Copies the given buffer into the VisionLib image.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCxNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double value)
Sets the normalized x-component of the principal point of the given IntrinsicDataWrapper object to th...
void(VL_CALLINGCONVENTION * vlCallbackZString)(const char data[], void *clientData)
A pointer to a callback function which receives a zero terminated string as parameter.
Definition: vlSDK.h:130
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t *worker)
Deletes a Worker object.
VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer()
Disables log buffering.
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrationError(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the calibration error.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_WaitEvents(vlWorker_t *worker, unsigned int timeout)
Waits for enqueued events and calls the registered listeners.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Registers a listener for image events.
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlWorker_GetNodeIntrinsicDataSync(vlWorker_t *worker, const char node[], const char key[])
Returns a pointer to IntrinsicData with the given name from a given node.
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getCameraTransformsFromWorkspaceDefinition(const char *workspaceJson, unsigned long *size)
Transforms a workspace definition into a list of poses.
Definition: vlSDK.h:119
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonAndBinaryCommandSync(vlWorker_t *worker, const char jsonString[], const char data[], unsigned int size, vlCallbackJsonAndBinaryString callback, void *clientData)
Processes the passed json command along with binary data for the visionLib.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionRevision()
Returns the revision version number of the VisionLib plugin.
VL_SDK_API char *VL_CALLINGCONVENTION vlWorker_GetDeviceInfo(vlWorker_t *worker)
Returns a JSON string with information about the current device.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t *worker)
For testing purposed. Don't use!
VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener(vlCallbackZString fn, void *clientData)
Unregisters a log listener.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_RegisterThread(vlAbstractApplicationWrapper_t *abstractApplicationWrapper)
Registers the current thread for the AbstractApplication.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeIntrinsicDataSync(vlWorker_t *worker, vlIntrinsicDataWrapper_t *intrinsicData, const char node[], const char key[])
Sets the given IntrinsicData in the given input of the given node.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelHash(const char modelURI[], char modelHash[], unsigned int maxSize)
Creates the model hash of the given model into a buffer.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFxNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double value)
Sets the normalized focal length in x direction of the given IntrinsicDataWrapper object to the given...
VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyToBuffer(vlImageWrapper_t *imageWrapper, unsigned char buffer[], unsigned int bufferSize)
Copies the VisionLib image into the given buffer.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Deletes an ExtrinsicDataWrapper object.
VL_SDK_API vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlSimilarityTransformWrapper_Clone(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Creates a copy of the SimilarityTransformWrapper object and returns a pointer to it.
void(VL_CALLINGCONVENTION * vlCallbackImageWrapper)(vlImageWrapper_t *image, void *clientData)
A pointer to a callback function which receives a pointer to an ImageWrapper object as parameter...
Definition: vlSDK.h:179
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetS(vlSimilarityTransformWrapper_t *similarityTransformWrapper, float s)
Sets the scale factor of the given SimilarityTransform.
Definition: vlSDK.h:113
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeImageSync(vlWorker_t *worker, vlImageWrapper_t *image, const char node[], const char key[])
Sets the given image in the given input of the given node.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromCameraTransformListener(vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
Registers a listener for world from camera transform events.
VL_SDK_API vlWorker_t *VL_CALLINGCONVENTION vlNew_SyncWorker(vlAbstractApplicationWrapper_t *aap)
Creates a synchronous Worker object.
void(VL_CALLINGCONVENTION * vlCallbackIntrinsicDataWrapper)(vlIntrinsicDataWrapper_t *intrinsicData, void *clientData)
A pointer to a callback function which receives a pointer to an IntrinsicDataWrapper object as parame...
Definition: vlSDK.h:224
vlLogLevel
Definition: vlSDK.h:80
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the width of the intrinsic camera calibration.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ResetCameraCalibrationDB(vlWorker_t *worker)
Removes all references to all manually set calibration data bases.
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Returns whether the contained transform is valid (the tracking was successful).
Definition: vlSDK.h:91
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight(vlImageWrapper_t *imageWrapper)
Returns the height of the image.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Lock(vlWorker_t *worker)
For testing purposed. Don't use!
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromAnchorTransformListener(vlWorker_t *worker, const char anchorName[], vlCallbackSimilarityTransformWrapper listener, void *clientData)
Unregister a listener from world from anchor transform events (SimilarityTransform events) produced b...
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMajor()
Returns the major version number of the VisionLib plugin.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Register a listener for debug image events.
struct vlImageWrapper_s vlImageWrapper_t
Type which represents an ImageWrapper.
Definition: vlSDK.h:39
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetLicenseFilePath(vlWorker_t *worker, const char licenseFilePath[])
Sets the path of the license file.
VL_SDK_API vlWorker_t *VL_CALLINGCONVENTION vlNew_Worker(vlAbstractApplicationWrapper_t *aap)
Creates a Worker object.
vlRenderRotation
Definition: vlSDK.h:99
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_set(const char *uri, const void *data, unsigned long size, const char *options=0)
Posts or writes data to given URI.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_ResetCameraCalibrationDB(vlAbstractApplicationWrapper_t *abstractApplicationWrapper)
Removes all references to all manually set calibration data bases.
void(VL_CALLINGCONVENTION * vlCallbackJsonString)(const char error[], const char data[], void *clientData)
A pointer to a callback function which receives two zero terminated string which contain JSON data...
Definition: vlSDK.h:146
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Stop(vlWorker_t *worker)
Stops the tracking thread.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper(vlImageWrapper_t *imageWrapper)
Deletes an ImageWrapper object.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Start(vlWorker_t *worker)
Starts the tracking thread.
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetSkewNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized skew of the intrinsic camera calibration.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetCamPosWorld(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float t[], unsigned int elementCount)
Returns the position of the camera in world coordinates.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth(vlImageWrapper_t *imageWrapper)
Returns the width of the image.
VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer()
Notifies registered log listeners of all buffered log messages.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveExtrinsicDataListener(vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
Unregisters a listener from ExtrinsicData events.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetT(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, const float t[], unsigned int elementCount)
Sets the translation from the world coordinate system to the camera coordinate system.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_SetLicenseFileData(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, const char *licenseFileData)
Allows to inject the license data from memory.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_ClearProject(vlAbstractApplicationWrapper_t *abstractApplicationWrapper)
Clears the ActionPipe and DataSet.
VL_SDK_API float VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetS(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Returns the scale factor of the given SimilarityTransform.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Unregisters a listener from image events.
VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer()
Enables log buffering.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_SetLicenseFilePath(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, const char *licenseFilePath)
Sets the path of the license file.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_LoadProjectData(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, const char filename[])
Loads the specified tracking configuration XML file.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_FoundBlockedFeatures(vlAbstractApplicationWrapper_t *abstractApplicationWrapper)
Returns whether any features are used, which are not licensed.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonCommandSync(vlWorker_t *worker, const char jsonString[], vlCallbackJsonString callback, void *clientData)
Processes the passed command.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFyNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double value)
Sets the normalized focal length in y direction of the given IntrinsicDataWrapper object to the given...
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetT(vlSimilarityTransformWrapper_t *similarityTransformWrapper, const float t[], unsigned int elementCount)
Sets the translational part of the contained transform.
VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel(int level)
Sets the log level.
Definition: vlSDK.h:117
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_ActivateFoundBlockedFeatures(vlAbstractApplicationWrapper_t *abstractApplicationWrapper)
Simulates the usage of blocked features.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_LoadProjectDataFromString(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, const char str[], const char fakeFilename[])
Loads the given string as tracking configuration.
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper()
Creates a new IntrinsicDataWrapper object and returns a pointer to it.
Definition: vlSDK.h:115
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RunOnceSync(vlWorker_t *worker)
Processes the enqueued commands and the tracking once.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetWidth(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, unsigned int value)
Sets width of the given IntrinsicDataWrapper object to the given value.
struct vlWorker_s vlWorker_t
Type which represents a Worker.
Definition: vlSDK.h:75
Definition: vlSDK.h:89
VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionString(char version[], unsigned int maxSize)
Copies the version string of the VisionLib plugin into a buffer.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath(const char uri[], char physicalPath[], unsigned int maxSize)
Resolves the given URI.
struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t
Type which represents a SimilarityTransformWrapper.
Definition: vlSDK.h:57
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_AutoLoadPlugins(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, const char pluginPath[])
Loads all VisionLib plugins from a specific directory.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Deletes a SimilarityTransformWrapper object.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromCameraTransformListener(vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
Unregisters a listener from world from camera transform events.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(const char *prefName, char *newName, unsigned int maxSize)
Generate a temporary file URI.
void(VL_CALLINGCONVENTION * vlCallbackJsonAndBinaryString)(const char description[], const char data[], unsigned int size, void *clientData)
A pointer to a callback function which receives a zero terminated description string (usually in JSON...
Definition: vlSDK.h:164
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddPerformanceInfoListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Registers a listener for performance information events.
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlWorker_GetNodeExtrinsicDataSync(vlWorker_t *worker, const char node[], const char key[])
Returns a pointer to extrinsicdata with the given name from a given node.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning(vlWorker_t *worker)
Returns whether the thread is currently running or not.
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFxNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized focal length of the intrinsic camera calibration in x direction.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_AddCameraCalibrationDB(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, const char uri[])
Adds a given URI pointing to a camera calibration database JSON file to the VisionLib.
Definition: vlSDK.h:87
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetR(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, const float q[], unsigned int elementCount)
Sets the rotation from the world coordinate system to the camera coordinate system.
VL_SDK_API vlAbstractApplicationWrapper_t *VL_CALLINGCONVENTION vlNew_AbstractApplicationWrapper()
Creates an AbstractApplicationWrapper object.
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromGeometry(const char *geometryJson, unsigned long *size)
Transforms a workspace geometry into a list of points.
VL_SDK_API bool VL_CALLINGCONVENTION vlGetHostId(char hostIdBuffer[], unsigned int maxSize)
Copies the host ID of the current application into the provided buffer as zero terminated string...
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_GetNodeImageSync(vlWorker_t *worker, const char node[], const char key[])
Returns a pointer to the image with the given name from a given node.
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized y-component of the principal point.
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_GetImageByNameSync(vlWorker_t *worker, const char *image_name)
Returns a pointer to the camera image with the given name.
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized x-component of the principal point.
Definition: vlSDK.h:83
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetProjectionMatrix(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, float nearFact, float farFact, unsigned int screenWidth, unsigned int screenHeight, unsigned int renderRotation, unsigned int mode, float matrix[], unsigned int matrixElementCount)
Computed the projection matrix from the intrinsic camera parameters.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetRadialDistortion(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, const double k[], unsigned int elementCount)
Sets the radial distortion parameters.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Returns whether the current tracking pose is valid (the tracking was successful). ...
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_GetHostID(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, char hostID[], unsigned int maxSize)
Copies the host ID of the current machine into the provided buffer as zero terminated string...
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetT(vlSimilarityTransformWrapper_t *similarityTransformWrapper, float t[], unsigned int elementCount)
Returns the translational part of the contained transform.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCalibrated(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, bool value)
Sets the calibrated flag of the given IntrinsicDataWrapper object to the given value.
VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionTimestampString(char versionTimeStamp[], unsigned int maxSize)
Copies the version timestamp of the VisionLib plugin into a buffer.
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(vlSimilarityTransformWrapper_t *similarityTransformWrapper, bool value)
Sets the valid flag of the given SimilarityTransform.
struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t
Type which represents an IntrinsicDataWrapper.
Definition: vlSDK.h:66
This file contains defines with the VisionLib version.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveDebugImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Unregisters a listener from debug image events.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetCamPosWorld(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, const float t[], unsigned int elementCount)
Sets the position of the camera in world coordinates.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetValid(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, bool value)
Sets the valid flag of the given ExtrinsicData.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetRadialDistortion(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double k[], unsigned int elementCount)
Retrieves the radial distortion parameters.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_GetLicenseInformation(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, char licenseInfo[], unsigned int maxSize)
Retrieves actual license information as a JSON encoded string.
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetSkewNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double value)
Sets the normalized skew of the given IntrinsicDataWrapper object to the given value.
VL_SDK_API vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlNew_SimilarityTransformWrapper()
Creates a new SimilarityTransformWrapper object and returns a pointer to it.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetBytesPerPixel(vlImageWrapper_t *imageWrapper)
Returns the number of bytes per pixel.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonAndBinaryCommand(vlWorker_t *worker, const char jsonString[], const char data[], unsigned int size, vlCallbackJsonAndBinaryString callback, void *clientData)
Enqueues a json command along with binary data for the visionLib.
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetR(vlSimilarityTransformWrapper_t *similarityTransformWrapper, const float q[], unsigned int elementCount)
Sets the rotation of the contained transform.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonCommand(vlWorker_t *worker, const char jsonString[], vlCallbackJsonString callback, void *clientData)
Enqueues a command for the tracking thread as zero terminated JSON string.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveIntrinsicDataListener(vlWorker_t *worker, vlCallbackIntrinsicDataWrapper listener, void *clientData)
Unregisters a listener from IntrinsicData events.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddTrackingStateListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Registers a listener for tracking state events.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_GetTrackerType(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, char trackerType[], unsigned int maxSize)
Returns the type of the loaded tracking pipeline.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeSimilarityTransformSync(vlWorker_t *worker, vlSimilarityTransformWrapper_t *similarityTransform, const char node[], const char key[])
Sets the given SimilarityTransform in the given input of the given node.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetLicenseFileData(vlWorker_t *worker, const char licenseFileData[])
Allows to inject the license data from memory.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemovePerformanceInfoListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Unregisters a listener from performance info events.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents(vlWorker_t *worker)
Calls the registered listeners for the enqueued events.
VL_SDK_API char *VL_CALLINGCONVENTION vlWorker_GetLicenseInformation(vlWorker_t *worker)
Retrieves actual license information as a JSON encoded string.
struct vlAbstractApplicationWrapper_s vlAbstractApplicationWrapper_t
Type which represents an AbstractApplicationWrapper.
Definition: vlSDK.h:30
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Deletes an IntrinsicDataWrapper object.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float q[], unsigned int elementCount)
Returns the rotation from the world coordinate system to the camera coordinate system.
Definition: vlSDK.h:85
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks(vlWorker_t *worker)
Executes all enqueued callbacks.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat(vlImageWrapper_t *imageWrapper)
Returns the internal type of the image.
VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners()
Removes all log listeners.
VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBufferWithFormat(vlImageWrapper_t *imageWrapper, const unsigned char buffer[], unsigned int width, unsigned int height, vlImageFormat imageFormat)
Copies the given an formated buffer into the VisionLib image.
void(VL_CALLINGCONVENTION * vlCallbackSimilarityTransformWrapper)(vlSimilarityTransformWrapper_t *similarityTransform, void *clientData)
A pointer to a callback function which receives a pointer to an SimilarityTransformWrapper object as ...
Definition: vlSDK.h:209
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_LoadPlugin(vlWorker_t *worker, const char pluginName[])
Loads the plugin with the given name.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeExtrinsicDataSync(vlWorker_t *worker, vlExtrinsicDataWrapper_t *extrinsicData, const char node[], const char key[])
Sets the given extrinsicData in the given input of the given node.
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper()
Creates a new ExtrinsicDataWrapper object and returns a pointer to it.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_AbstractApplicationWrapper(vlAbstractApplicationWrapper_t *abstractApplicationWrapper)
Deletes an AbstractApplicationWrapper object.
struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t
Type which represents an ExtrinsicDataWrapper.
Definition: vlSDK.h:48
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized focal length of the intrinsic camera calibration in y direction.
VL_SDK_API void VL_CALLINGCONVENTION vlSetLogBufferSize(unsigned int maxEntries)
Sets the maximum number of log messages in the log buffer.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddCameraCalibrationDB(vlWorker_t *worker, const char uri[])
Adds a given URI pointing to a camera calibration database JSON file to the VisionLib.
VL_SDK_API bool VL_CALLINGCONVENTION vlAbstractApplicationWrapper_GetBundleID(vlAbstractApplicationWrapper_t *abstractApplicationWrapper, char bundleID[], unsigned int maxSize)
Copies the bundle ID of the current application into the provided buffer as zero terminated string...
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveTrackingStateListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Unregisters a listener from tracking state events.
VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener(vlCallbackZString fn, void *clientData)
Registers a log listener.