FAQ

Can I change my account password?

Yes, you can change your account password. Login and go to your account information. Then, set the new password.

Can I change my registration email?

Unfortunately, you cannot change the email address associated to your account on your own.

However, in such cases, please write us an email at request@visionlib.com, including the new email address and the current email-address, which should be changed.

How can I delete my account?

In case you want to stop using VisionLib or its services, please write an email to request@visionlib.com.

How can I unsubscribe from email notifications?

You can unsubscribe from VisionLib mailings either by clicking the appropriate unsubscribe link from within the newsletters you have received. Or you can uncheck the email option in your account settings. To do so, login and go to your account information.

Please note, that you cannot unsubscribe from service emails associated to the VisionLib platform, or to VisionLib products and services without stopping to use them.

I forgot my account password, can I reset it?

If you have lost or forgot your password, you can reset and request a new password on the lost password page.

Deployment

My app doesn’t start anymore after 5 times

This happens, when you deploy a VisionLib-based augmented reality application with the trial, developer or other non-commercial license type. For deployment, you need to obtain an appropriate license.

You can find more information on licensing in the documentation. To request a different license or pricing, please write us at request@visionlib.com.

General

What do I need to start developing with VisionLib?

You can start exploring and testing VisionLib within a 30-days trial. You’ll need a trial license, which you get after registering.

After the trial, we recommend using a developer license, when first creating VisionLib-based applications. As soon as the application is finished or ready for distribution, you can obtain a deployment/distribution license for specific applications. You can request these and get other license details by writing us at request@visionlib.com.

Where can I download the SDK?

You can find and download the SDK and all other files from your download list in the customer area. Click on “common” to open the download list and select the desired download items.

HoloLens

Can I use VisionLib together with the Mixed Reality Toolkit?

Yes, it’s possible to use the Mixed Reality Toolkit with VisionLib. See the integration guide in the documentation.

Does VisionLib run on HoloLens?

Yes, it does. You can use VisionLib’s enhanced Model Tracking on HoloLens 1 & 2 and benefit from its object localization properties. Within the VisionLib Unity package, there is an example scene you can use to test VisionLib on HoloLens: follow the VisionLib for HoloLens-Tutorial.

The augmentation on HoloLens has an offset.

We recommend testing the tracking of your model with a mobile or desktop application first, to optimize tracking parameters more quickly.

Still, holograms on HoloLens can be displaced some centimeters, depending on the position of the glasses in front of your eyes. This can easily be solved by moving the HoloLens on your head a little with your hands to adjust the fitting.

Licensing

Can I extend the trial license?

The trial license is valid only within a limited time frame. Although we grant an extension from time to time, this is not an automated process. If you want to extend your trial license, please write us at request@visionlib.com.

Once an extension has been granted, you can download the updated trial license under ‘personal’ from your download list in the customer area.

How can I renew my license?

If you like to renew your license file, please write us at sales@visionlib.com

How do I buy a license or get further licensing information?

If you want to buy a license, or if you have question about licensing details, please write us at sales@visionlib.com. In this email, please provide some details, like:

  • which devices are you planning to deploy to?
  • how many models are you going to use?
  • how many apps do you want to create?

Besides, a general license type overview can be found in the documentation at Licensing.

How do I get or generate the hash code for my tracking reference model(s)?

Some VisionLib distribution licenses have a maximum number of 3D models you can use as tracking reference. If you want to obtain such a license, our team will likely ask you for the (3D) model hash codes. You can generate them by using the VisionLib License Tool:

  • Run the (VisionLib) License Tool in a console
    Once you have downloaded the VisionLib SDK, unzip it and look for the Tools/ folder inside it. Then, open this folder inside a Terminal, Command Line or Command Prompt app on your desktop and run this command (inside the Tools/ folder):

    LicenseTool -m <PATH_TO_MODEL1> -m <PATH_TO_MODEL2>
    MacOS: ./LicenseTool -m <PATH_TO_MODEL1> -m <PATH_TO_MODEL2>

For more details, have also a look in the documentation at Licensing.

How do I get rid of the watermark?

The watermark is only showing up when using the trial or developer license. To remove it, you need to purchase another license type. You can find an overview on options and limitations of all license types in the documentation at Licensing.

If you want to buy a license right away, please contact us at sales@visionlib.com.

How do I see what license I am using in my project?

You can read and print the license details by using the VisionLib License Tool:

  • Run the (VisionLib) console License Tool
    Once you have downloaded the VisionLib SDK, unzip it and look for the Tools/ folder inside it. Then, open this folder inside a Terminal, Command Line or Command Prompt app on your desktop and run this command (inside the Tools/ folder) in order to print information about the given license:

    LicenseTool -l <PATH_TO_LICENSE_FILE>

For more details, also have a look in the documentation at Licensing.

How to I retrieve my hostID for my developer or distribution license?

Some VisionLib licenses are host-bound. In order to obtain and request such licenses, our team will likely ask you for your hostID. The hostID is not similar to a MAC address or whatsoever. You can read and plot the hostID in these ways:

  • Run a VisionLib-based scene in Unity
    Whenever you run a VisionLib-based Unity scene (e.g. one of the VL examples scenes) in the Unity editor, VisionLib will print the hostID in the console log. If this is your development engine, you can copy and use this hostID
  • Use the (VisionLib) License Tool in a console
    Once you have downloaded the VisionLib SDK, unzip it and look for the Tools/ folder inside it. Then, open this folder inside a Terminal, Command Line or Command Prompt app on your desktop and run this command (inside the Tools/ folder):

    LicenseTool -i
    MacOS: ./LicenseTool -i

    Note, that on some machines the window might quit too quickly, when double clicking the .exe file out of a file browser. Thus, we recommend using the CLI commands.

For more details, also have a look in the documentation at Licensing.

Is there an Academic License (for student, funded or education projects)?

Yes, there is an academic license for non-commercial application and use.

Academic licenses can be granted in case of NON-commercial usage in student projects, classes of universities, schools, for education purposes and or research projects. But only if there’s NO money of direct third party involved. This particularly excludes publishing or doing research in the frame of EU or otherwise funded projects, e.g. by a 3rd party company, and excludes any kind of pilots.

As such, academic licenses are usually expiring as soon as the research project or class has been finished. They can be issued by Visometry on individual assessment. They do not include any support or warranties.

You can apply for an academic license by writing an email to request@visionlib.com. Please provide information about your project objective and the scope of how you want to use the VisionLib SDK, and provide a time frame.

My license file is inside the StreamingAssets folder but still doesn’t work.

When using VisionLib with Unity, make sure you’ve copied a valid license file into the StreamingAssets/VisionLib/ folder. Also check the name of the file: if it is not named “license.xml”,  drag and drop it in the public field of the VLTrackingConfiguration component on the VLTracking GameObject.

If you still encounter problems, send us an email at request@visionlib.com and attach your license file. We’ll check, if something is wrong with your file.

VisionLib is not working, because a valid license file is missing.

Be it within the trial time or regularly use, you always need license file to run VisionLib.

You get all your (active) licenses from the download list in your customer-area. Click on “common” to open the list. In order to use the license file in Unity, copy it into the StreamingAssets/VisionLib/ folder and if it is not named “license.xml”, drag and drop it in the public field of the VLTrackingConfiguration component on the VLTracking GameObject.

VisionLib will blame if your license file has expired. In such cases, write us at sales@visionib.com.

Where can I download the (trial) license file?

You can find and download all your licenses from your download list in the customer area. Click on “personal” to open the download list or look for it at the end of the download list.

Where can I find an overview of all VisionLib license types?

You can find an overview on options and limitations of all license types in the documentation at Licensing.

Where do I need to put the license file?

When using VisionLib with Unity, copy the license file into the StreamingAssets/VisionLib/ folder. And if it is not named “license.xml”, drag and drop it in the public field of the VLTrackingConfiguration component on the VLTracking GameObject.

Will the watermark be removed after buying a (commerical) license?

Yes, the watermark will be removed automatically, once you use your applicable purchased license.

You can find an overview on options and limitations of all license types in the documentation at Licensing. If you want to buy a license right away, please contact us at sales@visionlib.com.

Model Tracking

Can I change the init pose during runtime?

Yes, you can change the init pose during runtime by moving the VLInitCamera prefab. Please see also these articles on  working with init poses and re-initialization in the documentation.

Can I detect my physical objects from any position?

Yes, basically you can. It’s a question of setting an appropriate so called init pose (more info in the documentation). Or you can use Auto Initialization. However, not every object has a well detectable shape or geometry from all angles. Thus, we recommend avoiding to detect or initialize from such (unsuitable) angles that might lead to ambiguousness.

Can I track own, custom objects with VisionLib using my 3D models?

Of course, you can.

You will need well matching 3D models of the physical objects you want to track. VisionLib needs them as so-called model references for tracking.

You can change these 3D models used for tracking before deployment and dynamically during runtime. You can manage 3D model references in the .vl config file.

In Unity, the easiest way is to place your model inside the Streaming Assets folder in your project’s Assets directory and reference it in the .vl config file. You need to use VisionLib’s prefabs or scripts to control the reference model usage. You can also use 3D meshes and GameObjects from the hierarchy as tracking references.

Have a look in the documentation. There are several articles with examples and explanations:

Do I need to prepare my 3D model for tracking?

Although some 3D models might work right away, we do recommend preparing models for tracking purposes. Please read and follow these guideline recommendations in the documentation.

How can I change the model reference used for tracking?

You can change the 3D model used for tracking before deployment and dynamically during runtime. You can change and manage 3D model references in the .vl config file.

In Unity, the easiest way is to place your model inside the Streaming Assets folder in your project’s Assets directory and reference it in the .vl config file. You need to use VisionLib’s prefabs or scripts to control the reference model usage. You can also use 3D meshes and GameObjects from the hierarchy as tracking references (experimental).

Have a look in the documentation. There are several articles with examples and explanations:

 

 

How can I set and change the init pose?

In Unity, init poses are created and set by using the VLInitCamera prefab. Drag&Drop this prefab into your hierarchy.

During development, you can control the init pose by pointing the VLInitCamera towards the 3D model and by moving and placing it accordingly. Choose a placement, that gives you a nice and reasonable spot on your desired tracking target, that defines, from which point you want to it to be found initially.

More information can be found in this article on working with init poses in the documentation.

You can also set an init pose in the .vl config file directly. An example can be found in the Configuration File Reference.

 

 

Is there an ARKit or ARCore or HoloLens SLAM integration?

Yes there is an integration for ARKit, ARCore and HoloLens SLAM. You can use external SLAM techniques and VisionLib’s Model Tracking together. Details on how to use this can be found in the documentation.

With the 20.10.1 release, we also added an integration for ARFoundation. Find more details on the ARFoundation documentation page.

The augmentation on HoloLens has an offset.

We recommend testing the tracking of your model with a mobile or desktop application first, to optimize tracking parameters more quickly.

Still, holograms on HoloLens can be displaced some centimeters, depending on the position of the glasses in front of your eyes. This can easily be solved by moving the HoloLens on your head a little with your hands to adjust the fitting.

The tracking doesn’t (re-)initialize correctly

By default, VisionLib collects and stores further poses on-the-run, in order use them as fallback poses, when tracking gets lost. Sometimes, these poses might be corrupted or inappropriate, though.

You can either call a “soft reset”, which sets VisionLib tracking state to “lost” and resets to the original init-pose. If this doesn’t help, you can further call a “hard reset”, which on top clears the collected pose cache. More on this in this docu article on (re-)initialization.

While initialization, I can’t match the line model with my tracking object: line model or augmentation appear skewed

Aside from the quality threshold ( minInlierRatioInit ), which may be set too high in the -.vl config file for a good initialization, this usually might indicate bad calibration.

Whenever you feel that tracking and initialization are working only moderate, or your line model and your tracked object appear misfitting “here and there” while trying to match them, check if you have set the correct calibration for your (mobile) device or camera. During development, e.g. if you use a USB camera, VisionLib will output, if the calibration data for the device is missing.

There is a video tutorial on YouTube regarding calibration on desktops and calibration on mobiles, and an article in the documentation.

Why Model Tracking?

Model Tracking enables you to localize desired objects in the camera image with means of computer vision techniques. In order to do that, Model Tracking uses 3D (CAD) data of these real physical objects (also called tracking targets) as reference information to enable and “tell” the computer vision system about the objects it should find.

Because 3D data is used, there is no need to train or teach the computer vision system beforehand about the objects it should find.

Instead, and in contrast to other techniques including SLAM and feature tracking, there is no need for prior preparation or pre-acquisitions of the physical tracking targets anymore. Such techniques are good for spontaneous augmentations on-the-fly in almost unknown environments. But they are bad for localizing distinct objects and for “non-constant sceneries”, because they tend to break when objects move, or when lighting conditions change – typical computer vision obstacles.

Model Tracking, in contrast, enables you to precisely pin augmentations to referred objects, and you are thus truly connecting virtual and real domains. It masters the above mentioned obstacles. And, you can gain from a fast and robust object tracking with no further information required, except the 3D models.

Find more background on tracking techniques in the documentation.

SDK

Does VisionLib run on HoloLens?

Yes, it does. You can use VisionLib’s enhanced Model Tracking on HoloLens 1 & 2 and benefit from its object localization properties. Within the VisionLib Unity package, there is an example scene you can use to test VisionLib on HoloLens: follow the VisionLib for HoloLens-Tutorial.

How do I get or generate the hash code for my tracking reference model(s)?

Some VisionLib distribution licenses have a maximum number of 3D models you can use as tracking reference. If you want to obtain such a license, our team will likely ask you for the (3D) model hash codes. You can generate them by using the VisionLib License Tool:

  • Run the (VisionLib) License Tool in a console
    Once you have downloaded the VisionLib SDK, unzip it and look for the Tools/ folder inside it. Then, open this folder inside a Terminal, Command Line or Command Prompt app on your desktop and run this command (inside the Tools/ folder):

    LicenseTool -m <PATH_TO_MODEL1> -m <PATH_TO_MODEL2>
    MacOS: ./LicenseTool -m <PATH_TO_MODEL1> -m <PATH_TO_MODEL2>

For more details, have also a look in the documentation at Licensing.

How do I see what license I am using in my project?

You can read and print the license details by using the VisionLib License Tool:

  • Run the (VisionLib) console License Tool
    Once you have downloaded the VisionLib SDK, unzip it and look for the Tools/ folder inside it. Then, open this folder inside a Terminal, Command Line or Command Prompt app on your desktop and run this command (inside the Tools/ folder) in order to print information about the given license:

    LicenseTool -l <PATH_TO_LICENSE_FILE>

For more details, also have a look in the documentation at Licensing.

How to I retrieve my hostID for my developer or distribution license?

Some VisionLib licenses are host-bound. In order to obtain and request such licenses, our team will likely ask you for your hostID. The hostID is not similar to a MAC address or whatsoever. You can read and plot the hostID in these ways:

  • Run a VisionLib-based scene in Unity
    Whenever you run a VisionLib-based Unity scene (e.g. one of the VL examples scenes) in the Unity editor, VisionLib will print the hostID in the console log. If this is your development engine, you can copy and use this hostID
  • Use the (VisionLib) License Tool in a console
    Once you have downloaded the VisionLib SDK, unzip it and look for the Tools/ folder inside it. Then, open this folder inside a Terminal, Command Line or Command Prompt app on your desktop and run this command (inside the Tools/ folder):

    LicenseTool -i
    MacOS: ./LicenseTool -i

    Note, that on some machines the window might quit too quickly, when double clicking the .exe file out of a file browser. Thus, we recommend using the CLI commands.

For more details, also have a look in the documentation at Licensing.

Is there a C-API?

Yes, there is a C-API and other native APIs as well. Look at these articles in the documentation for C-API and Objective-C use.

Where can I download the SDK?

You can find and download the SDK and all other files from your download list in the customer area. Click on “common” to open the download list and select the desired download items.

Unity SDK

My license file is inside the StreamingAssets folder but still doesn’t work.

When using VisionLib with Unity, make sure you’ve copied a valid license file into the StreamingAssets/VisionLib/ folder. Also check the name of the file: if it is not named “license.xml”,  drag and drop it in the public field of the VLTrackingConfiguration component on the VLTracking GameObject.

If you still encounter problems, send us an email at request@visionlib.com and attach your license file. We’ll check, if something is wrong with your file.

Where should I put the license file in Unity?

When using VisionLib with Unity, copy the license file into the StreamingAssets/VisionLib/ folder. And if it is not named “license.xml”,  drag and drop it in the public field of the VLTrackingConfiguration component on the VLTracking GameObject.