This guide gives you an overview of how to create a target collection that you can use to detect and track images within your augmented reality experience.
In general the conversion can be done via four different tools:
- Wikitude Studio Manager: A browser based tool to convert your images to a wtc file. You can find the tool under: https://targetmanager.wikitude.com. You need your free developer account to log-in. This tool is described in more detail further below.
- WTC Editor within Unity Editor: The Wikitude Unity plugin installs a WTC Editor as extension of the Unity Editor. Unity developers can manage all their targets and target collections directly within Unity Editor. Please consult the Unity documentation on more details.
- RESTful API: The Cloud Recognition Manager API provides a RESTful API to upload target images and convert them to wtc files. Read more details in the section about Cloud Recognition API
- Targets Enterprise Script: A binary shell script available for Mac OS X and Linux converting images to target collections. Pleases contact Wikitude Sales team for technical requirements and pricing.
The following images describes the relationship between the above mentioned methods and the Wikitude Cloud Recognition Service, which is not scope of this documentation.
Wikitude Studio Manager
Add a new project
- Open https://targetmanager.wikitude.com and login with your Wikitude developer account
- Add a new project to your project collection
Add target images
- Enter an existing project
- Add new target images to the project either by clicking on
Add Targetsor drag & drop them on the empty area. Supported file formats include PNG and JPEG. If you are using PNG images, please make sure that it does not contain any transparent pixels, only solid coloured images are supported.
- When uploading a target the file name is used as
target name. It identifies a target in your experience. If the
target nameis not completely visible, hover over it to reveal the full name or double click the target to enter edit-mode.
If you add your own target images you need the target name to set them in
- 0 stars: Not suitable for tracking. This target image cannot be tracked because it lacks textured features with high local contrast. Please consider choosing another target image.
- 1 star: Limited tracking ability. This target image provides basic tracking performance in good lightning conditions. Please consider improving the image
- 2 stars: Good tracking ability. This target image will track well in most conditions.
- 3 stars: Very good tracking ability. This target image will track very well in most conditions.
General advice for reference images
- Good image characteristics:
- Diversely textured image with high local contrast
- Bad image characteristics:
- Large areas with solid color or smooth color transitions
- Repetitive patterns
- Logos, signs
Create a WTC file
- AR.TargetCollectionResource WTC (Wikitude Target Collection) file which contains all information of the targets that should be recognized. Enter the project you need the file for and click the WTC icon in the toolbar.
- Select the Wikitude SDK version you're using and click Generate to trigger the creation of the WTC file. You will be notified via e-Mai once the file is available for download.
Use project's WTC file in your ARchitect World
AR.TargetCollectionResource for instructions on how to use the created target collection for augmentations in your ARchitect Worlds.
Any existing project may also be published to the Cloud to make it accessible for [
Click the Cloud icon in the toolbar for more details.
Cloud Recognition is available for free in your testing process but you must purchase a license for productive use. Learn more
Once a project is published it is accessible via Wiktiude SDK using 'Client Token' and 'Target Collection ID' (compare
You may unpublish a project at any time but be aware that this action has immediate effect on your application(s) making use of the credentials.
Metadata in the 'Edit Target' dialog is solely relevant for Cloud Recognition whereat Physical Height is only relevant for distanceToTarget feature.
Leave Physical Height empty if you do not use the distanceToTarget feature of
The Metadata field is very useful. It allows you to attach JSON data to a target. That way you can define any kind of additional data and react on it dynamically in the SDK to e.g. let a button refer to a details page which is defined in the Metadata JSON.
Over time the format and the capabilities of Wikitudes target collection data format have changed. The following table summarizes which version of the Wikitude SDK can handle which wtc version. Wikitude Studio Manager is capable of producing wtc files compatible with all mentioned versions. If you need to re-create a target collection go there and select the appropriate SDK version.
|Wikitude SDK 3.x||Wikitude SDK 4.0||Wikitude SDK 4.1||Wikitude SDK 5.0||Wikitude SDK 5.1-5.3||Wikitude SDK 6.0||Wikitude SDK 6.1|
|wtc 3.x||supported||supported||supported||not supported||not supported||not supported||not supported|
|wtc 4.0||not supported||supported||supported||not supported||not supported||not supported||not supported|
|wtc 4.1||not supported||not supported||supported||supported||supported||supported||supported|
|wtc 5.0||not supported||not supported||not supported||not supported||not supported||supported||supported|