documentation

vlUnitySDK API

The reference of the UnitySDK functions. More...

Namespaces

namespace  VLCameraCalibrationCommands
 C# Unity Namespace with command classes for communicating with the camera calibration inside the tracking thread.
 
namespace  VLHoloLensModelTrackerCommands
 Namespace with command classes for communicating with the model-based tracking under HoloLens
 
namespace  VLModelTrackerCommands
 Namespace with command classes for communicating with the model-based tracking.
 
namespace  VLWorkerCommands
 C# Unity Namespace with command classes for communicating with the tracking thread.
 

Data Structures

class  VLAbstractApplicationWrapper
 The VLAbstractApplicationWrapper is a wrapper for the AbstractApplication. The AbstractApplication represents the tracking context. More...
 
class  VLAnchorCommand
 Performs a Command to a specific node More...
 
class  VLAnchorHandler
 
class  VLAspectRatioFitter
 Modified version of the original AspectRatioFitter, which also handles rectTransforms with rotations around the z-axis. More...
 
class  VLCameraCalibration
 VLCameraCalibration stores the result of a calibration process. More...
 
class  VLCameraCalibrationAnswer
 
class  VLCameraImageStreamTexture
 The VLCameraImageStream propagates the camera image to its texture More...
 
class  VLDebugImageBehaviour
 The VLDebugImageBehaviour can be used to visualize debug images using the Unity GUI system. More...
 
class  VLDebugImageStreamTexture
 The VLDebugImageStream propagates the debug image to its texture More...
 
class  VLDetectScreenChangeBehaviour
 
class  VLDeviceInfo
 VLDeviceInfo stores information about the system and available cameras. More...
 
class  VLExtrinsicDataWrapper
 The VLExtrinsicDataWrapper is a wrapper for an ExtrinsicData object. ExtrinsicData objects represent the extrinsic camera parameters (position and orientation). More...
 
class  VLFrame
 VLFrame contains the description of one frame for tracking More...
 
class  VLHoloLensInitCameraBehaviour
 Camera used to define the initial pose for the HoloLens model-based tracking. More...
 
class  VLHoloLensStabilizationPlaneBehaviour
 Positions stabilization plane over VLHoloLensTrackerBehaviour content. More...
 
class  VLHoloLensTrackerBehaviour
 Manages the model-based initialization of the HoloLens tracking. More...
 
class  VLImageStreamFilter
 
class  VLImageStreamTexture
 
class  VLImageWrapper
 The VLImageWrapper is a wrapper for an Image object. More...
 
class  VLInitCameraBehaviour
 Camera used to define the initial pose. More...
 
class  VLIntrinsicDataWrapper
 The VLIntrinsicDataWrapper is a wrapper for an IntrinsicData object. IntrinsicData objects represent the intrinsic camera parameters (focal length, principal point, skew and distortion parameters). More...
 
class  VLJsonUtility
 VisionLib functions for working with JSON data. More...
 
class  VLLicenseFile
 
class  VLLicenseInformation
 VLLicenseInformation stores information about the current license. More...
 
class  VLLogEventsBehaviour
 The VLLogEventsBehaviour can show VisionLib events as notifications on screen and console log. More...
 
class  VLLogger
 ... More...
 
class  VLModelDeserializationResult
 VLModelDeserializationResult stores associated data of the models. More...
 
class  VLModelDeserializationStructure
 VLModelDeserializationStructure stores the internal states of the model which is used for model based tracking. Such an object is usually passed, when calling VLWorker.PushJsonAndBinaryCommand with an addModelData command. More...
 
class  VLModelProperties
 VLModelProperties stores the internal states of the model which is used for model based tracking. Such an object is usually passed, when subscribing to the OnGetModelProperties event. More...
 
class  VLModelPropertiesStructure
 VLModelProperties stores the internal states of the model which is used for model based tracking. Such an object is usually passed, when subscribing to the OnGetModelProperties event. More...
 
class  VLModelTrackableBehaviour
 Behaviour, which enables the user to use the GameObjects mesh for tracking. NOTE: This behaviour is considered as BETA. Please do not alter this file unless you know what you are doing - it is considered to be changed and optimized in future versions. More...
 
class  VLModelTrackerBehaviour_v1
 The VLModelTrackerBehaviour_v1 contains all functions, which are specific for the ModelTracker_v1. More...
 
struct  VLPerformanceInfo
 VLPerformanceInfo stores information about the tracking performance. More...
 
class  VLRenderBackgroundImageBehaviour
 Behaviour used for rendering the camera image in the background. More...
 
class  VLRuntimeParameterBehaviour
 The VLRuntimeParameterBehaviour can be used to set tracking parameters at runtime. More...
 
class  VLTrackedObjectBehaviour
 This behaviour fires UnityEvents for VLWorkerBehaviour.OnTrackingStates events. More...
 
class  VLTrackerInfo
 VLTrackingInfo stores the information returned after creating a tracker More...
 
class  VLTrackingCameraBehaviour
 Camera used for rendering the augmentation. More...
 
class  VLTrackingIssues
 VLTrackingIssues stores the issues arrising during startup More information on possible codes: Initialization Issues Such an object is usually passed, when subscribing to the OnTrackerInitializedWithIssues event. More...
 
class  VLTrackingState
 VLTrackingState stores the tracking states of all tracking object. More...
 
class  VLUnityCameraHelper
 Static class with helper functions and constants for doing camera transformations.
 
class  VLUnitySdk
 Static class for storing the global functions of the vlUnitySDK.
 
class  VLWorker
 The VLWorker is a wrapper for an Worker object. The Worker object manages the tracking thread. More...
 
class  VLWorkerBehaviour
 
class  VLWorkerReferenceBehaviour
 Base class for MonoBehaviour, which need access to the VLWorker and VLWorkerBehaviour objects. More...
 
class  VLWorkSpace
 The VLWorkSpace allows the definition of an area, from which the user can initialize the tracking. THIS IS SUBJECT TO CHANGE Please do not rely on this code in productive environments. More...
 
class  VLWorkSpaceManager
 The VLWorkSpaceManager collects the VLWorkSpace definitions from the hierarchy and transfers them to VisionLib during runtime. If VLTrackingAnchors are found in the scene, the VLWorkSpaces will be transferred according to their anchor. THIS IS SUBJECT TO CHANGE Please do not rely on this code in productive environments. More...
 

Enumerations

enum  VLRenderRotation { CCW0 = 0, CCW90 = 2, CCW180 = 1, CCW270 = 3 }
 Enum values describing how the video image acquired through VLSDK calls has to be rotated to match ScreenOrientation. The default render rotation for a given environment can be obtained by calling VLUnityCameraHelper.GetRotationMatrix. More...
 

Detailed Description

The reference of the UnitySDK functions.

The unity plugin is created using the C# language and reflects the C-API. Thus a lot of functions might are familiar. Anyway, due to the nature of Unity and its C# adaption. Various callbacks and are different since they are put into behaviours.

Enumeration Type Documentation

◆ VLRenderRotation

enum VLRenderRotation
strong

Enum values describing how the video image acquired through VLSDK calls has to be rotated to match ScreenOrientation. The default render rotation for a given environment can be obtained by calling VLUnityCameraHelper.GetRotationMatrix.