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 vlImageWrapper_s;
30 typedef struct vlImageWrapper_s vlImageWrapper_t;
31 
32 struct vlExtrinsicDataWrapper_s;
39 typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t;
40 
41 struct vlSimilarityTransformWrapper_s;
48 typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t;
49 
50 struct vlIntrinsicDataWrapper_s;
57 typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t;
58 
59 struct vlCalibratedImageWrapper_s;
68 typedef struct vlCalibratedImageWrapper_s vlCalibratedImageWrapper_t;
69 
70 struct vlWorker_s;
77 typedef struct vlWorker_s vlWorker_t;
78 
82 typedef enum
83 {
91  VL_LOG_DEBUG = 3
93 
97 typedef enum
98 {
99  VL_RENDER_ROTATION_CCW_0 = 0,
100  VL_RENDER_ROTATION_CCW_90 = 2,
101  VL_RENDER_ROTATION_CCW_180 = 1,
102  VL_RENDER_ROTATION_CCW_270 = 3,
104 
108 typedef enum
109 {
120 } vlImageFormat;
121 
125 typedef enum
126 {
132 
141 typedef void (VL_CALLINGCONVENTION *vlCallbackZString)(
142  const char data[], void* clientData);
143 
160 typedef void (VL_CALLINGCONVENTION *vlCallbackJsonString)(
161  const char error[], const char data[], void* clientData);
162 
185 typedef void (VL_CALLINGCONVENTION *vlCallbackJsonAndBinaryString)(
186  const char error[],
187  const char result[],
188  const char data[],
189  unsigned int size,
190  void* clientData);
191 
203 typedef void (VL_CALLINGCONVENTION *vlCallbackImageWrapper)(
204  vlImageWrapper_t* image, void* clientData);
205 
218 typedef void (VL_CALLINGCONVENTION *vlCallbackExtrinsicDataWrapper)(
219  vlExtrinsicDataWrapper_t* extrinsicData, void* clientData);
220 
233 typedef void (VL_CALLINGCONVENTION *vlCallbackSimilarityTransformWrapper)(
234  vlSimilarityTransformWrapper_t* similarityTransform, void* clientData);
235 
248 typedef void (VL_CALLINGCONVENTION *vlCallbackIntrinsicDataWrapper)(
249  vlIntrinsicDataWrapper_t* intrinsicData, void* clientData);
250 
263 typedef void(VL_CALLINGCONVENTION* vlCallbackCalibratedImageWrapper)(
264  vlCalibratedImageWrapper_t* calibratedImage,
265  void* clientData);
266 
267 #ifdef __cplusplus
268 extern "C"
269 {
270 #endif // __cplusplus
282  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMajor();
283 
288  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMinor();
289 
294  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionRevision();
303  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionString(
304  char version[], unsigned int maxSize);
305 
314  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionHashString(
315  char version[], unsigned int maxSize);
316 
325  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionTimestampString(
326  char versionTimeStamp[], unsigned int maxSize);
327 
341  VL_SDK_API bool VL_CALLINGCONVENTION vlGetHostId(
342  char hostIdBuffer[], unsigned int maxSize);
343 
357  VL_SDK_API bool VL_CALLINGCONVENTION vlGetBundleId(
358  char bundleIdBuffer[], unsigned int maxSize);
359 
370  VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener(
371  vlCallbackZString fn, void* clientData);
372 
381  VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener(
382  vlCallbackZString fn, void* clientData);
383 
390  VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners();
391 
407  VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer();
408 
422  VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer();
423 
435  VL_SDK_API void VL_CALLINGCONVENTION vlSetLogBufferSize(
436  unsigned int maxEntries);
437 
453  VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer();
454 
461  VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel();
462 
476  VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel(int level);
477 
486  VL_SDK_API bool VL_CALLINGCONVENTION vlLog(
487  const char message[], int level);
488 
505  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlNew_ImageWrapper(vlImageFormat imageFormat);
506 
515  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
517 
527  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper(
528  vlImageWrapper_t* imageWrapper);
529 
538  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat(
539  vlImageWrapper_t* imageWrapper);
540 
548  VL_SDK_API unsigned int VL_CALLINGCONVENTION
550  vlImageWrapper_t* imageWrapper);
551 
559  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth(
560  vlImageWrapper_t* imageWrapper);
561 
569  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight(
570  vlImageWrapper_t* imageWrapper);
571 
572 
588  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyToBuffer(
589  vlImageWrapper_t* imageWrapper,
590  unsigned char buffer[], unsigned int bufferSize);
591 
609  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBuffer(
610  vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
611  unsigned int width, unsigned int height);
612 
629  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBufferWithFormat(
630  vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
631  unsigned int width, unsigned int height,vlImageFormat imageFormat);
632 
651  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper();
652 
661  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
663 
673  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(
674  vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
675 
685  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid(
686  vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
687 
697  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetValid(
698  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, bool value);
699 
722  VL_SDK_API bool VL_CALLINGCONVENTION
724  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float matrix[],
725  unsigned int matrixElementCount);
726 
743  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetT(
744  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float t[],
745  unsigned int elementCount);
746 
763  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetT(
764  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float t[],
765  unsigned int elementCount);
766 
783  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR(
784  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float q[],
785  unsigned int elementCount);
786 
803  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetR(
804  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float q[],
805  unsigned int elementCount);
806 
823  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetCamPosWorld(
824  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float t[],
825  unsigned int elementCount);
826 
843  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetCamPosWorld(
844  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float t[],
845  unsigned int elementCount);
846 
865 
874  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
876 
886  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper(
887  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
888 
898  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid(
899  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
900 
910  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(
911  vlSimilarityTransformWrapper_t* similarityTransformWrapper, bool value);
912 
927  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetT(
928  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float t[],
929  unsigned int elementCount);
930 
945  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetT(
946  vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float t[],
947  unsigned int elementCount);
948 
963  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetR(
964  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float q[],
965  unsigned int elementCount);
966 
981  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetR(
982  vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float q[],
983  unsigned int elementCount);
984 
996  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetS(
997  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float s);
998 
1009  VL_SDK_API float VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetS(
1010  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
1011 
1030  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper();
1031 
1040  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1042 
1052  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(
1053  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1054 
1062  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth(
1063  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1064 
1074  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetWidth(
1075  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, unsigned int value);
1076 
1084  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetHeight(
1085  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1086 
1096  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetHeight(
1097  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, unsigned int value);
1109  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFxNorm(
1110  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1111 
1122  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFxNorm(
1123  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1124 
1136  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm(
1137  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1138 
1149  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFyNorm(
1150  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1161  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetSkewNorm(
1162  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1163 
1173  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetSkewNorm(
1174  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1175 
1186  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm(
1187  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1188 
1199  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCxNorm(
1200  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1211  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm(
1212  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1213 
1224  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCyNorm(
1225  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1226 
1237  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrated(
1238  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1239 
1249  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCalibrated(
1250  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, bool value);
1251 
1262  VL_SDK_API double VL_CALLINGCONVENTION
1264  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1265 
1277  VL_SDK_API bool VL_CALLINGCONVENTION
1279  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double k[],
1280  unsigned int elementCount);
1281 
1293  VL_SDK_API bool VL_CALLINGCONVENTION
1295  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, const double k[],
1296  unsigned int elementCount);
1297 
1336  VL_SDK_API bool VL_CALLINGCONVENTION
1338  vlIntrinsicDataWrapper_t* intrinsicDataWrapper,
1339  float nearFact, float farFact, unsigned int screenWidth,
1340  unsigned int screenHeight, unsigned int renderRotation,
1341  unsigned int mode, float matrix[], unsigned int matrixElementCount);
1342 
1360  VL_SDK_API vlCalibratedImageWrapper_t* VL_CALLINGCONVENTION vlNew_CalibratedImageWrapper();
1361 
1370  VL_SDK_API vlCalibratedImageWrapper_t* VL_CALLINGCONVENTION
1372 
1382  VL_SDK_API void VL_CALLINGCONVENTION
1384 
1391  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1393 
1401  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1403  vlCalibratedImageWrapper_t* calibratedImageWrapper);
1404 
1412  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
1414  vlCalibratedImageWrapper_t* calibratedImageWrapper);
1415 
1433  VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_Worker();
1434 
1450  VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_SyncWorker();
1451 
1458  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t* worker);
1459 
1467  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Start(vlWorker_t* worker);
1468 
1476  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Stop(vlWorker_t* worker);
1477 
1490  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RunOnceSync(
1491  vlWorker_t* worker);
1492 
1514  VL_SDK_API bool VL_CALLINGCONVENTION
1515  vlWorker_AddCameraCalibrationDB(vlWorker_t* worker, const char uri[]);
1516 
1536  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ResetCameraCalibrationDB(vlWorker_t* worker);
1537 
1554  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonCommandSync(
1555  vlWorker_t* worker, const char jsonString[],
1556  vlCallbackJsonString callback, void* clientData);
1557 
1579  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonAndBinaryCommandSync(
1580  vlWorker_t* worker,
1581  const char jsonString[],
1582  const char data[],
1583  unsigned int size,
1585  void* clientData);
1586 
1626  VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetDeviceInfo(vlWorker_t* worker);
1627 
1641  VL_SDK_API bool VL_CALLINGCONVENTION
1642  vlWorker_SetLicenseFilePath(vlWorker_t* worker, const char licenseFilePath[]);
1643 
1659  VL_SDK_API bool VL_CALLINGCONVENTION
1660  vlWorker_SetLicenseFileData(vlWorker_t* worker, const char licenseFileData[]);
1661 
1673  VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetLicenseInformation(
1674  vlWorker_t* worker);
1675 
1685  VL_SDK_API bool VL_CALLINGCONVENTION
1686  vlWorker_LoadPlugin(vlWorker_t* worker, const char pluginName[]);
1687 
1704  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlWorker_GetImageSync(
1705  vlWorker_t* worker);
1706 
1724  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1726  vlWorker_t* worker, const char* image_name);
1727 
1728 
1746  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1747  vlWorker_GetNodeImageSync(vlWorker_t* worker, const char node[], const char key[]);
1748 
1764  VL_SDK_API bool VL_CALLINGCONVENTION
1765  vlWorker_SetNodeImageSync(vlWorker_t* worker, vlImageWrapper_t* image, const char node[], const char key[]);
1766 
1784  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
1786  vlWorker_t* worker,
1787  const char node[],
1788  const char key[]);
1789 
1805  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeExtrinsicDataSync(
1806  vlWorker_t* worker,
1807  vlExtrinsicDataWrapper_t* extrinsicData,
1808  const char node[],
1809  const char key[]);
1810 
1828  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
1830  vlWorker_t* worker,
1831  const char node[],
1832  const char key[]);
1833 
1849  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeSimilarityTransformSync(
1850  vlWorker_t* worker,
1851  vlSimilarityTransformWrapper_t* similarityTransform,
1852  const char node[],
1853  const char key[]);
1854 
1872  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1874  vlWorker_t* worker,
1875  const char node[],
1876  const char key[]);
1877 
1893  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeIntrinsicDataSync(
1894  vlWorker_t* worker,
1895  vlIntrinsicDataWrapper_t* intrinsicData,
1896  const char node[],
1897  const char key[]);
1898 
1906  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning(
1907  vlWorker_t* worker);
1908 
1930  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonCommand(
1931  vlWorker_t* worker, const char jsonString[],
1932  vlCallbackJsonString callback, void* clientData);
1933 
1959  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonAndBinaryCommand(
1960  vlWorker_t* worker, const char jsonString[], const char data[],
1961  unsigned int size, vlCallbackJsonAndBinaryString callback,
1962  void* clientData);
1963 
1975  VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer(const char data[]);
1976 
1988  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks(
1989  vlWorker_t* worker);
1990 
2003  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddImageListener(
2004  vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
2005 
2016  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener(
2017  vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
2018 
2031  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener(
2032  vlWorker_t* worker,
2033  vlCallbackImageWrapper listener,
2034  void* clientData);
2035 
2046  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveDebugImageListener(
2047  vlWorker_t* worker,
2048  vlCallbackImageWrapper listener,
2049  void* clientData);
2050 
2063  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddExtrinsicDataListener(
2064  vlWorker_t* worker, vlCallbackExtrinsicDataWrapper listener,
2065  void* clientData);
2066 
2077  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveExtrinsicDataListener(
2078  vlWorker_t* worker, vlCallbackExtrinsicDataWrapper listener,
2079  void* clientData);
2080 
2093  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddIntrinsicDataListener(
2094  vlWorker_t* worker, vlCallbackIntrinsicDataWrapper listener,
2095  void* clientData);
2096 
2107  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveIntrinsicDataListener(
2108  vlWorker_t* worker, vlCallbackIntrinsicDataWrapper listener,
2109  void* clientData);
2110 
2125  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddCalibratedImageListener(
2126  vlWorker_t* worker,
2128  void* clientData,
2129  vlImageFormat format);
2130 
2143  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveCalibratedImageListener(
2144  vlWorker_t* worker,
2146  void* clientData,
2147  vlImageFormat format);
2148 
2161  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddTrackingStateListener(
2162  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2163 
2174  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveTrackingStateListener(
2175  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2176 
2189  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddPerformanceInfoListener(
2190  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2191 
2202  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemovePerformanceInfoListener(
2203  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2204 
2219  VL_SDK_API bool VL_CALLINGCONVENTION
2221  vlWorker_t* worker,
2222  const char anchorName[],
2224  void* clientData);
2225 
2239  VL_SDK_API bool VL_CALLINGCONVENTION
2241  vlWorker_t* worker,
2242  const char anchorName[],
2244  void* clientData);
2245 
2258  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromCameraTransformListener(
2259  vlWorker_t* worker,
2261  void* clientData);
2262 
2273  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromCameraTransformListener(
2274  vlWorker_t* worker,
2276  void* clientData);
2277 
2294  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataImageListener(
2295  vlWorker_t* worker, const char node[], const char key[],
2296  vlCallbackImageWrapper listener, void* clientData);
2297 
2313  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataImageListener(
2314  vlWorker_t* worker, const char node[], const char key[],
2315  vlCallbackImageWrapper listener, void* clientData);
2316 
2333  VL_SDK_API bool VL_CALLINGCONVENTION
2334  vlWorker_AddNodeDataExtrinsicDataListener(
2335  vlWorker_t* worker, const char node[], const char key[],
2336  vlCallbackExtrinsicDataWrapper listener, void* clientData);
2337 
2353  VL_SDK_API bool VL_CALLINGCONVENTION
2354  vlWorker_RemoveNodeDataExtrinsicDataListener(
2355  vlWorker_t* worker, const char node[], const char key[],
2356  vlCallbackExtrinsicDataWrapper listener, void* clientData);
2357 
2374  VL_SDK_API bool VL_CALLINGCONVENTION
2375  vlWorker_AddNodeDataSimilarityTransformListener(
2376  vlWorker_t* worker, const char node[], const char key[],
2377  vlCallbackSimilarityTransformWrapper listener, void* clientData);
2378 
2394  VL_SDK_API bool VL_CALLINGCONVENTION
2395  vlWorker_RemoveNodeDataSimilarityTransformListener(
2396  vlWorker_t* worker, const char node[], const char key[],
2397  vlCallbackSimilarityTransformWrapper listener, void* clientData);
2398 
2415  VL_SDK_API bool VL_CALLINGCONVENTION
2416  vlWorker_AddNodeDataIntrinsicDataListener(
2417  vlWorker_t* worker, const char node[], const char key[],
2418  vlCallbackIntrinsicDataWrapper listener, void* clientData);
2419 
2435  VL_SDK_API bool VL_CALLINGCONVENTION
2436  vlWorker_RemoveNodeDataIntrinsicDataListener(
2437  vlWorker_t* worker, const char node[], const char key[],
2438  vlCallbackIntrinsicDataWrapper listener, void* clientData);
2439 
2457  VL_SDK_API bool VL_CALLINGCONVENTION
2458  vlWorker_AddNodeTrackingStateListener(vlWorker_t* worker,
2459  const char node[], vlCallbackZString listener, void* clientData);
2460 
2476  VL_SDK_API char* VL_CALLINGCONVENTION
2477  vlWorker_GetNodeTrackingStateJsonSync(vlWorker_t* worker, const char node[]);
2478 
2493  VL_SDK_API bool VL_CALLINGCONVENTION
2494  vlWorker_RemoveNodeTrackingStateListener(vlWorker_t* worker,
2495  const char node[], vlCallbackZString listener, void* clientData);
2496 
2504  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners(
2505  vlWorker_t* worker);
2506 
2518  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents(
2519  vlWorker_t* worker);
2520 
2537  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_WaitEvents(
2538  vlWorker_t* worker, unsigned int timeout);
2539 
2544  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Lock(vlWorker_t* worker);
2545 
2550  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t* worker);
2551 
2579  VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_get(
2580  const char *uri, unsigned long *size, const char *options=0);
2581 
2600  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_set(
2601  const char* uri, const void* data, unsigned long size,
2602  const char* options=0);
2603 
2617  VL_SDK_API bool VL_CALLINGCONVENTION
2618  vlSDKUtil_registerScheme(const char* name, const char* uri);
2619 
2634  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(
2635  const char* prefName, char *newName, unsigned int maxSize);
2636 
2651  VL_SDK_API char* VL_CALLINGCONVENTION
2652  vlSDKUtil_getCameraPositionsFromGeometry(const char* geometryJson, unsigned long* size);
2653 
2668  VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromWorkspaceDefinition(
2669  const char* workspaceJson,
2670  unsigned long* size);
2671 
2687  VL_SDK_API char* VL_CALLINGCONVENTION
2689  const char* workspaceJson,
2690  unsigned long* size);
2691 
2706  VL_SDK_API char* VL_CALLINGCONVENTION
2708  const char* workspaceJson,
2709  unsigned long* size);
2710 
2718  VL_SDK_API double VL_CALLINGCONVENTION
2720  vlImageWrapper_t* imageWrapper);
2721 
2728  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_systemHasExternalSLAM();
2729 
2745  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath(
2746  const char uri[],
2747  char physicalPath[],
2748  unsigned int maxSize);
2749 
2759  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelHash(
2760  const char modelURI[],
2761  char modelHash[],
2762  unsigned int maxSize);
2763 
2775  VL_SDK_API const char* VL_CALLINGCONVENTION
2776  vlSDKUtil_loadModel(const char* uri, const char** json, unsigned long* size);
2777 
2778 #ifdef __cplusplus
2779 }
2780 #endif // __cplusplus
2781 
2784 #endif // VL_SDK_H
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 vlSDKUtil_retrievePhysicalPath(const char uri[], char physicalPath[], unsigned int maxSize)
Resolves the given URI.
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 char *VL_CALLINGCONVENTION vlSDKUtil_getCameraTransformsFromWorkspaceDefinition(const char *workspaceJson, unsigned long *size)
Transforms a workspace definition into a list of poses.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(const char *prefName, char *newName, unsigned int maxSize)
Generate a temporary file URI.
VL_SDK_API const char *VL_CALLINGCONVENTION vlSDKUtil_loadModel(const char *uri, const char **json, unsigned long *size)
Loads the model for the given uri and returns it in a serialized form.
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromWorkspaceDefinition(const char *workspaceJson, unsigned long *size)
Transforms a workspace definition into a list of points.
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_systemHasExternalSLAM()
Returns wether or not the system supports external SLAM (ARKit, ARCore, HoloLens).
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 char *VL_CALLINGCONVENTION vlSDKUtil_getOriginTransformFromSimpleWorkspaceDefinition(const char *workspaceJson, unsigned long *size)
Computes the origin transform of a given simple workspace definition.
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 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 vlCalibratedImageWrapper_GetImage(vlCalibratedImageWrapper_t *calibratedImageeWrapper)
Returns a pointer to the ImageWrapper object of the calibrated image.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_CalibratedImageWrapper(vlCalibratedImageWrapper_t *calibratedImageWrapper)
Deletes an CalibratedImageWrapper object.
VL_SDK_API vlCalibratedImageWrapper_t *VL_CALLINGCONVENTION vlCalibratedImageWrapper_Clone(vlCalibratedImageWrapper_t *calibratedImageWrapper)
Creates a copy of the CalibratedImageWrapper object and returns a pointer to it.
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlCalibratedImageWrapper_GetImageFromDeviceTransform(vlCalibratedImageWrapper_t *calibratedImageWrapper)
Returns a pointer to the ExtrinsicDataWrapper object of the extrinsic from the device to the image co...
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlCalibratedImageWrapper_GetIntrinsicData(vlCalibratedImageWrapper_t *calibratedImageWrapper)
Returns a pointer to the IntriniscDataWrapper object of the intrinsic of the image.
VL_SDK_API vlCalibratedImageWrapper_t *VL_CALLINGCONVENTION vlNew_CalibratedImageWrapper()
Creates a new CalibratedImageWrapper object and returns a pointer to it.
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 vlExtrinsicDataWrapper_SetValid(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, bool value)
Sets the valid flag of the given ExtrinsicData.
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper()
Creates a new ExtrinsicDataWrapper object and returns a pointer to it.
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.
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 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 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 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 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 void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Deletes an ExtrinsicDataWrapper object.
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_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 vlGetVersionHashString(char version[], unsigned int maxSize)
Copies the version hash of the VisionLib plugin into a buffer.
VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel()
Gets the current log level.
VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel(int level)
Sets the log level.
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 unsigned int VL_CALLINGCONVENTION vlGetVersionMinor()
Returns the minor version number of the VisionLib plugin.
VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer()
Notifies registered log listeners of all buffered log messages.
VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener(vlCallbackZString fn, void *clientData)
Registers a log listener.
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 vlGetVersionString(char version[], unsigned int maxSize)
Copies the version string of the VisionLib plugin into a buffer.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionRevision()
Returns the revision version number of the VisionLib plugin.
VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener(vlCallbackZString fn, void *clientData)
Unregisters a log listener.
VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners()
Removes all log listeners.
VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer()
Disables log buffering.
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 void VL_CALLINGCONVENTION vlSetLogBufferSize(unsigned int maxEntries)
Sets the maximum number of log messages in the log buffer.
VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer()
Enables log buffering.
VL_SDK_API bool VL_CALLINGCONVENTION vlLog(const char message[], int level)
Logs the given message as VisionLib log.
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.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetBytesPerPixel(vlImageWrapper_t *imageWrapper)
Returns the number of bytes per pixel.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight(vlImageWrapper_t *imageWrapper)
Returns the height of the image.
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 unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat(vlImageWrapper_t *imageWrapper)
Returns the internal type of the image.
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 vlImageWrapper_t *VL_CALLINGCONVENTION vlImageWrapper_Clone(vlImageWrapper_t *imageWrapper)
Creates a copy of the image and returns a pointer to it.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth(vlImageWrapper_t *imageWrapper)
Returns the width of the image.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper(vlImageWrapper_t *imageWrapper)
Deletes an ImageWrapper object.
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_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 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 void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Deletes an IntrinsicDataWrapper object.
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 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 unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the width of the intrinsic camera calibration.
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 vlIntrinsicDataWrapper_GetCalibrated(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns whether the intrinsic parameters are valid.
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 vlIntrinsicDataWrapper_SetWidth(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, unsigned int value)
Sets width of the given IntrinsicDataWrapper object to the given value.
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper()
Creates a new IntrinsicDataWrapper object and returns a pointer to it.
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 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...
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 vlIntrinsicDataWrapper_SetHeight(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, unsigned int value)
Sets height of the given IntrinsicDataWrapper object to the given value.
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 double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized y-component of the principal point.
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 double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized x-component of the principal point.
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 vlIntrinsicDataWrapper_SetCalibrated(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, bool value)
Sets the calibrated flag of the given IntrinsicDataWrapper object to the given value.
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 double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrationError(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the calibration error.
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 vlSimilarityTransformWrapper_SetS(vlSimilarityTransformWrapper_t *similarityTransformWrapper, float s)
Sets the scale factor of the given SimilarityTransform.
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Returns whether the contained transform is valid (the tracking was successful).
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(vlSimilarityTransformWrapper_t *similarityTransformWrapper, bool value)
Sets the valid flag of the given SimilarityTransform.
VL_SDK_API vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlNew_SimilarityTransformWrapper()
Creates a new SimilarityTransformWrapper object and returns a pointer to it.
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 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 vlSimilarityTransformWrapper_GetT(vlSimilarityTransformWrapper_t *similarityTransformWrapper, float t[], unsigned int elementCount)
Returns the translational part of the contained transform.
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 vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlSimilarityTransformWrapper_Clone(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Creates a copy of the SimilarityTransformWrapper object and returns a pointer to it.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper(vlSimilarityTransformWrapper_t *similarityTransformWrapper)
Deletes a SimilarityTransformWrapper object.
struct vlImageWrapper_s vlImageWrapper_t
Type which represents an ImageWrapper.
Definition: vlSDK.h:30
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:160
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:203
struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t
Type which represents a SimilarityTransformWrapper.
Definition: vlSDK.h:48
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:233
void(VL_CALLINGCONVENTION * vlCallbackJsonAndBinaryString)(const char error[], const char result[], const char data[], unsigned int size, void *clientData)
A pointer to a callback function which receives a zero terminated result string (usually in JSON),...
Definition: vlSDK.h:185
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:248
struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t
Type which represents an IntrinsicDataWrapper.
Definition: vlSDK.h:57
struct vlWorker_s vlWorker_t
Type which represents a Worker.
Definition: vlSDK.h:77
struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t
Type which represents an ExtrinsicDataWrapper.
Definition: vlSDK.h:39
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:141
struct vlCalibratedImageWrapper_s vlCalibratedImageWrapper_t
Type which represents a CalibratedImageWrapper.
Definition: vlSDK.h:68
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:218
vlFittingMode
Definition: vlSDK.h:126
void(VL_CALLINGCONVENTION * vlCallbackCalibratedImageWrapper)(vlCalibratedImageWrapper_t *calibratedImage, void *clientData)
A pointer to a callback function which receives a pointer to a CalibratedImageWrapper object as param...
Definition: vlSDK.h:263
vlLogLevel
Definition: vlSDK.h:83
vlRenderRotation
Definition: vlSDK.h:98
vlImageFormat
Definition: vlSDK.h:109
@ VL_FITTING_MODE_COVER
Definition: vlSDK.h:128
@ VL_FITTING_MODE_CONTAIN
Definition: vlSDK.h:130
@ VL_LOG_MUTE
Definition: vlSDK.h:85
@ VL_LOG_DEBUG
Definition: vlSDK.h:91
@ VL_LOG_WARNING
Definition: vlSDK.h:89
@ VL_LOG_ERROR
Definition: vlSDK.h:87
@ VL_IMAGE_FORMAT_RGBA
Definition: vlSDK.h:117
@ VL_IMAGE_FORMAT_UNDEFINED
Definition: vlSDK.h:111
@ VL_IMAGE_FORMAT_GREY
Definition: vlSDK.h:113
@ VL_IMAGE_FORMAT_RGB
Definition: vlSDK.h:115
@ VL_IMAGE_FORMAT_DEPTH
Definition: vlSDK.h:119
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners(vlWorker_t *worker)
Removes all listeners.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Register a listener for debug image events.
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 vlWorker_AddTrackingStateListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Registers a listener for tracking state events.
VL_SDK_API vlWorker_t *VL_CALLINGCONVENTION vlNew_Worker()
Creates a Worker object.
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 vlWorker_AddPerformanceInfoListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Registers a listener for performance information events.
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 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 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 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_Lock(vlWorker_t *worker)
For testing purposed. Don't use!
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Unregisters a listener from image events.
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 vlWorker_RemoveIntrinsicDataListener(vlWorker_t *worker, vlCallbackIntrinsicDataWrapper listener, void *clientData)
Unregisters a listener from IntrinsicData events.
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 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_RemoveTrackingStateListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Unregisters a listener from tracking state events.
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 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 char *VL_CALLINGCONVENTION vlWorker_GetLicenseInformation(vlWorker_t *worker)
Retrieves actual license information as a JSON encoded string.
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 vlWorker_AddImageListener(vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
Registers a listener for image events.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents(vlWorker_t *worker)
Calls the registered listeners for the enqueued events.
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 vlWorker_SetLicenseFileData(vlWorker_t *worker, const char licenseFileData[])
Allows to inject the license data from memory.
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 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 bool VL_CALLINGCONVENTION vlWorker_AddCalibratedImageListener(vlWorker_t *worker, vlCallbackCalibratedImageWrapper listener, void *clientData, vlImageFormat format)
Registers a listener for CalibratedImage events.
VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer(const char data[])
Helper function for releasing a binary memory block.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks(vlWorker_t *worker)
Executes all enqueued callbacks.
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 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 vlWorker_Stop(vlWorker_t *worker)
Stops the tracking thread.
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_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 vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_GetImageSync(vlWorker_t *worker)
Returns a pointer to the camera image.
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t *worker)
Deletes a Worker object.
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 vlWorker_t *VL_CALLINGCONVENTION vlNew_SyncWorker()
Creates a synchronous Worker object.
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 bool VL_CALLINGCONVENTION vlWorker_RemoveCalibratedImageListener(vlWorker_t *worker, vlCallbackCalibratedImageWrapper listener, void *clientData, vlImageFormat format)
Unregisters a listener from CalibratedImage events.
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_AddExtrinsicDataListener(vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
Registers a listener for ExtrinsicData events.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetLicenseFilePath(vlWorker_t *worker, const char licenseFilePath[])
Sets the path of the license file.
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 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 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_Start(vlWorker_t *worker)
Starts the tracking thread.
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_ResetCameraCalibrationDB(vlWorker_t *worker)
Removes all references to all manually set calibration data bases.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning(vlWorker_t *worker)
Returns whether the thread is currently running or not.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t *worker)
For testing purposed. Don't use!
This file contains defines with the VisionLib version.