All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
Vuforia Engine

Classes

class  VuforiaApplication
 The VuforiaApplication class provides a way to initialize and deinitialize Vuforia as well register to lifecycle events. More...
 
class  VuforiaBehaviour
 The central Vuforia class. Allows to start and stop the engine and provides access to the current state and physical camera among other things. More...
 
class  VuforiaConfiguration
 Global settings for Vuforia which are used for all scenes. More...
 

Enumerations

enum  FusionProviderOption {
  PREFER_PLATFORM_FUSION_PROVIDER ,
  VUFORIA_FUSION_ONLY
}
 Options for the Fusion Provider configuration. Use VuforiaApplication.Instance.Initialize(FusionProviderOption) to initialize Vuforia with the selected configuration. More...
 
enum  FusionProviderType {
  UNKNOWN = 1 ,
  VISION_ONLY = 2 ,
  SENSOR_FUSION = 3 ,
  PLATFORM_SENSOR_FUSION = 4
}
 Used when calling GetActiveFusionProvider() More...
 
enum  LogLevel {
  ALL ,
  ERROR_AND_WARNING ,
  ERROR ,
  NONE
}
 Log level for Vuforia logging. More...
 
enum  VuforiaEngineError {
  INVALID_LICENSE = 0x600 ,
  CAMERA_DEVICE_LOST = 0x601
}
 VuforiaEngineError is an error value that Vuforia reports when a lifecycle-related engine error occurs after initialization. More...
 
enum  VuforiaInitError {
  NONE = 0x0 ,
  DEVICE_NOT_SUPPORTED = 0x1 ,
  PERMISSION_ERROR = 0x2 ,
  LICENSE_ERROR = 0x3 ,
  INITIALIZATION = 0x4 ,
  DRIVER_CONFIG_LIBRARY_NOT_FOUND = 0x100 ,
  DRIVER_CONFIG_LOAD_ERROR = 0x101 ,
  DRIVER_CONFIG_FEATURE_NOT_SUPPORTED = 0x102 ,
  LICENSE_CONFIG_MISSING_KEY = 0x200 ,
  LICENSE_CONFIG_INVALID_KEY = 0x201 ,
  LICENSE_CONFIG_NO_NETWORK_PERMANENT = 0x202 ,
  LICENSE_CONFIG_NO_NETWORK_TRANSIENT = 0x203 ,
  LICENSE_CONFIG_BAD_REQUEST = 0x204 ,
  LICENSE_CONFIG_KEY_CANCELED = 0x205 ,
  LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH = 0x206 ,
  LICENSE_CONFIG_UNKNOWN = 0x207 ,
  PLATFORM_ANDROID_CONFIG_INITIALIZATION_ERROR = 0x510 ,
  PLATFORM_ANDROID_CONFIG_INVALID_ACTIVITY = 0x511 ,
  PLATFORM_ANDROID_CONFIG_INVALID_JAVA_VM = 0x512
}
 VuforiaInitError is an error value that is returned by Vuforia if something goes wrong at initialization. More...
 
enum  WorldCenterMode {
  SPECIFIC_TARGET ,
  FIRST_TARGET ,
  DEVICE
}
 The world center mode defines how the relative coordinates between Trackables and camera are translated into Unity world coordinates. If a world center is present the virtual camera in the Unity scene is transformed with respect to that. The world center mode is set through the Unity inspector. More...
 

Detailed Description

Enumeration Type Documentation

◆ FusionProviderOption

Options for the Fusion Provider configuration. Use VuforiaApplication.Instance.Initialize(FusionProviderOption) to initialize Vuforia with the selected configuration.

Enumerator
PREFER_PLATFORM_FUSION_PROVIDER 

When initializing Vuforia, try to use the platform Fusion Provider. If not supported by the device, Vuforia will automatically fallback to the next best configuration available.

VUFORIA_FUSION_ONLY 

When initializing Vuforia, do not try to use the platform Fusion Provider and use the Vuforia Fusion Provider instead.

◆ FusionProviderType

Used when calling GetActiveFusionProvider()

Vuforia Fusion is a capability that is designed to provide the best possible AR experience on a wide range of devices. Fusion solves the problem of fragmentation in AR-enabling technologies, including cameras, sensors, chipsets, and software frameworks such as ARKit, ARCore and Windows Holographic. It senses the capabilities of the underlying device and fuses them with Vuforia features, allowing developers to rely on a single Vuforia API for an optimal AR experience.

The FusionProviderType enums provide advanced developers with a way to control which technologies Fusion will use. Developers using these APIs should be aware:

  • of the functionality provided by the underlying platforms
  • of the technology involved in enabling AR
  • of the robustness of the various options
  • that features such as GroundPlane will cease to work. ModelTargets will operate in a less robust manner if VUFORIA_VISION_ONLY is selected.
Enumerator
UNKNOWN 

Fusion provider is unknown.

VISION_ONLY 

Use vision-based Fusion only. Please note that not all Vuforia Engine features are supported when using this provider.

SENSOR_FUSION 

Use Vuforia-provided technology for Fusion. Vuforia Engine will make use of camera and IMU information to try to create a tracking experience that, when compared to vision-only, is more robust to erratic motions and sparse or featureless environments.

PLATFORM_SENSOR_FUSION 

Use platform-provided technology for Fusion. Vuforia Engine will make use of tracking services offered by the underlying platform, such as ARKit on iOS, ARCore on Android, or Windows Holographic on UWP.

◆ LogLevel

enum LogLevel

Log level for Vuforia logging.

Enumerator
ALL 

Logs all messages.

ERROR_AND_WARNING 

Logs only errors and warnings.

ERROR 

Logs only error messages.

NONE 

Disables Vuforia logging.

◆ VuforiaEngineError

VuforiaEngineError is an error value that Vuforia reports when a lifecycle-related engine error occurs after initialization.

Enumerator
INVALID_LICENSE 

License key validation has failed.

CAMERA_DEVICE_LOST 

The operating system has reported that the camera device has become unavailable to Vuforia. This may be because of a device error or another App or user action has caused the operating system to close Engine's connection to the camera.

◆ VuforiaInitError

VuforiaInitError is an error value that is returned by Vuforia if something goes wrong at initialization.

Enumerator
NONE 

No error.

DEVICE_NOT_SUPPORTED 

The device is not supported.

PERMISSION_ERROR 

One or more permissions required by Vuforia Engine are missing or not granted by user.

LICENSE_ERROR 

A valid license configuration is required.

INITIALIZATION 

An error occurred during initialization of the Vuforia Engine instance (e.g. an instance already exists)

DRIVER_CONFIG_LIBRARY_NOT_FOUND 

Specified library file not found.

DRIVER_CONFIG_LOAD_ERROR 

An error occurred while loading the driver.

DRIVER_CONFIG_FEATURE_NOT_SUPPORTED 

Vuforia Driver is not supported by the current license.

LICENSE_CONFIG_MISSING_KEY 

License key is missing.

LICENSE_CONFIG_INVALID_KEY 

Invalid license key passed to SDK.

LICENSE_CONFIG_NO_NETWORK_PERMANENT 

Unable to verify license key due to network (Permanent error)

LICENSE_CONFIG_NO_NETWORK_TRANSIENT 

Unable to verify license key due to network (Transient error)

LICENSE_CONFIG_BAD_REQUEST 

Malformed request sent to license server. Please ensure your app has valid name and version fields.

LICENSE_CONFIG_KEY_CANCELED 

Provided key is no longer valid.

LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH 

Provided key is not valid for current product.

LICENSE_CONFIG_UNKNOWN 

Unknown error.

PLATFORM_ANDROID_CONFIG_INITIALIZATION_ERROR 

An error occurred during initialization of the platform. Note that these errors are generated only when the Engine is used on an Android device.

PLATFORM_ANDROID_CONFIG_INVALID_ACTIVITY 

Invalid Android Activity jobject passed to the configuration.

PLATFORM_ANDROID_CONFIG_INVALID_JAVA_VM 

Invalid Java VM (JavaVM*) passed to the configuration.

◆ WorldCenterMode

The world center mode defines how the relative coordinates between Trackables and camera are translated into Unity world coordinates. If a world center is present the virtual camera in the Unity scene is transformed with respect to that. The world center mode is set through the Unity inspector.

Enumerator
SPECIFIC_TARGET 

User defines a single Trackable that defines the world center.

FIRST_TARGET 

Tracker uses the first Trackable that comes into view as the world center (world center changes during runtime).

DEVICE 

The device/camera is considered the world center, trackables are positioned with respect to it.