On-Prem Advanced Model Targets¶

Create instantaneous Advanced Model Targets locally without uploading 3D data to the cloud.

Introduction to On-Prem Advanced Model Targets.¶

On-Prem Advanced Model Targets work the same way as Advanced Model Targets being detectable and tracked from any side of the object it matches.

On-Prem Advanced Model Targets are for developers looking to use Advanced Model Targets without uploading their 3D CAD data to the cloud.

Prerequisites and Limitations¶

For Vuforia Engine, an Enterprise license is required to test and use this feature. Vuforia Studio customers do not need a special license or the plugin files.

To create On-Prem Advanced Model Targets, you need a plugin file (.arc). These are available on your Vuforia account's download page under the Enterprise tab. Users without an Enterprise license will not have access to this tab.

The following platforms and versions are currently supported:

Device support¶

iPhone 12+
- Requires iOS 18+.
- iPhone 15+ is recommended for best performance.
iPad support:
- iPad Pro 5th Gen and later (recommended).
- iPad 10th Gen and later.
- iPad Air 4th Gen and later.
- iPad Mini 5th Gen and later.
- iOS 18+.

On any other devices, the On-prem Advanced Model Target will behave just as a standard (non-Advanced) Model Target. For that purpose, a fallback Guide View can be specified during Model Target generation.

Workstation support¶

Target Generation is supported on the versions that the Model Target Generator and Model Target CLI supports. See Supported Versions for details.

Tip

We recommend running the MTG or MTG CLI in an environment using a CPU with multiple physical cores to support multithreading. Any CPU power saving options should be disabled to ensure maximum performance.

Testing using Unity Play Mode is supported on:
- MacOS 15.0 or later.
- Requires M1 chip or newer.

Generation support¶

Only the OBSERVATION preset is supported.

The On-Prem Advanced Model Target must be generated using the latest (11.1+) Model Target Generator and Model Target CLI tool.

The feature requires two plugin files named onprem-amt-plugin-v1.arc and onprem-amt-cli-plugin-v1.arc.

Downloads¶

Model Target CLI

MacOS
Windows
Linux

Vuforia Engine SDK iOS

Vuforia Engine Unity Extension

Generate an On-Prem Advanced Model Target¶

Use the Model Target Generator (MTG), the Model Target CLI, or Vuforia Studio to generate On-Prem Advanced Model Targets. The MTG and CLI requires plugin files before they can generate On-Prem Advanced Model Targets.

Model Target Generator¶

Log in to the MTG with the account that owns the Enterprise license.

Steps:

Download the plugin files onprem-amt-plugin-v1.arc and onprem-amt-cli-plugin-v1.arc from the Downloads page under the Enterprise tab and add them to the application's resources folder. Make sure to update the plugins if you upgrade to a newer version of Vuforia Engine.

For Windows: Place the files in your \Users\<user>\AppData\Roaming\PTC\Vuforia\ folder.

For Mac: Place the files in your /Users/<user>/Library/Application Support/PTC/Vuforia/ folder. By default that folder is hidden, use Command + Shift + . in Finder to unhide it.
Import the CAD model like other Model Target creation processes and follow the steps in the Model Target Generator.

NOTE: Simplification of complex models currently still requires uploading the CAD model to the secure Vuforia cloud.
In the Guide Views tab, select Create On-Prem Advanced View.
Currently, only the Observation Preset is available.
In the next step, a fallback Guide View can be defined. This will be used on devices that do not support On-Prem Advanced Model Targets.
Confirm the Observation preset and generate the Model Target.

The following files are generated in the output folder:

DAT
XML
onprem-amt-plugin-v1.arc
Unity Asset Package, which also contains a copy of the ARC file.

Model Target CLI¶

Run the Model Target CLI from a terminal or shell window. Make sure to add the onprem-amt-plugin-v1.arc and onprem-amt-cli-plugin-v1.arc files to the resources folder of the Model Target CLI.

For MacOS, you might need to allow running untrusted software: https://support.apple.com/en-us/102445

Steps:

Execute the following:

For Windows/Linux

OfflineModelTargetGenerator --advanced -i viking_lander.json -vu <username> -vp <password>

For Mac

./OfflineModelTargetGenerator --advanced -i viking_lander.json -vu <username> -vp <password>

The password and username are associated with your Vuforia Developer Account. Alternatively, Oauth credentials can be used as well.

The JSON file must specify the OBSERVATION preset. Here’s an example:

{
    "name": "KTM",
    "targetSdk": "10.29",
    "models": [
    {
        "name": "viking_lander",
        "cadDataUrl": "c:/Temp/MyModels/viking_lander.glb",
        "upVector": [0, 0, 1],
        "views": [{
            "name": "viewpoint_0000",
            "recognitionRangesPreset": "OBSERVATION",
            "targetExtentPreset": "FULL_MODEL"
        }]
    }
]
}

The following files are generated. Add -o with a folder path to change the output file directory.

DAT
XML
onprem-amt-plugin-v1.arc
Unity Asset Package, which also contains a copy of the ARC file.

[OK] Model Target dataset creation STARTED
[OK] Model viking_lander has 10 parts and 44852 triangles.
[OK] Skipping Coloring Step
[OK] Successfully created DAT file './Viking Lander.dat'
[OK] Sent analytics to server
[OK] Model Target Unity dataset creation STARTED
[OK] Model Target Unity dataset creation FINISHED
[OK] Created package file './Viking Lander.unitypackage'
[OK] Model Target dataset creation FINISHED

NOTE: Analytics only contain data on authentication credentials and associating generations with the Vuforia Developer account.

Test Your Model Target¶

To run On-Prem Advanced Model Targets, the plugin file onprem-amt-plugin-v1.arc (~115 MB) must be added to the app (either next to the dataset or in a dedicated plugin directory).

First launch¶

The first time you load your app, there will be a noticeable startup delay during runtime, which can last a few seconds. This is due to the plugin file being imported. The second launch should run faster.

Run in Vuforia Creator App¶

This feature requires an up-to-date version of the Vuforia Creator App (11.0 or later).

Download the Vuforia Creator App from the Apple store.
Add the generated DAT file to the Assets folder. See Import and Test Assets for details.
Similarly, the onprem-amt-plugin-v1.arc plugin file needs to be imported.
In the main menu, select the added Model Target to test detection and tracking from any angle with the physical object.

Run in Unity¶

On-Prem Advanced Model Targets have the same authoring workflow as Advanced Model Targets. The only difference is the requirement of adding the plugin file.

NOTE: On-Prem Advanced Model Targets in play mode only work on MacOS (15+) on Macs with an M1 chipset or later.

Import the latest Vuforia Engine Unity extension into your Unity project.
Import the Unity Asset package of your generated On-Prem Advanced Model Target into the project.
Ensure that the onprem-amt-plugin-v1.arc plugin file exists in Assets/StreamingAssets/Vuforia/.
Add an ARCamera GameObject.
Add a license key to the Vuforia configuration.
Create a ModelTarget GameObject and select the database and target name in the Inspector.
Verify that the editor shows a preview of the 3D model.
Ensure that the Model Target is tracked in play mode (MacOS only).
Build to your iOS device.

The first launch is expected to take longer. See the section Test Your Model Target for details.

You only need one copy of the onprem-amt-plugin-v1.arc plugin file regardless of how many Model Targets you use in the application. Vuforia Engine expects, by default, the plugin file to be next to the Model Target dataset when loaded. If you load Model Target datasets from different locations or from dynamic paths at runtime, then the plugin needs to be placed in a configurable plugin directory. By default, that directory is Assets/StreamingAssets/Vuforia/ in your Unity project.

Run in Native sample app¶

The Vuforia Engine Native Sample app can be modifed to load your On-Prem Advanced Model Target:

Download the native sample app for iOS.
Add the generated XML and DAT dataset in the Assets/ModelTargets folder.

Replace the strings for the vuModelTargetConfigDefault().

VuModelTargetConfig modelTargetConfig = vuModelTargetConfigDefault();

modelTargetConfig.databasePath = "VuforiaMars_ModelTarget.xml";
modelTargetConfig.targetName = "VuforiaMars_ModelTarget";
modelTargetConfig.activate = VU_TRUE;

The onprem-amt-plugin-v1.arc file must be placed in a common folder or next to the On-Prem Advanced Model Target database. If using a common folder, the path to the plugin file must be configured in the Vuforia Engine config during initialization.

VuEngineConfigSet* configSet = nullptr;
VuResult vuResult = vuEngineConfigSetCreate(&configSet);
assert(vuResult == VU_SUCCESS);
VuPluginConfig pluginConfig = vuPluginConfigDefault();
pluginConfig.pluginDirectory = "<PATH_TO_COMMON_FOLDER>";

vuEngineConfigSetAddPluginConfig(configSet, &pluginConfig);

Add a license key to the constexpr char licenseKey[] = "";.
Build to your iOS device.

Specific API¶

VuPluginConfigDefault and VuPluginConfig are functions that specify where Vuforia Engine should look for plugins.

Use vuEngineConfigSetAddPluginConfig() to set the directory. If no directory is specified, Vuforia Engine will search in the directory of a created Model Target Observer.

Learn More¶

Advanced Model Targets

Model Target CLI

Model Targets in Unity