documentation

 
Loading...
Searching...
No Matches
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
23struct vlImageWrapper_s;
30typedef struct vlImageWrapper_s vlImageWrapper_t;
31
32struct vlExtrinsicDataWrapper_s;
39typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t;
40
41struct vlSimilarityTransformWrapper_s;
48typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t;
49
50struct vlIntrinsicDataWrapper_s;
57typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t;
58
59struct vlCalibratedImageWrapper_s;
68typedef struct vlCalibratedImageWrapper_s vlCalibratedImageWrapper_t;
69
70struct vlWorker_s;
77typedef struct vlWorker_s vlWorker_t;
78
93
97typedef 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
121
132
141typedef void (VL_CALLINGCONVENTION *vlCallbackZString)(
142 const char data[], void* clientData);
143
160typedef void (VL_CALLINGCONVENTION *vlCallbackJsonString)(
161 const char error[], const char data[], void* clientData);
162
185typedef void (VL_CALLINGCONVENTION *vlCallbackJsonAndBinaryString)(
186 const char error[],
187 const char result[],
188 const char data[],
189 unsigned int size,
190 void* clientData);
191
203typedef void (VL_CALLINGCONVENTION *vlCallbackImageWrapper)(
204 vlImageWrapper_t* image, void* clientData);
205
218typedef void (VL_CALLINGCONVENTION *vlCallbackExtrinsicDataWrapper)(
219 vlExtrinsicDataWrapper_t* extrinsicData, void* clientData);
220
233typedef void (VL_CALLINGCONVENTION *vlCallbackSimilarityTransformWrapper)(
234 vlSimilarityTransformWrapper_t* similarityTransform, void* clientData);
235
248typedef void (VL_CALLINGCONVENTION *vlCallbackIntrinsicDataWrapper)(
249 vlIntrinsicDataWrapper_t* intrinsicData, void* clientData);
250
263typedef void(VL_CALLINGCONVENTION* vlCallbackCalibratedImageWrapper)(
264 vlCalibratedImageWrapper_t* calibratedImage,
265 void* clientData);
266
267#ifdef __cplusplus
268extern "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 vlGetVersionPostfix(
304 char postfix[], unsigned int maxSize);
313 VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionString(
314 char version[], unsigned int maxSize);
315
324 VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionHashString(
325 char version[], unsigned int maxSize);
326
335 VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionTimestampString(
336 char versionTimeStamp[], unsigned int maxSize);
337
351 VL_SDK_API bool VL_CALLINGCONVENTION vlGetHostId(
352 char hostIdBuffer[], unsigned int maxSize);
353
367 VL_SDK_API bool VL_CALLINGCONVENTION vlGetBundleId(
368 char bundleIdBuffer[], unsigned int maxSize);
369
380 VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener(
381 vlCallbackZString fn, void* clientData);
382
391 VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener(
392 vlCallbackZString fn, void* clientData);
393
400 VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners();
401
417 VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer();
418
432 VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer();
433
445 VL_SDK_API void VL_CALLINGCONVENTION vlSetLogBufferSize(
446 unsigned int maxEntries);
447
463 VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer();
464
471 VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel();
472
486 VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel(int level);
487
496 VL_SDK_API bool VL_CALLINGCONVENTION vlLog(
497 const char message[], int level);
498
515 VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlNew_ImageWrapper(vlImageFormat imageFormat);
516
525 VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
527
537 VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper(
538 vlImageWrapper_t* imageWrapper);
539
548 VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat(
549 vlImageWrapper_t* imageWrapper);
550
558 VL_SDK_API unsigned int VL_CALLINGCONVENTION
560 vlImageWrapper_t* imageWrapper);
561
569 VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth(
570 vlImageWrapper_t* imageWrapper);
571
579 VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight(
580 vlImageWrapper_t* imageWrapper);
581
582
598 VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyToBuffer(
599 vlImageWrapper_t* imageWrapper,
600 unsigned char buffer[], unsigned int bufferSize);
601
619 VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBuffer(
620 vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
621 unsigned int width, unsigned int height);
622
639 VL_SDK_API bool VL_CALLINGCONVENTION vlImageWrapper_CopyFromBufferWithFormat(
640 vlImageWrapper_t* imageWrapper, const unsigned char buffer[],
641 unsigned int width, unsigned int height,vlImageFormat imageFormat);
642
661 VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper();
662
671 VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
673
683 VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(
684 vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
685
695 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid(
696 vlExtrinsicDataWrapper_t* extrinsicDataWrapper);
697
707 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetValid(
708 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, bool value);
709
732 VL_SDK_API bool VL_CALLINGCONVENTION
734 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float* matrix,
735 unsigned int matrixElementCount);
736
753 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetT(
754 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float* t,
755 unsigned int elementCount);
756
773 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetT(
774 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float* t,
775 unsigned int elementCount);
776
793 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR(
794 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float* q,
795 unsigned int elementCount);
796
813 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetR(
814 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float* q,
815 unsigned int elementCount);
816
833 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetCamPosWorld(
834 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, float* t,
835 unsigned int elementCount);
836
853 VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetCamPosWorld(
854 vlExtrinsicDataWrapper_t* extrinsicDataWrapper, const float* t,
855 unsigned int elementCount);
856
875
884 VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
886
896 VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper(
897 vlSimilarityTransformWrapper_t* similarityTransformWrapper);
898
908 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid(
909 vlSimilarityTransformWrapper_t* similarityTransformWrapper);
910
920 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(
921 vlSimilarityTransformWrapper_t* similarityTransformWrapper, bool value);
922
937 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetT(
938 vlSimilarityTransformWrapper_t* similarityTransformWrapper, float* t,
939 unsigned int elementCount);
940
955 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetT(
956 vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float* t,
957 unsigned int elementCount);
958
973 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetR(
974 vlSimilarityTransformWrapper_t* similarityTransformWrapper, float* q,
975 unsigned int elementCount);
976
991 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetR(
992 vlSimilarityTransformWrapper_t* similarityTransformWrapper, const float* q,
993 unsigned int elementCount);
994
1006 VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetS(
1007 vlSimilarityTransformWrapper_t* similarityTransformWrapper, float s);
1008
1019 VL_SDK_API float VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetS(
1020 vlSimilarityTransformWrapper_t* similarityTransformWrapper);
1021
1048 unsigned int width,
1049 unsigned int height,
1050 double fxNorm,
1051 double fyNorm,
1052 double cxNorm,
1053 double cyNorm,
1054 double skewNorm);
1055
1064 VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1066
1076 VL_SDK_API void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(
1077 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1078
1086 VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth(
1087 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1088
1096 VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetHeight(
1097 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1098
1110 VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFxNorm(
1111 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1112
1124 VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm(
1125 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1126
1137 VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetSkewNorm(
1138 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1139
1150 VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm(
1151 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1152
1163 VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm(
1164 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1165
1176 VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrated(
1177 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1178
1189 VL_SDK_API double VL_CALLINGCONVENTION
1191 vlIntrinsicDataWrapper_t* intrinsicDataWrapper);
1192
1204 VL_SDK_API bool VL_CALLINGCONVENTION
1206 vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double k[],
1207 unsigned int elementCount);
1208
1210 VL_SDK_API bool VL_CALLINGCONVENTION
1212 vlIntrinsicDataWrapper_t* intrinsicDataWrapper, double k[],
1213 unsigned int elementCount);
1214
1226 VL_SDK_API bool VL_CALLINGCONVENTION
1228 vlIntrinsicDataWrapper_t* intrinsicDataWrapper, const double k[],
1229 unsigned int elementCount);
1230
1232 VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetRadialDistortion(
1233 vlIntrinsicDataWrapper_t* intrinsicDataWrapper,
1234 const double k[],
1235 unsigned int elementCount);
1236
1275 VL_SDK_API bool VL_CALLINGCONVENTION
1277 vlIntrinsicDataWrapper_t* intrinsicDataWrapper,
1278 float nearFact, float farFact, unsigned int screenWidth,
1279 unsigned int screenHeight, unsigned int renderRotation,
1280 unsigned int mode, float* matrix, unsigned int matrixElementCount);
1281
1300
1309 VL_SDK_API vlCalibratedImageWrapper_t* VL_CALLINGCONVENTION
1311
1321 VL_SDK_API void VL_CALLINGCONVENTION
1323
1330 VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1332
1340 VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1342 vlCalibratedImageWrapper_t* calibratedImageWrapper);
1343
1351 VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
1353 vlCalibratedImageWrapper_t* calibratedImageWrapper);
1354
1372 VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_Worker();
1373
1389 VL_SDK_API vlWorker_t* VL_CALLINGCONVENTION vlNew_SyncWorker();
1390
1397 VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t* worker);
1398
1406 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Start(vlWorker_t* worker);
1407
1415 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Stop(vlWorker_t* worker);
1416
1429 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RunOnceSync(
1430 vlWorker_t* worker);
1431
1453 VL_SDK_API bool VL_CALLINGCONVENTION
1455
1475 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ResetCameraCalibrationDB(vlWorker_t* worker);
1476
1493 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonCommandSync(
1494 vlWorker_t* worker, const char jsonString[],
1495 vlCallbackJsonString callback, void* clientData);
1496
1518 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonAndBinaryCommandSync(
1519 vlWorker_t* worker,
1520 const char jsonString[],
1521 const char data[],
1522 unsigned int size,
1524 void* clientData);
1525
1551 VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetDeviceInfo(vlWorker_t* worker);
1552
1566 VL_SDK_API bool VL_CALLINGCONVENTION
1567 vlWorker_SetLicenseFilePath(vlWorker_t* worker, const char licenseFilePath[]);
1568
1584 VL_SDK_API bool VL_CALLINGCONVENTION
1585 vlWorker_SetLicenseFileData(vlWorker_t* worker, const char licenseFileData[]);
1586
1598 VL_SDK_API char* VL_CALLINGCONVENTION vlWorker_GetLicenseInformation(
1599 vlWorker_t* worker);
1600
1610 VL_SDK_API bool VL_CALLINGCONVENTION
1611 vlWorker_LoadPlugin(vlWorker_t* worker, const char pluginName[]);
1612
1629 VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION vlWorker_GetImageSync(
1630 vlWorker_t* worker);
1631
1649 VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1650 vlWorker_GetNodeImageSync(vlWorker_t* worker, const char node[], const char key[]);
1651
1669 VL_SDK_API vlImageWrapper_t* VL_CALLINGCONVENTION
1670 vlWorker_TryGetNodeImageSync(vlWorker_t* worker, const char node[], const char key[]);
1671
1687 VL_SDK_API bool VL_CALLINGCONVENTION
1688 vlWorker_SetNodeImageSync(vlWorker_t* worker, vlImageWrapper_t* image, const char node[], const char key[]);
1689
1707 VL_SDK_API vlExtrinsicDataWrapper_t* VL_CALLINGCONVENTION
1709 vlWorker_t* worker,
1710 const char node[],
1711 const char key[]);
1712
1728 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeExtrinsicDataSync(
1729 vlWorker_t* worker,
1730 vlExtrinsicDataWrapper_t* extrinsicData,
1731 const char node[],
1732 const char key[]);
1733
1751 VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
1753 vlWorker_t* worker,
1754 const char node[],
1755 const char key[]);
1756
1771 VL_SDK_API vlSimilarityTransformWrapper_t* VL_CALLINGCONVENTION
1772 vlWorker_GetWorldFromAnchorTransform(vlWorker_t* worker, const char anchorName[]);
1773
1789 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeSimilarityTransformSync(
1790 vlWorker_t* worker,
1791 vlSimilarityTransformWrapper_t* similarityTransform,
1792 const char node[],
1793 const char key[]);
1794
1812 VL_SDK_API vlIntrinsicDataWrapper_t* VL_CALLINGCONVENTION
1814 vlWorker_t* worker,
1815 const char node[],
1816 const char key[]);
1817
1833 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetNodeIntrinsicDataSync(
1834 vlWorker_t* worker,
1835 vlIntrinsicDataWrapper_t* intrinsicData,
1836 const char node[],
1837 const char key[]);
1838
1846 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning(
1847 vlWorker_t* worker);
1848
1870 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonCommand(
1871 vlWorker_t* worker, const char jsonString[],
1872 vlCallbackJsonString callback, void* clientData);
1873
1899 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PushJsonAndBinaryCommand(
1900 vlWorker_t* worker, const char jsonString[], const char data[],
1901 unsigned int size, vlCallbackJsonAndBinaryString callback,
1902 void* clientData);
1903
1915 VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer(const char data[]);
1916
1928 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks(
1929 vlWorker_t* worker);
1930
1943 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddImageListener(
1944 vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
1945
1956 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener(
1957 vlWorker_t* worker, vlCallbackImageWrapper listener, void* clientData);
1958
1971 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener(
1972 vlWorker_t* worker,
1973 vlCallbackImageWrapper listener,
1974 void* clientData);
1975
1986 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveDebugImageListener(
1987 vlWorker_t* worker,
1988 vlCallbackImageWrapper listener,
1989 void* clientData);
1990
2003 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddExtrinsicDataListener(
2005 void* clientData);
2006
2017 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveExtrinsicDataListener(
2019 void* clientData);
2020
2033 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddIntrinsicDataListener(
2035 void* clientData);
2036
2047 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveIntrinsicDataListener(
2049 void* clientData);
2050
2065 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddCalibratedImageListener(
2066 vlWorker_t* worker,
2068 void* clientData,
2069 vlImageFormat format);
2070
2083 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveCalibratedImageListener(
2084 vlWorker_t* worker,
2086 void* clientData,
2087 vlImageFormat format);
2088
2101 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddTrackingStateListener(
2102 vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2103
2114 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveTrackingStateListener(
2115 vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2116
2129 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddPerformanceInfoListener(
2130 vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2131
2142 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemovePerformanceInfoListener(
2143 vlWorker_t* worker, vlCallbackZString listener, void* clientData);
2144
2159 VL_SDK_API bool VL_CALLINGCONVENTION
2161 vlWorker_t* worker,
2162 const char anchorName[],
2164 void* clientData);
2165
2179 VL_SDK_API bool VL_CALLINGCONVENTION
2181 vlWorker_t* worker,
2182 const char anchorName[],
2184 void* clientData);
2185
2198 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromCameraTransformListener(
2199 vlWorker_t* worker,
2201 void* clientData);
2202
2213 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromCameraTransformListener(
2214 vlWorker_t* worker,
2216 void* clientData);
2217
2234 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataImageListener(
2235 vlWorker_t* worker, const char node[], const char key[],
2236 vlCallbackImageWrapper listener, void* clientData);
2237
2253 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataImageListener(
2254 vlWorker_t* worker, const char node[], const char key[],
2255 vlCallbackImageWrapper listener, void* clientData);
2256
2273 VL_SDK_API bool VL_CALLINGCONVENTION
2274 vlWorker_AddNodeDataExtrinsicDataListener(
2275 vlWorker_t* worker, const char node[], const char key[],
2276 vlCallbackExtrinsicDataWrapper listener, void* clientData);
2277
2293 VL_SDK_API bool VL_CALLINGCONVENTION
2294 vlWorker_RemoveNodeDataExtrinsicDataListener(
2295 vlWorker_t* worker, const char node[], const char key[],
2296 vlCallbackExtrinsicDataWrapper listener, void* clientData);
2297
2314 VL_SDK_API bool VL_CALLINGCONVENTION
2315 vlWorker_AddNodeDataSimilarityTransformListener(
2316 vlWorker_t* worker, const char node[], const char key[],
2317 vlCallbackSimilarityTransformWrapper listener, void* clientData);
2318
2334 VL_SDK_API bool VL_CALLINGCONVENTION
2335 vlWorker_RemoveNodeDataSimilarityTransformListener(
2336 vlWorker_t* worker, const char node[], const char key[],
2337 vlCallbackSimilarityTransformWrapper listener, void* clientData);
2338
2355 VL_SDK_API bool VL_CALLINGCONVENTION
2356 vlWorker_AddNodeDataIntrinsicDataListener(
2357 vlWorker_t* worker, const char node[], const char key[],
2358 vlCallbackIntrinsicDataWrapper listener, void* clientData);
2359
2375 VL_SDK_API bool VL_CALLINGCONVENTION
2376 vlWorker_RemoveNodeDataIntrinsicDataListener(
2377 vlWorker_t* worker, const char node[], const char key[],
2378 vlCallbackIntrinsicDataWrapper listener, void* clientData);
2379
2397 VL_SDK_API bool VL_CALLINGCONVENTION
2398 vlWorker_AddNodeTrackingStateListener(vlWorker_t* worker,
2399 const char node[], vlCallbackZString listener, void* clientData);
2400
2416 VL_SDK_API char* VL_CALLINGCONVENTION
2417 vlWorker_GetNodeTrackingStateJsonSync(vlWorker_t* worker, const char node[]);
2418
2433 VL_SDK_API bool VL_CALLINGCONVENTION
2434 vlWorker_RemoveNodeTrackingStateListener(vlWorker_t* worker,
2435 const char node[], vlCallbackZString listener, void* clientData);
2436
2444 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners(
2445 vlWorker_t* worker);
2446
2458 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents(
2459 vlWorker_t* worker);
2460
2477 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_WaitEvents(
2478 vlWorker_t* worker, unsigned int timeout);
2479
2484 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Lock(vlWorker_t* worker);
2485
2490 VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t* worker);
2491
2518 VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_get(
2519 const char *uri, unsigned long *size, const char *options=0);
2520
2534 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_fileExists(const char *uri);
2535
2554 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_set(
2555 const char* uri, const void* data, unsigned long size,
2556 const char* options=0);
2557
2571 VL_SDK_API bool VL_CALLINGCONVENTION
2572 vlSDKUtil_registerScheme(const char* name, const char* uri);
2573
2588 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(
2589 const char* prefName, char *newName, unsigned int maxSize);
2590
2605 VL_SDK_API char* VL_CALLINGCONVENTION
2606 vlSDKUtil_getCameraPositionsFromGeometry(const char* geometryJson, unsigned long* size);
2607
2622 VL_SDK_API char* VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromWorkspaceDefinition(
2623 const char* workspaceJson,
2624 unsigned long* size);
2625
2641 VL_SDK_API char* VL_CALLINGCONVENTION
2643 const char* workspaceJson,
2644 unsigned long* size);
2645
2660 VL_SDK_API char* VL_CALLINGCONVENTION
2662 const char* workspaceJson,
2663 unsigned long* size);
2664
2672 VL_SDK_API double VL_CALLINGCONVENTION
2674 vlImageWrapper_t* imageWrapper);
2675
2682 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_systemHasExternalSLAM();
2683
2699 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath(
2700 const char uri[],
2701 char physicalPath[],
2702 unsigned int maxSize);
2703
2713 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelHash(
2714 const char modelURI[],
2715 char modelHash[],
2716 unsigned int maxSize);
2717
2729 VL_SDK_API char* VL_CALLINGCONVENTION
2730 vlSDKUtil_loadModel(const char* uri, char** json, unsigned long* size);
2731
2742 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_writeModel(
2743 const char* uri,
2744 const char* json,
2745 const char* data,
2746 unsigned long size);
2747
2761 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelHashFromSerializedModel(
2762 const char modelDescriptionJson[],
2763 const char modelData[],
2764 unsigned int modelDataSize,
2765 char modelHash[],
2766 unsigned int maxSize);
2767
2795 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelBoundingBox(
2796 const char* uri,
2797 float* modelBoundingBoxOut,
2798 unsigned int elementCount);
2799
2808 VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelIDFromName(const char name[], unsigned int* modelID);
2809
2810#ifdef __cplusplus
2811}
2812#endif // __cplusplus
2813
2816#endif // VL_SDK_H
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelIDFromName(const char name[], unsigned int *modelID)
Retrieve the ID of a 3D model specified by its name.
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_loadModel(const char *uri, char **json, unsigned long *size)
Loads the model for the given uri and returns it in a serialized form.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_writeModel(const char *uri, const char *json, const char *data, unsigned long size)
Writes the model represented by the given json and binary data to the given uri.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath(const char uri[], char physicalPath[], unsigned int maxSize)
Resolves the given URI.
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 char *VL_CALLINGCONVENTION vlSDKUtil_getCameraTransformsFromWorkspaceDefinition(const char *workspaceJson, unsigned long *size)
Transforms a workspace definition into a list of poses.
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 bool VL_CALLINGCONVENTION vlSDKUtil_getModelHashFromSerializedModel(const char modelDescriptionJson[], const char modelData[], unsigned int modelDataSize, char modelHash[], unsigned int maxSize)
Creates the model hashes of the given model(s) into a buffer.
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_get(const char *uri, unsigned long *size, const char *options=0)
Retrieves a file and its data from a given URI.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getModelBoundingBox(const char *uri, float *modelBoundingBoxOut, unsigned int elementCount)
Retrieve the bounding box of a 3D model specified by its URI.
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename(const char *prefName, char *newName, unsigned int maxSize)
Generate a temporary file 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 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 bool VL_CALLINGCONVENTION vlSDKUtil_fileExists(const char *uri)
Checks if a file exists at a given URI.
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.
struct vlImageWrapper_s vlImageWrapper_t
Type which represents an ImageWrapper.
Definition vlSDK.h:30
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetRadialDistortion(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double k[], unsigned int elementCount)
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
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetRadialDistortion(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, const double k[], unsigned int elementCount)
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 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 void VL_CALLINGCONVENTION vlDelete_CalibratedImageWrapper(vlCalibratedImageWrapper_t *calibratedImageWrapper)
Deletes an CalibratedImageWrapper object.
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 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 vlCalibratedImageWrapper_t *VL_CALLINGCONVENTION vlNew_CalibratedImageWrapper()
Creates a new CalibratedImageWrapper object and returns a pointer to it.
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 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_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_SetValid(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, bool value)
Sets the valid flag of the given ExtrinsicData.
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlExtrinsicDataWrapper_Clone(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Creates a copy of the ExtrinsicDataWrapper object and returns a pointer to it.
VL_SDK_API bool VL_CALLINGCONVENTION 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_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 bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Returns whether the current tracking pose is valid (the tracking was successful).
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper(vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
Deletes an ExtrinsicDataWrapper object.
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR(vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float *q, unsigned int elementCount)
Returns the rotation from the world coordinate system to the camera coordinate system.
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 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 vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper()
Creates a new ExtrinsicDataWrapper object and returns a pointer to it.
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 bool VL_CALLINGCONVENTION vlGetVersionPostfix(char postfix[], unsigned int maxSize)
Copies the version postfix of the VisionLib plugin into a buffer.
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 vlImageWrapper_t *VL_CALLINGCONVENTION vlImageWrapper_Clone(vlImageWrapper_t *imageWrapper)
Creates a copy of the image and returns a pointer to it.
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 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 void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Deletes an IntrinsicDataWrapper object.
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlIntrinsicDataWrapper_Clone(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Creates a copy of the IntrinsicDataWrapper object and returns a pointer to it.
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_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_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 double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm(vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
Returns the normalized focal length of the intrinsic camera calibration in y direction.
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper(unsigned int width, unsigned int height, double fxNorm, double fyNorm, double cxNorm, double cyNorm, double skewNorm)
Creates a new IntrinsicDataWrapper object and returns a pointer to it.
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_SetDistortionParameters(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, const double k[], unsigned int elementCount)
Sets the radial and tangential distortion parameters.
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_GetDistortionParameters(vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double k[], unsigned int elementCount)
Retrieves the radial and tangential distortion parameters.
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 vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlNew_SimilarityTransformWrapper()
Creates a new SimilarityTransformWrapper object and returns a pointer to it.
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_SetR(vlSimilarityTransformWrapper_t *similarityTransformWrapper, const float *q, unsigned int elementCount)
Sets the rotation 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 bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid(vlSimilarityTransformWrapper_t *similarityTransformWrapper, bool value)
Sets the valid flag of the given SimilarityTransform.
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_GetR(vlSimilarityTransformWrapper_t *similarityTransformWrapper, float *q, unsigned int elementCount)
Returns the rotation 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.
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 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 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_AddTrackingStateListener(vlWorker_t *worker, vlCallbackZString listener, void *clientData)
Registers a listener for tracking state events.
VL_SDK_API vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlWorker_GetWorldFromAnchorTransform(vlWorker_t *worker, const char anchorName[])
Returns a pointer to the WorldFromAnchorTransform with the given anchor name.
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 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 char *VL_CALLINGCONVENTION vlWorker_GetDeviceInfo(vlWorker_t *worker)
Returns a JSON string with information about the current device.
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_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 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 vlWorker_t *VL_CALLINGCONVENTION vlNew_Worker()
Creates a Worker object.
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 vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_TryGetNodeImageSync(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 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_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 vlWorker_t *VL_CALLINGCONVENTION vlNew_SyncWorker()
Creates a synchronous Worker object.
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 void VL_CALLINGCONVENTION vlDelete_Worker(vlWorker_t *worker)
Deletes a Worker object.
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 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 vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_GetImageSync(vlWorker_t *worker)
Returns a pointer to the camera image.
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock(vlWorker_t *worker)
For testing purposed. Don't use!
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.
This file contains defines with the VisionLib version.