documentation

vlSDK.h File Reference

This file contains all functions of the VisionLib SDK. More...

#include "vlSDKDef.h"
#include "vlSDKVersion.h"

Go to the source code of this file.

Typedefs

typedef struct vlCalibratedImageWrapper_s vlCalibratedImageWrapper_t
 Type which represents a CalibratedImageWrapper. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackCalibratedImageWrapper) (vlCalibratedImageWrapper_t *calibratedImage, void *clientData)
 A pointer to a callback function which receives a pointer to a CalibratedImageWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackExtrinsicDataWrapper) (vlExtrinsicDataWrapper_t *extrinsicData, void *clientData)
 A pointer to a callback function which receives a pointer to an ExtrinsicDataWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef 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. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackIntrinsicDataWrapper) (vlIntrinsicDataWrapper_t *intrinsicData, void *clientData)
 A pointer to a callback function which receives a pointer to an IntrinsicDataWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef 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), a zero terminated error string and a binary buffer which plain binary data. Please note that the use of this function might change in future and is considered as BETA! More...
 
typedef 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. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackSimilarityTransformWrapper) (vlSimilarityTransformWrapper_t *similarityTransform, void *clientData)
 A pointer to a callback function which receives a pointer to an SimilarityTransformWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackZString) (const char data[], void *clientData)
 A pointer to a callback function which receives a zero terminated string as parameter. More...
 
typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t
 Type which represents an ExtrinsicDataWrapper. More...
 
typedef struct vlImageWrapper_s vlImageWrapper_t
 Type which represents an ImageWrapper. More...
 
typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t
 Type which represents an IntrinsicDataWrapper. More...
 
typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t
 Type which represents a SimilarityTransformWrapper. More...
 
typedef struct vlWorker_s vlWorker_t
 Type which represents a Worker. More...
 

Enumerations

enum  vlImageFormat {
  VL_IMAGE_FORMAT_UNDEFINED = 0 , VL_IMAGE_FORMAT_GREY = 1 , VL_IMAGE_FORMAT_RGB = 2 , VL_IMAGE_FORMAT_RGBA = 3 ,
  VL_IMAGE_FORMAT_DEPTH = 4
}
 
enum  vlLogLevel { VL_LOG_MUTE = 0 , VL_LOG_ERROR = 1 , VL_LOG_WARNING = 2 , VL_LOG_DEBUG = 3 }
 
enum  vlRenderRotation { VL_RENDER_ROTATION_CCW_0 = 0 , VL_RENDER_ROTATION_CCW_90 = 2 , VL_RENDER_ROTATION_CCW_180 = 1 , VL_RENDER_ROTATION_CCW_270 = 3 }
 

Functions

VL_SDK_API bool VL_CALLINGCONVENTION vlAddLogListener (vlCallbackZString fn, void *clientData)
 Registers a log listener. More...
 
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. More...
 
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlCalibratedImageWrapper_GetImage (vlCalibratedImageWrapper_t *calibratedImageeWrapper)
 Returns a pointer to the ImageWrapper object of the calibrated image. More...
 
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 coordinates. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlClearLogListeners ()
 Removes all log listeners. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_CalibratedImageWrapper (vlCalibratedImageWrapper_t *calibratedImageWrapper)
 Deletes an CalibratedImageWrapper object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ExtrinsicDataWrapper (vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
 Deletes an ExtrinsicDataWrapper object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_ImageWrapper (vlImageWrapper_t *imageWrapper)
 Deletes an ImageWrapper object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_IntrinsicDataWrapper (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Deletes an IntrinsicDataWrapper object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_SimilarityTransformWrapper (vlSimilarityTransformWrapper_t *similarityTransformWrapper)
 Deletes a SimilarityTransformWrapper object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDelete_Worker (vlWorker_t *worker)
 Deletes a Worker object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlDisableLogBuffer ()
 Disables log buffering. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlEnableLogBuffer ()
 Enables log buffering. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetCamPosWorld (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float t[], unsigned int elementCount)
 Returns the position $P_{cam}$ of the camera in world coordinates. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetR (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float q[], unsigned int elementCount)
 Returns the rotation $R$ from the world coordinate system to the camera coordinate system. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetT (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, float t[], unsigned int elementCount)
 Returns the translation $t$ from the world coordinate system to the camera coordinate system. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_GetValid (vlExtrinsicDataWrapper_t *extrinsicDataWrapper)
 Returns whether the current tracking pose is valid (the tracking was successful). More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetCamPosWorld (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, const float t[], unsigned int elementCount)
 Sets the position $P_{cam}$ of the camera in world coordinates. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetR (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, const float q[], unsigned int elementCount)
 Sets the rotation $R$ from the world coordinate system to the camera coordinate system. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetT (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, const float t[], unsigned int elementCount)
 Sets the translation $t$ from the world coordinate system to the camera coordinate system. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlExtrinsicDataWrapper_SetValid (vlExtrinsicDataWrapper_t *extrinsicDataWrapper, bool value)
 Sets the valid flag of the given ExtrinsicData. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlFlushLogBuffer ()
 Notifies registered log listeners of all buffered log messages. More...
 
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. More...
 
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. More...
 
VL_SDK_API int VL_CALLINGCONVENTION vlGetLogLevel ()
 Gets the current log level. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionHashString (char version[], unsigned int maxSize)
 Copies the version hash of the VisionLib plugin into a buffer. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMajor ()
 Returns the major version number of the VisionLib plugin.
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionMinor ()
 Returns the minor version number of the VisionLib plugin.
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlGetVersionRevision ()
 Returns the revision version number of the VisionLib plugin.
 
VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionString (char version[], unsigned int maxSize)
 Copies the version string of the VisionLib plugin into a buffer. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlGetVersionTimestampString (char versionTimeStamp[], unsigned int maxSize)
 Copies the version timestamp of the VisionLib plugin into a buffer. More...
 
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlImageWrapper_Clone (vlImageWrapper_t *imageWrapper)
 Creates a copy of the image and returns a pointer to it. More...
 
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. More...
 
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. More...
 
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. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetBytesPerPixel (vlImageWrapper_t *imageWrapper)
 Returns the number of bytes per pixel. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetFormat (vlImageWrapper_t *imageWrapper)
 Returns the internal type of the image. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetHeight (vlImageWrapper_t *imageWrapper)
 Returns the height of the image. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlImageWrapper_GetWidth (vlImageWrapper_t *imageWrapper)
 Returns the width of the image. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrated (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns whether the intrinsic parameters are valid. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCalibrationError (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the calibration error. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCxNorm (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the normalized x-component of the principal point. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetCyNorm (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the normalized y-component of the principal point. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFxNorm (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the normalized focal length of the intrinsic camera calibration in x direction. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetFyNorm (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the normalized focal length of the intrinsic camera calibration in y direction. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetHeight (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the height of the intrinsic camera calibration. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetRadialDistortion (vlIntrinsicDataWrapper_t *intrinsicDataWrapper, double k[], unsigned int elementCount)
 Retrieves the radial distortion parameters. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetSkewNorm (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the normalized skew of the intrinsic camera calibration. More...
 
VL_SDK_API unsigned int VL_CALLINGCONVENTION vlIntrinsicDataWrapper_GetWidth (vlIntrinsicDataWrapper_t *intrinsicDataWrapper)
 Returns the width of the intrinsic camera calibration. More...
 
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. More...
 
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 the given value. More...
 
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 the given value. More...
 
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 value. More...
 
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 value. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlIntrinsicDataWrapper_SetRadialDistortion (vlIntrinsicDataWrapper_t *intrinsicDataWrapper, const double k[], unsigned int elementCount)
 Sets the radial distortion parameters. More...
 
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. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlLog (const char message[], int level)
 Logs the given message as VisionLib log. More...
 
VL_SDK_API vlCalibratedImageWrapper_t *VL_CALLINGCONVENTION vlNew_CalibratedImageWrapper ()
 Creates a new CalibratedImageWrapper object and returns a pointer to it. More...
 
VL_SDK_API vlExtrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_ExtrinsicDataWrapper ()
 Creates a new ExtrinsicDataWrapper object and returns a pointer to it. More...
 
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlNew_ImageWrapper (vlImageFormat imageFormat)
 Creates a new Image object and returns a pointer to it. More...
 
VL_SDK_API vlIntrinsicDataWrapper_t *VL_CALLINGCONVENTION vlNew_IntrinsicDataWrapper ()
 Creates a new IntrinsicDataWrapper object and returns a pointer to it. More...
 
VL_SDK_API vlSimilarityTransformWrapper_t *VL_CALLINGCONVENTION vlNew_SimilarityTransformWrapper ()
 Creates a new SimilarityTransformWrapper object and returns a pointer to it. More...
 
VL_SDK_API vlWorker_t *VL_CALLINGCONVENTION vlNew_SyncWorker ()
 Creates a synchronous Worker object. More...
 
VL_SDK_API vlWorker_t *VL_CALLINGCONVENTION vlNew_Worker ()
 Creates a Worker object. More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlReleaseBinaryBuffer (const char data[])
 Helper function for releasing a binary memory block. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlRemoveLogListener (vlCallbackZString fn, void *clientData)
 Unregisters a log listener. More...
 
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. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromGeometry (const char *geometryJson, unsigned long *size)
 Transforms a workspace geometry into a list of points. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getCameraPositionsFromWorkspaceDefinition (const char *workspaceJson, unsigned long *size)
 Transforms a workspace definition into a list of points. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getCameraTransformsFromWorkspaceDefinition (const char *workspaceJson, unsigned long *size)
 Transforms a workspace definition into a list of poses. More...
 
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. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlSDKUtil_getOriginTransformFromSimpleWorkspaceDefinition (const char *workspaceJson, unsigned long *size)
 Computes the origin transform of a given simple workspace definition. More...
 
VL_SDK_API double VL_CALLINGCONVENTION vlSDKUtil_getPosterQuality (vlImageWrapper_t *imageWrapper)
 Estimates the quality of a given image as a PosterTracker reference. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_getTempFilename (const char *prefName, char *newName, unsigned int maxSize)
 Generate a temporary file URI. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_registerScheme (const char *name, const char *uri)
 Creates an internal file scheme relative to the given uri. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_retrievePhysicalPath (const char uri[], char physicalPath[], unsigned int maxSize)
 Resolves the given URI. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSDKUtil_systemHasExternalSLAM ()
 Returns wether or not the system supports external SLAM (ARKit, ARCore, HoloLens). More...
 
VL_SDK_API void VL_CALLINGCONVENTION vlSetLogBufferSize (unsigned int maxEntries)
 Sets the maximum number of log messages in the log buffer. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSetLogLevel (int level)
 Sets the log level. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetR (vlSimilarityTransformWrapper_t *similarityTransformWrapper, float q[], unsigned int elementCount)
 Returns the rotation of the contained transform. More...
 
VL_SDK_API float VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetS (vlSimilarityTransformWrapper_t *similarityTransformWrapper)
 Returns the scale factor $s$ of the given SimilarityTransform. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetT (vlSimilarityTransformWrapper_t *similarityTransformWrapper, float t[], unsigned int elementCount)
 Returns the translational part of the contained transform. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_GetValid (vlSimilarityTransformWrapper_t *similarityTransformWrapper)
 Returns whether the contained transform is valid (the tracking was successful). More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetR (vlSimilarityTransformWrapper_t *similarityTransformWrapper, const float q[], unsigned int elementCount)
 Sets the rotation of the contained transform. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetS (vlSimilarityTransformWrapper_t *similarityTransformWrapper, float s)
 Sets the scale factor $s$ of the given SimilarityTransform. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlSimilarityTransformWrapper_SetValid (vlSimilarityTransformWrapper_t *similarityTransformWrapper, bool value)
 Sets the valid flag of the given SimilarityTransform. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddCalibratedImageListener (vlWorker_t *worker, vlCallbackCalibratedImageWrapper listener, void *clientData, vlImageFormat format)
 Registers a listener for CalibratedImage events. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddDebugImageListener (vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
 Register a listener for debug image events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddExtrinsicDataListener (vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
 Registers a listener for ExtrinsicData events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddImageListener (vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
 Registers a listener for image events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddIntrinsicDataListener (vlWorker_t *worker, vlCallbackIntrinsicDataWrapper listener, void *clientData)
 Registers a listener for IntrinsicData events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataExtrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackExtrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataImageListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackImageWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataIntrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackIntrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataSimilarityTransformListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackSimilarityTransformWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeTrackingStateListener (vlWorker_t *worker, const char node[], vlCallbackZString listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddPerformanceInfoListener (vlWorker_t *worker, vlCallbackZString listener, void *clientData)
 Registers a listener for performance information events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddTrackingStateListener (vlWorker_t *worker, vlCallbackZString listener, void *clientData)
 Registers a listener for tracking state events. More...
 
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 certain anchor. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddWorldFromCameraTransformListener (vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
 Registers a listener for world from camera transform events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ClearListeners (vlWorker_t *worker)
 Removes all listeners. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlWorker_GetDeviceInfo (vlWorker_t *worker)
 Returns a JSON string with information about the current device. More...
 
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. More...
 
VL_SDK_API vlImageWrapper_t *VL_CALLINGCONVENTION vlWorker_GetImageSync (vlWorker_t *worker)
 Returns a pointer to the camera image. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlWorker_GetLicenseInformation (vlWorker_t *worker)
 Retrieves actual license information as a JSON encoded string. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
VL_SDK_API char *VL_CALLINGCONVENTION vlWorker_GetNodeTrackingStateJsonSync (vlWorker_t *worker, const char node[])
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_IsRunning (vlWorker_t *worker)
 Returns whether the thread is currently running or not. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_LoadPlugin (vlWorker_t *worker, const char pluginName[])
 Loads the plugin with the given name. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Lock (vlWorker_t *worker)
 For testing purposed. Don't use!
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_PollEvents (vlWorker_t *worker)
 Calls the registered listeners for the enqueued events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessCallbacks (vlWorker_t *worker)
 Executes all enqueued callbacks. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ProcessJsonCommandSync (vlWorker_t *worker, const char jsonString[], vlCallbackJsonString callback, void *clientData)
 Processes the passed command. More...
 
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. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveCalibratedImageListener (vlWorker_t *worker, vlCallbackCalibratedImageWrapper listener, void *clientData, vlImageFormat format)
 Unregisters a listener from CalibratedImage events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveDebugImageListener (vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
 Unregisters a listener from debug image events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveExtrinsicDataListener (vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
 Unregisters a listener from ExtrinsicData events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveImageListener (vlWorker_t *worker, vlCallbackImageWrapper listener, void *clientData)
 Unregisters a listener from image events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveIntrinsicDataListener (vlWorker_t *worker, vlCallbackIntrinsicDataWrapper listener, void *clientData)
 Unregisters a listener from IntrinsicData events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataExtrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackExtrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataImageListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackImageWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataIntrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackIntrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataSimilarityTransformListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackSimilarityTransformWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeTrackingStateListener (vlWorker_t *worker, const char node[], vlCallbackZString listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemovePerformanceInfoListener (vlWorker_t *worker, vlCallbackZString listener, void *clientData)
 Unregisters a listener from performance info events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveTrackingStateListener (vlWorker_t *worker, vlCallbackZString listener, void *clientData)
 Unregisters a listener from tracking state events. More...
 
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 by a certain anchor. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveWorldFromCameraTransformListener (vlWorker_t *worker, vlCallbackExtrinsicDataWrapper listener, void *clientData)
 Unregisters a listener from world from camera transform events. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_ResetCameraCalibrationDB (vlWorker_t *worker)
 Removes all references to all manually set calibration data bases. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RunOnceSync (vlWorker_t *worker)
 Processes the enqueued commands and the tracking once. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetLicenseFileData (vlWorker_t *worker, const char licenseFileData[])
 Allows to inject the license data from memory. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_SetLicenseFilePath (vlWorker_t *worker, const char licenseFilePath[])
 Sets the path of the license file. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Start (vlWorker_t *worker)
 Starts the tracking thread. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Stop (vlWorker_t *worker)
 Stops the tracking thread. More...
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_Unlock (vlWorker_t *worker)
 For testing purposed. Don't use!
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_WaitEvents (vlWorker_t *worker, unsigned int timeout)
 Waits for enqueued events and calls the registered listeners. More...
 

Detailed Description

This file contains all functions of the VisionLib SDK.

Include this file for using the VisionLib in your software.

See also
http://www.visionlib.com