Working with VuMark Databases

The VuMark Database can contain VuMark template SVG files. Once a database is created, VuMark instances can be generated in the Vuforia Target Manager. The VuMark Database with the VuMark template and instances can be downloaded to be locally accessible in your AR application. In addition, VuMark instances can also be generated with the Vuforia Web Services.

The Vuforia Target Manager allows you to create, manage, and download VuMark Databases for VuMark instances. See Getting Started with the Vuforia Target Manager.

Create a New VuMark Database

To add a VuMark to your app, you will need to create a VuMark database and add the VuMark to that database. This article will show you how to create a VuMark database and VuMark instances with the Vuforia Target Manager.

To learn how to design a VuMark, please visit the VuMark Design Guide and the Designing a VuMark in Adobe Illustrator.

  1. Go to the Vuforia Developer Portal and log in with your Vuforia Developer credentials.
  2. Select the Target Manager tab and click Generate Database in the upper right corner.
  3. Name the database and select the VuMark database option. The database name should be unique from other databases in the developer account.

 

  1. Click Generate to finish setting up the database.

Add a VuMark to a VuMark Database

  1. On the Target Manager’s home page, you will see a list of existing databases.
  2. In the list of databases, click on the newly created VuMark Database.

NOTE: VuMark templates can only be added to VuMark database types. Device and Cloud Databases will not accept VuMarks.

  1. In the next window, click Add Target.

  1. In the pop-up window, browse and select your VuMark SVG file.
  2. Enter the width of your VuMark in scene units. We recommend defining this to correspond with the printed VuMark's width in whichever unit of measurement you prefer.
    NOTE: Developers looking to use VuMarks in combination with Device Tracking should specify the target size in meters.
  3. Enter a unique name for the VuMark template.
  4. Conclude by clicking Add.
  1.  
  1. The VuMark database is now ready for download and implementation in your development environment. Check the box next to the VuMark template and press the Download Database. The database can be downloaded as a .unitypackage for Unity and as dataset files (.xml and .dat) for native development. 

NOTE: A VuMark Database supports multiple VuMark Templates.

Generate a VuMark instance for Download

In addition to downloading the database, you can generate instances from the VuMark template. A VuMark instance is a printable target with an instance ID that you have specified in the Target Manager.

  1. Click the Generate VuMark link next to the VuMark template to generate an instance image. 

  1. In the pop-up window, enter an ID for your VuMark instance in the supported data format that is stated in the ID Type. The data length (ID) cannot exceed the ID Length value of the VuMark template.
  2. Select the Graphic Format for the VuMark image file and click Download.

  1. The instance image will be downloaded and you may repeat the process to define the instance IDs for more VuMark instance images. 

VuMark instance compatibility

Each VuMark template is assigned a UUID when uploaded to the Target Manager. When a VuMark instance is generated from it, the ID data is encoded using the template’s UUID. This makes each VuMark instance different and unique.

Even if the same VuMark template is uploaded twice to the Target Manager, instances created from the identical VuMark templates will be unique and not recognizable to each other as their UUIDs are different. This is also true even when encoding the same ID data into the VuMark instance (i.e., 101010101).

VuMark Database Access Keys

A VuMark database also has a set of Access Keys. They are located in the VuMark database tab Database Access Keys. The Vuforia Web Service and VuMark instance generation API utilize these keys for authentication and for generating printable instances of that VuMark template.

See Using the VuMark Generation API for a complete guide.

Learn More

Designing VuMarks

VuMark Design Guide

Designing VuMarks in Adobe Illustrator

Using VuMarks

VuMarks in Unity

Vuforia Web Services

Vuforia Web Services

Using the VuMark Generation API

Can this page be better?
Share your feedback via our issue tracker