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 
130 typedef void (VL_CALLINGCONVENTION *vlCallbackZString)(
131  const char data[], void* clientData);
132 
149 typedef void (VL_CALLINGCONVENTION *vlCallbackJsonString)(
150  const char error[], const char data[], void* clientData);
151 
174 typedef void (VL_CALLINGCONVENTION *vlCallbackJsonAndBinaryString)(
175  const char error[],
176  const char result[],
177  const char data[],
178  unsigned int size,
179  void* clientData);
180 
192 typedef void (VL_CALLINGCONVENTION *vlCallbackImageWrapper)(
193  vlImageWrapper_t* image, void* clientData);
194 
207 typedef void (VL_CALLINGCONVENTION *vlCallbackExtrinsicDataWrapper)(
208  vlExtrinsicDataWrapper_t* extrinsicData, void* clientData);
209 
222 typedef void (VL_CALLINGCONVENTION *vlCallbackSimilarityTransformWrapper)(
223  vlSimilarityTransformWrapper_t* similarityTransform, void* clientData);
224 
237 typedef void (VL_CALLINGCONVENTION *vlCallbackIntrinsicDataWrapper)(
238  vlIntrinsicDataWrapper_t* intrinsicData, void* clientData);
239 
252 typedef void(VL_CALLINGCONVENTION* vlCallbackCalibratedImageWrapper)(
253  vlCalibratedImageWrapper_t* calibratedImage,
254  void* clientData);
255 
256 #ifdef __cplusplus
257 extern "C"
258 {
259 #endif // __cplusplus
271  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMajor();
272 
277  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMinor();
278 
283  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionRevision();
292  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionString(
293  char version[], unsigned int maxSize);
294 
303  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionHashString(
304  char version[], unsigned int maxSize);
305 
314  VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionTimestampString(
315  char versionTimeStamp[], unsigned int maxSize);
316 
330  VL_SDK_API bool VL_CALLINGCONVENTION vlGetHostId(
331  char hostIdBuffer[], unsigned int maxSize);
332 
346  VL_SDK_API bool VL_CALLINGCONVENTION vlGetBundleId(
347  char bundleIdBuffer[], unsigned int maxSize);
348 
359  VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener(
360  vlCallbackZString fn, void* clientData);
361 
370  VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener(
371  vlCallbackZString fn, void* clientData);
372 
379  VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners();
380 
396  VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer();
397 
411  VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer();
412 
424  VL_SDK_API void VL_CALLINGCONVENTION vlSetLogBufferSize(
425  unsigned int maxEntries);
426 
442  VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer();
443 
450  VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel();
451 
465  VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel(int level);
466 
475  VL_SDK_API bool VL_CALLINGCONVENTION vlLog(
476  const char message[], int level);
477 
494  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlNew_ImageWrapper(vlImageFormat imageFormat);
495 
504  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
506 
516  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper(
517  vlImageWrapper_t* imageWrapper);
518 
527  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat(
528  vlImageWrapper_t* imageWrapper);
529 
537  VL_SDK_API unsigned int VL_CALLINGCONVENTION
539  vlImageWrapper_t* imageWrapper);
540 
548  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth(
549  vlImageWrapper_t* imageWrapper);
550 
558  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight(
559  vlImageWrapper_t* imageWrapper);
560 
561 
577  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyToBuffer(
578  vlImageWrapper_t* imageWrapper,
579  unsigned char buffer[], unsigned int bufferSize);
580 
598  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBuffer(
599  vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
600  unsigned int width, unsigned int height);
601 
618  VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBufferWithFormat(
619  vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
620  unsigned int width, unsigned int height,vlImageFormat imageFormat);
621 
640  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper();
641 
650  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
652 
662  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(
663  vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
664 
674  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid(
675  vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
676 
686  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetValid(
687  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, bool value);
688 
711  VL_SDK_API bool VL_CALLINGCONVENTION
713  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float matrix[],
714  unsigned int matrixElementCount);
715 
732  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetT(
733  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float t[],
734  unsigned int elementCount);
735 
752  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetT(
753  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float t[],
754  unsigned int elementCount);
755 
772  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR(
773  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float q[],
774  unsigned int elementCount);
775 
792  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetR(
793  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float q[],
794  unsigned int elementCount);
795 
812  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetCamPosWorld(
813  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float t[],
814  unsigned int elementCount);
815 
832  VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetCamPosWorld(
833  vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float t[],
834  unsigned int elementCount);
835 
854 
863  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
865 
875  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper(
876  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
877 
887  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid(
888  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
889 
899  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(
900  vlSimilarityTransformWrapper_t* similarityTransformWrapper, bool value);
901 
916  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetT(
917  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float t[],
918  unsigned int elementCount);
919 
934  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetT(
935  vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float t[],
936  unsigned int elementCount);
937 
952  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetR(
953  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float q[],
954  unsigned int elementCount);
955 
970  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetR(
971  vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float q[],
972  unsigned int elementCount);
973 
985  VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetS(
986  vlSimilarityTransformWrapper_t* similarityTransformWrapper, float s);
987 
998  VL_SDK_API float VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetS(
999  vlSimilarityTransformWrapper_t* similarityTransformWrapper);
1000 
1019  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper();
1020 
1029  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1031 
1041  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(
1042  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1043 
1051  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth(
1052  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1053 
1063  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetWidth(
1064  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, unsigned int value);
1065 
1073  VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetHeight(
1074  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1075 
1085  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetHeight(
1086  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, unsigned int value);
1098  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFxNorm(
1099  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1100 
1111  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFxNorm(
1112  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1113 
1125  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm(
1126  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1127 
1138  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetFyNorm(
1139  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1150  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetSkewNorm(
1151  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1152 
1162  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetSkewNorm(
1163  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1164 
1175  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm(
1176  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1177 
1188  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCxNorm(
1189  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1200  VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm(
1201  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1202 
1213  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCyNorm(
1214  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double value);
1215 
1226  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrated(
1227  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1228 
1238  VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetCalibrated(
1239  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, bool value);
1240 
1251  VL_SDK_API double VL_CALLINGCONVENTION
1253  vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1254 
1266  VL_SDK_API bool VL_CALLINGCONVENTION
1268  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double k[],
1269  unsigned int elementCount);
1270 
1282  VL_SDK_API bool VL_CALLINGCONVENTION
1284  vlIntrinsicDataWrapper_t* intrinsicDataWrapper, const double k[],
1285  unsigned int elementCount);
1286 
1326  VL_SDK_API bool VL_CALLINGCONVENTION
1328  vlIntrinsicDataWrapper_t* intrinsicDataWrapper,
1329  float nearFact, float farFact, unsigned int screenWidth,
1330  unsigned int screenHeight, unsigned int renderRotation,
1331  unsigned int mode, float matrix[], unsigned int matrixElementCount);
1332 
1350  VL_SDK_API vlCalibratedImageWrapper_t* VL_CALLINGCONVENTION vlNew_CalibratedImageWrapper();
1351 
1360  VL_SDK_API vlCalibratedImageWrapper_t* VL_CALLINGCONVENTION
1362 
1372  VL_SDK_API void VL_CALLINGCONVENTION
1374 
1381  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1383 
1391  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1393  vlCalibratedImageWrapper_t* calibratedImageWrapper);
1394 
1402  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
1404  vlCalibratedImageWrapper_t* calibratedImageWrapper);
1405 
1423  VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_Worker();
1424 
1440  VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_SyncWorker();
1441 
1448  VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t* worker);
1449 
1457  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Start(vlWorker_t* worker);
1458 
1466  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Stop(vlWorker_t* worker);
1467 
1480  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RunOnceSync(
1481  vlWorker_t* worker);
1482 
1504  VL_SDK_API bool VL_CALLINGCONVENTION
1505  vlWorker_AddCameraCalibrationDB(vlWorker_t* worker, const char uri[]);
1506 
1526  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ResetCameraCalibrationDB(vlWorker_t* worker);
1527 
1544  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonCommandSync(
1545  vlWorker_t* worker, const char jsonString[],
1546  vlCallbackJsonString callback, void* clientData);
1547 
1569  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonAndBinaryCommandSync(
1570  vlWorker_t* worker,
1571  const char jsonString[],
1572  const char data[],
1573  unsigned int size,
1575  void* clientData);
1576 
1616  VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetDeviceInfo(vlWorker_t* worker);
1617 
1631  VL_SDK_API bool VL_CALLINGCONVENTION
1632  vlWorker_SetLicenseFilePath(vlWorker_t* worker, const char licenseFilePath[]);
1633 
1649  VL_SDK_API bool VL_CALLINGCONVENTION
1650  vlWorker_SetLicenseFileData(vlWorker_t* worker, const char licenseFileData[]);
1651 
1663  VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetLicenseInformation(
1664  vlWorker_t* worker);
1665 
1675  VL_SDK_API bool VL_CALLINGCONVENTION
1676  vlWorker_LoadPlugin(vlWorker_t* worker, const char pluginName[]);
1677 
1694  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlWorker_GetImageSync(
1695  vlWorker_t* worker);
1696 
1714  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1716  vlWorker_t* worker, const char* image_name);
1717 
1718 
1736  VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1737  vlWorker_GetNodeImageSync(vlWorker_t* worker, const char node[], const char key[]);
1738 
1754  VL_SDK_API bool VL_CALLINGCONVENTION
1755  vlWorker_SetNodeImageSync(vlWorker_t* worker, vlImageWrapper_t* image, const char node[], const char key[]);
1756 
1774  VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
1776  vlWorker_t* worker,
1777  const char node[],
1778  const char key[]);
1779 
1795  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeExtrinsicDataSync(
1796  vlWorker_t* worker,
1797  vlExtrinsicDataWrapper_t* extrinsicData,
1798  const char node[],
1799  const char key[]);
1800 
1818  VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
1820  vlWorker_t* worker,
1821  const char node[],
1822  const char key[]);
1823 
1839  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeSimilarityTransformSync(
1840  vlWorker_t* worker,
1841  vlSimilarityTransformWrapper_t* similarityTransform,
1842  const char node[],
1843  const char key[]);
1844 
1862  VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1864  vlWorker_t* worker,
1865  const char node[],
1866  const char key[]);
1867 
1883  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeIntrinsicDataSync(
1884  vlWorker_t* worker,
1885  vlIntrinsicDataWrapper_t* intrinsicData,
1886  const char node[],
1887  const char key[]);
1888 
1896  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning(
1897  vlWorker_t* worker);
1898 
1920  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonCommand(
1921  vlWorker_t* worker, const char jsonString[],
1922  vlCallbackJsonString callback, void* clientData);
1923 
1949  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonAndBinaryCommand(
1950  vlWorker_t* worker, const char jsonString[], const char data[],
1951  unsigned int size, vlCallbackJsonAndBinaryString callback,
1952  void* clientData);
1953 
1965  VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer(const char data[]);
1966 
1978  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks(
1979  vlWorker_t* worker);
1980 
1993  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddImageListener(
1994  vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
1995 
2006  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener(
2007  vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
2008 
2021  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener(
2022  vlWorker_t* worker,
2023  vlCallbackImageWrapper listener,
2024  void* clientData);
2025 
2036  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveDebugImageListener(
2037  vlWorker_t* worker,
2038  vlCallbackImageWrapper listener,
2039  void* clientData);
2040 
2053  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddExtrinsicDataListener(
2054  vlWorker_t* worker, vlCallbackExtrinsicDataWrapper listener,
2055  void* clientData);
2056 
2067  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveExtrinsicDataListener(
2068  vlWorker_t* worker, vlCallbackExtrinsicDataWrapper listener,
2069  void* clientData);
2070 
2083  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddIntrinsicDataListener(
2084  vlWorker_t* worker, vlCallbackIntrinsicDataWrapper listener,
2085  void* clientData);
2086 
2097  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveIntrinsicDataListener(
2098  vlWorker_t* worker, vlCallbackIntrinsicDataWrapper listener,
2099  void* clientData);
2100 
2115  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddCalibratedImageListener(
2116  vlWorker_t* worker,
2118  void* clientData,
2119  vlImageFormat format);
2120 
2133  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveCalibratedImageListener(
2134  vlWorker_t* worker,
2136  void* clientData,
2137  vlImageFormat format);
2138 
2151  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddTrackingStateListener(
2152  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2153 
2164  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveTrackingStateListener(
2165  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2166 
2179  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddPerformanceInfoListener(
2180  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2181 
2192  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemovePerformanceInfoListener(
2193  vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2194 
2209  VL_SDK_API bool VL_CALLINGCONVENTION
2211  vlWorker_t* worker,
2212  const char anchorName[],
2214  void* clientData);
2215 
2229  VL_SDK_API bool VL_CALLINGCONVENTION
2231  vlWorker_t* worker,
2232  const char anchorName[],
2234  void* clientData);
2235 
2248  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromCameraTransformListener(
2249  vlWorker_t* worker,
2251  void* clientData);
2252 
2263  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromCameraTransformListener(
2264  vlWorker_t* worker,
2266  void* clientData);
2267 
2284  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataImageListener(
2285  vlWorker_t* worker, const char node[], const char key[],
2286  vlCallbackImageWrapper listener, void* clientData);
2287 
2303  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataImageListener(
2304  vlWorker_t* worker, const char node[], const char key[],
2305  vlCallbackImageWrapper listener, void* clientData);
2306 
2323  VL_SDK_API bool VL_CALLINGCONVENTION
2324  vlWorker_AddNodeDataExtrinsicDataListener(
2325  vlWorker_t* worker, const char node[], const char key[],
2326  vlCallbackExtrinsicDataWrapper listener, void* clientData);
2327 
2343  VL_SDK_API bool VL_CALLINGCONVENTION
2344  vlWorker_RemoveNodeDataExtrinsicDataListener(
2345  vlWorker_t* worker, const char node[], const char key[],
2346  vlCallbackExtrinsicDataWrapper listener, void* clientData);
2347 
2364  VL_SDK_API bool VL_CALLINGCONVENTION
2365  vlWorker_AddNodeDataSimilarityTransformListener(
2366  vlWorker_t* worker, const char node[], const char key[],
2367  vlCallbackSimilarityTransformWrapper listener, void* clientData);
2368 
2384  VL_SDK_API bool VL_CALLINGCONVENTION
2385  vlWorker_RemoveNodeDataSimilarityTransformListener(
2386  vlWorker_t* worker, const char node[], const char key[],
2387  vlCallbackSimilarityTransformWrapper listener, void* clientData);
2388 
2405  VL_SDK_API bool VL_CALLINGCONVENTION
2406  vlWorker_AddNodeDataIntrinsicDataListener(
2407  vlWorker_t* worker, const char node[], const char key[],
2408  vlCallbackIntrinsicDataWrapper listener, void* clientData);
2409 
2425  VL_SDK_API bool VL_CALLINGCONVENTION
2426  vlWorker_RemoveNodeDataIntrinsicDataListener(
2427  vlWorker_t* worker, const char node[], const char key[],
2428  vlCallbackIntrinsicDataWrapper listener, void* clientData);
2429 
2447  VL_SDK_API bool VL_CALLINGCONVENTION
2448  vlWorker_AddNodeTrackingStateListener(vlWorker_t* worker,
2449  const char node[], vlCallbackZString listener, void* clientData);
2450 
2466  VL_SDK_API char* VL_CALLINGCONVENTION
2467  vlWorker_GetNodeTrackingStateJsonSync(vlWorker_t* worker, const char node[]);
2468 
2483  VL_SDK_API bool VL_CALLINGCONVENTION
2484  vlWorker_RemoveNodeTrackingStateListener(vlWorker_t* worker,
2485  const char node[], vlCallbackZString listener, void* clientData);
2486 
2494  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners(
2495  vlWorker_t* worker);
2496 
2508  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents(
2509  vlWorker_t* worker);
2510 
2527  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_WaitEvents(
2528  vlWorker_t* worker, unsigned int timeout);
2529 
2534  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Lock(vlWorker_t* worker);
2535 
2540  VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t* worker);
2541 
2569  VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_get(
2570  const char *uri, unsigned long *size, const char *options=0);
2571 
2590  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_set(
2591  const char* uri, const void* data, unsigned long size,
2592  const char* options=0);
2593 
2607  VL_SDK_API bool VL_CALLINGCONVENTION
2608  vlSDKUtil_registerScheme(const char* name, const char* uri);
2609 
2624  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(
2625  const char* prefName, char *newName, unsigned int maxSize);
2626 
2641  VL_SDK_API char* VL_CALLINGCONVENTION
2642  vlSDKUtil_getCameraPositionsFromGeometry(const char* geometryJson, unsigned long* size);
2643 
2658  VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromWorkspaceDefinition(
2659  const char* workspaceJson,
2660  unsigned long* size);
2661 
2677  VL_SDK_API char* VL_CALLINGCONVENTION
2679  const char* workspaceJson,
2680  unsigned long* size);
2681 
2696  VL_SDK_API char* VL_CALLINGCONVENTION
2698  const char* workspaceJson,
2699  unsigned long* size);
2700 
2708  VL_SDK_API double VL_CALLINGCONVENTION
2710  vlImageWrapper_t* imageWrapper);
2711 
2718  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_systemHasExternalSLAM();
2719 
2735  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath(
2736  const char uri[],
2737  char physicalPath[],
2738  unsigned int maxSize);
2739 
2749  VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelHash(
2750  const char modelURI[],
2751  char modelHash[],
2752  unsigned int maxSize);
2753 
2765  VL_SDK_API const char* VL_CALLINGCONVENTION
2766  vlSDKUtil_loadModel(const char* uri, const char** json, unsigned long* size);
2767 
2768 #ifdef __cplusplus
2769 }
2770 #endif // __cplusplus
2771 
2774 #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:149
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:192
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:222
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:174
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:237
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:130
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:207
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:252
vlLogLevel
Definition: vlSDK.h:83
vlRenderRotation
Definition: vlSDK.h:98
vlImageFormat
Definition: vlSDK.h:109
@ 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.