documentation

Migrating From 19.11.x to 20.3.1

Level: Basic

This update contains some changes in the native interface. The application of these changes made some files obsolete. Additionally, some internal behaviour and default paths have changed.
To avoid complications when updating an existing project, please refer to the migration guides provided below.

Migration Guide - Obsolete Files

Please remove the following obsolete files (and their .meta files) from your project:

  • Assets/VisionLib/Core/Scripts/Editor/VLDebugImageBehaviourEditor.cs
  • Assets/VisionLib/Core/Scripts/Debug/VLDebugCameraBehaviour.cs
  • Assets/VisionLib/Utilities/Prefabs/Debug/VLDebugCamera.prefab
  • Assets/VisionLib/Utilities/UI/Templates/Notifications/Scripts/VLEventsNotification.cs

Migration Guide - Default License Path

To keep the places of files related to VisionLib at a minimum, we changed the default folder of the license from StreamingAssets to StreamingAssets/VisionLib.
If you never adjusted the license path in the VLWorkerBehaviour you might thus get an error that your license can not be found anymore.

  • To fix this, move your license to StreamingAssets/VisionLib or adjust its path in the VLWorkerBehaviour (located in the scene hierarchy under VLTracking/VLCamera).

Migration Guide - VLDebugImage

The behaviour of the debug image has been changed internally. To be able to use it like before, do the following adjustments:

  • Select the VLDebugImage in your canvas. On its component ImageStreamFilter, select DebugImage if you want to see the grey image or CameraImage if you want to see the camera image for debugging.
  • To be able to use the grey image, please set the debugLevel to 1 inside your tracking configuration. Don't forget to remove this line before your final deploy to increase performance.
"tracker": {
"type": "modelTracker",
"version": 1,
"parameters": {
"modelURI": "project-dir:VLMiniCar.obj",
...
"debugLevel": 1
}

Migration Guide - Access of Image Sequence Parameters

Image sequence parameters can now only be accessed when actually using an image sequence. Trying to access those parameters when using a camera for tracking will print warnings to your console. To fix this:

  • Remove the VLImageSequenceParameters prefab from your scene hierarchy (under VLTracking)
  • If you are using the ImageSourcePanel from the ModelTrackingSetup scene in your canvas, also remove all of its children except Enabled:
  • You will still be able to pause and resume an image sequence by using the remaining enabled checkbox