Area Target Generator User Guide

The Area Target Generator (ATG) is a Vuforia developed desktop application that takes a 3D scanned model as input and generates an Area Target dataset in Unity and native formats, as well as a mesh in binary GLTF (GLB) format suitable for native development. The ATG connects via API token to your Matterport™ account to retrieve the Matterport™ scanned environment and to your Vuforia Developer Account for authentication.

Installing the Area Target Generator

Minimum System Requirements:

  • The Area Target Generator is supported on Windows and macOS. Please see the table on Supported Versions for more details.

Get the ATG tool for your operating system from: https://developer.vuforia.com/downloads/tool.

The ATG is linked to your developer account and can be used after you log in with your developer credentials and your Matterport™ account credentials. For easy access over multiple ATG launches, the credentials can be stored in the Windows credential store or the macOS Keychain by checking the Remember me box. The credentials will be removed again if you select Sign Out from the home screen.

The ATG is available as an installer for Windows (.exe) and macOS (.dmg). Download the installer and follow the steps to install the software.

For Windows

  • Open the downloaded installer and choose whether to install for one or all accounts and, thereafter, select the directory to install the Area Target Generator to. A shortcut is automatically created on your desktop when the installation is complete.
Vuforia Image

For macOS

  • Open the downloaded installer and drag the installer file to the Applications folder to install the tool. For repeated use, you can create a shortcut on your desktop or pin the app to the start-menu.
Vuforia Image

NOTE: Currently, the ATG requires the Matterport™ generated MatterPak™ 3D models. For instructions on purchasing this model, please consult our Scanning Guide Using Matterport™ or visit Matterport’s own Guide. It is not required to manually download the MatterPak™ bundle after purchase as the ATG will retrieve the necessary data directly from your Matterport™ account.

NOTE: The Area Target Generator is very similar in appearance to the Model Target Generator (MTG). However, they are purposed for two different target types and can therefore not be used as a substitution of one another.

Retrieving the Matterport™ API Token

The ATG requires access to the model tied to your Matterport™ account. It gains access through your unique Matterport™ API Token. The Token ID and the Token Secret can be accessed in my.matterport.com under your Account Settings.

  • Navigate in the Settings tab, to Developer Tools -> API Token Management.
  • In that section of the settings, you can Request a Token ID and a Token Secret pair. 
  • Copy&paste the generated token-pair in the dedicated fields to provide access for the ATG to retrieve your models. You may revoke the access again in your Matterport™ account. After revoking and restarting, the ATG will again request you to enter a working token pair upon the next target generation attempt.

NOTE: The Token Secret is only visible right after you pressed confirm. It will not be available after you close the window! You should, therefore, have the ATG opened in order to securely copy the secret in to the ATG. If you miss this step, you will need to revoke the token ID and secret and repeat the above steps. Revoking a token ID can be done in the Public Tokens list embedded into the API Token Management section. For additional support please see Matterport™ API documentation.

Vuforia Image

Area Target Generator Interface

The ATG is similar in layout as the Model Target Generator (MTG). To begin with, your Vuforia Developer account will have a quota of 10 Area Targets. Additional quota can be acquired through licensing. Please see the Vuforia Pricing page for more information.

Vuforia Image

In the top left, new Area Targets can be created. The top right panel has buttons for User guides, Support, and Sign out. By signing out, you release the stored Vuforia and Matterport™ access details and close the ATG. You will be required to input valid credentials on the next application launch.

Continue to How to Create Area Targets for a step-by-step guide on using the ATG.

Using the Output Files  

The ATG generates a Vuforia Dataset for native development in *.dat and *.xml formats, as well as a *.unitypackage. The Unity dataset package contains in addition to the tracking dataset a textured mesh of the scanned environment in GLB format. This representation can be used to author augmentations into the environments in the Unity Editor. See Using Area Targets in Unity and Area Targets Native Workflow for guidance on importing the dataset into your project environment.

Learn More

Area Targets Native Workflow

How to Create Area Targets

Scanning Guide Using Matterport™

Using Area Targets in Unity