Namespaces | |
namespace | Internal |
Classes | |
class | AnchorBehaviour |
An anchor that helps stabilize a GameObjects position in the real world More... | |
class | AnchorInputListenerBehaviour |
Provides a convenient way of capturing user interaction (mouse click or screen tap) and forwarding it to another component, e.g. the ContentPositioningBehaviour More... | |
class | AreaTargetBehaviour |
This class serves both as an augmentation definition for an AreaTarget in the editor as well as a tracked AreaTarget result at runtime More... | |
class | AreaTargetCaptureBehaviour |
class | BarcodeBehaviour |
This class serves both as an augmentation definition for a Barcode observer More... | |
interface | BarcodeInstanceData |
class | CameraDevice |
Represents the physical camera used to capture the real world More... | |
class | CloudRecoBehaviour |
This is the main behaviour class that encapsulates cloud recognition behaviour. It just has to be added to a Vuforia-enabled Unity scene and will initialize the target finder and wait for new results. State changes and new results will be sent to registered ICloudRecoEventHandlers More... | |
class | ContentPlacedEvent |
class | ContentPositioningBehaviour |
This class provides convenience methods for anchoring content in the real world. Can be used in combination with the PlaneFinderBehaviour or MidAirPositionerBehaviour to easily place content on a plane or at 3d coordinates More... | |
class | CylinderTargetBehaviour |
This class serves both as an augmentation definition for a CylinderTarget in the editor as well as a tracked CylinderTarget result at runtime More... | |
class | DataSetTrackableBehaviour |
This is the base class for all behaviours observing targets that are part of a dataset More... | |
class | DevicePoseBehaviour |
Represents the device, such as a phone or a digital eyewear device, of which a position is tracked enabling/disabling the Device MonoBehaviour causes the device to start/stop being tracked More... | |
class | GLTFModelCreator |
class | GuideView |
This class represents a Guide View which can be extracted from the DataSet More... | |
class | GuideView2DBehaviour |
Class representing a 2D Guide View for Model Target Detection. More... | |
class | GuideView3DBehaviour |
Class representing a 3D Guide View for Model Target Detection. More... | |
class | GuideViewCameraBehaviour |
This class represents a Guide View Camera, which can be used to configure the guide view pose for detection of a Model Target. When attaching this component to a game object, a Camera will be created automatically. This Camera is only used at Editor time to faciliate the Application developer to adjust the Pose visually by looking at the Camera preview. At runtime, the Camera component will be automatically disabled. More... | |
class | GuideViewRenderingBehaviour |
Class handling the activation/update/rendering of the Guide View for Model Target detection. More... | |
class | HitTestEvent |
An Event that passes a HitTestResult after a performed hit test. HitTestResult can be null. More... | |
class | HitTestResult |
The result of performing a hit test in the world More... | |
class | IlluminationData |
Provides realtime data of real-world illumination calculations by ARKit, when used by Vuforia Fusion More... | |
class | Image |
Representation of an image, typically returned by the CameraDevice. More... | |
class | ImageDescription |
class | ImageTargetBehaviour |
This class serves both as an augmentation definition for an ImageTarget in the editor as well as a tracked image target result at runtime More... | |
class | Intrinsics |
Representation of physical details of the camera. More... | |
interface | ISessionRecorder |
The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More... | |
class | MaskOutBehaviour |
class | MeshSetModelCreator |
class | MidAirPositionerBehaviour |
This class is best used in combination with the AnchorInputListenerBehaviour and the ContentPositioningBehaviour as it provides sanitation of the input and forwards the result to the ContentPositioningBehaviour for mid-air anchor placement More... | |
class | ModelTargetBehaviour |
This class serves both as an augmentation definition for a ModelTarget in the editor as well as a tracked ModelTarget result at runtime More... | |
class | MultiTargetBehaviour |
This class serves both as an augmentation definition for a MultiTarget in the editor as well as a tracked MultiTarget result at runtime More... | |
class | ObserverBehaviour |
The base class of all observer behaviour components. Provides access to base functionality and information of the observer More... | |
class | ObserverFactory |
Provides methods to create Vuforia tracked targets More... | |
class | PlaneFinderBehaviour |
This component provides convenience functionality for typical use cases of detecting a plane and showing a preview of where content would be placed on that plane. Can also be used to perform manual hit tests More... | |
struct | RectangleData |
This struct defines the 2D coordinates of a rectangle. The struct is internally used for setting Virtual Buttons or getting bounding boxes of letters. More... | |
class | RuntimeMeshRenderingBehaviour |
Renders the runtime Mesh of a Vuforia Target More... | |
class | ScalableDataSetTrackableBehaviour |
This is the base class for all trackables that are part of a dataset and are scalable More... | |
class | SessionRecorder |
The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More... | |
class | SessionRecorderBehaviour |
The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More... | |
class | SmartTerrainBehaviour |
struct | TargetStatus |
Includes tracking status and tracking information of a target More... | |
class | TurnOffBehaviour |
A utility behaviour to disable rendering of a game object at run time. More... | |
class | VideoBackground |
Provides access to VideoBackground rendering specific features More... | |
struct | VideoModeData |
This struct stores video mode data. This includes the width and height of the frame and the framerate of the camera. More... | |
class | VirtualButtonBehaviour |
This behaviour associates a Virtual Button with a game object. Use the functionality in ImageTargetBehaviour to create and destroy Virtual Buttons at run-time. More... | |
class | VuforiaApplication |
The VuforiaApplication class provides a way to initialize and deinitialize Vuforia as well register to lifecycle events More... | |
class | VuforiaAugmentationRenderer |
Special Augmentations which need custom render-(dis/en)abling are inherited from this class 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... | |
class | VuforiaMonoBehaviour |
This is the base class for all MonoBehaviours that are used in Vuforia. If no Behaviours of this type are found in a scene, the VuforiaBehaviour will not be automatically attached at runtime. This means no VideoBackground is rendered. More... | |
class | VuforiaRuntimeUtilities |
A utility class containing various helper methods More... | |
class | VuMarkBehaviour |
This class serves both as an augmentation definition for a VuMark in the editor as well as a tracked VuMark result at runtime More... | |
interface | VuMarkInstanceId |
The InstanceId contains the id for a particular VuMark. More... | |
class | World |
Provides functions to perform hit tests and create anchors in the world More... | |
Enumerations | |
enum | AreaTargetCaptureCreationError { NONE = 0x0, INTERNAL = 0x1, AUTOSTART_FAILED, FEATURE_NOT_SUPPORTED, MULTIPLE_INSTANCES_NOT_SUPPORTED, INVALID_DEVICE_POSE_OBSERVER } |
Area Target Capture creation error More... | |
enum | AreaTargetCaptureGenerationError { NONE = 0x0, INTERNAL = 0x1, ENGINE_NOT_RUNNING = 0x2, INVALID_STATUS = 0x3, INSUFFICIENT_DATA = 0x4, MISSING_AUTHENTICATION = 0x5, INVALID_OUTPUT_DIRECTORY = 0x6, INVALID_TARGET_NAME = 0x7, AUTHORING_FILES_GENERATION_REQUIRED = 0x8, DATABASE_GENERATION_REQUIRED = 0x9 } |
Area Target Capture generation error More... | |
enum | AreaTargetCaptureStatus { INITIALIZED = 0x1, PREPARING = 0x2, CAPTURING = 0x3, PAUSED = 0x4, STOPPED = 0x5, GENERATING = 0x6 } |
enum | AreaTargetCaptureStatusInfo { NORMAL = 0x01, RELOCALIZING = 0x02, EXCESSIVE_MOTION = 0x03, CAPACITY_WARNING = 0x04, INTERRUPTED = 0x05, SUSPENDED = 0x06, TRACKING_DATA_GENERATION = 0x07, AUTHORING_DATA_GENERATION = 0x08, DEVICE_DATABASE_GENERATION = 0x09, PACKAGE_GENERATION = 0x0A, GENERATION_SUCCESS = 0x0B, GENERATION_CANCELED = 0x0C, GENERATION_ERROR_INTERNAL = 0x0D, GENERATION_ERROR_NO_NETWORK_CONNECTION = 0x0E, GENERATION_ERROR_SERVICE_NOT_AVAILABLE = 0x0F, GENERATION_ERROR_AUTHORIZATION_FAILED = 0x10 } |
enum | CameraMode { MODE_DEFAULT = -1, MODE_OPTIMIZE_SPEED = -2, MODE_OPTIMIZE_QUALITY = -3 } |
The mode used for camera capturing and video rendering. The camera device mode is set through the Unity inspector. More... | |
enum | DistortionMode { MODE_LINEAR = 1, MODE_3_PARAMS = 2, MODE_4_PARAMS = 3, MODE_5_PARAMS = 4 } |
enum | DriverPixelFormat : int { UNKNOWN = 0, YUYV = 1, NV12 = 2, NV21 = 3, RGB888, RGBA8888 } |
A list of the supported pixel formats by the driver for camera frames. More... | |
enum | FocusMode { FOCUS_MODE_TRIGGERAUTO = 1, FOCUS_MODE_CONTINUOUSAUTO = 2, FOCUS_MODE_INFINITY = 3, FOCUS_MODE_MACRO = 4, FOCUS_MODE_FIXED = 5 } |
The different focus modes for the active camera More... | |
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 | HitTestMode { AUTOMATIC, INTERACTIVE } |
The mode in which the surface is found. Automatic is used to perform a hit test from the screen center periodically. Interactive is used to perform a hit test on manual input (touch, mouse) More... | |
enum | ImageTargetType { PREDEFINED = 0, CLOUD_RECO = 2, INSTANT = 3, UNKNOWN = int.MaxValue } |
The type of an ImageTarget. An ImageTarget can be predefined in a dataset, created at runtime as a user defined target, or fetched at runtime via cloud recognition More... | |
enum | InstanceIdType { BYTE = 0, STRING = 1, NUMERIC = 2 } |
VuMark ID Type More... | |
enum | LogLevel { ALL, ERROR_AND_WARNING, ERROR, NONE } |
enum | PixelFormat { UNKNOWN_FORMAT = 1, RGB565 = 2, RGB888 = 3, GRAYSCALE = 4, RGBA8888 = 5, NV21 = 6, NV12 = 7, YV12 = 8, YUV420P = 9, YUYV = 10 } |
Pixel encoding types More... | |
enum | PlayModeType { WEBCAM, SIMULATOR, RECORDING } |
enum | RecordingSource { VIDEO = 0x01, CAMERA_METADATA = 0x02, SENSORS = 0x04, DEVICE_POSE = 0x08, AUDIO = 0x10 } |
The sources of data the session recorder can use. More... | |
enum | RecordingStartError { NONE = 0, INTERNAL = 1, ANOTHER_RECORDING_RUNNING = 2, ENGINE_NOT_RUNNING = 3, INVALID_STATUS = 4, FILE_CREATION = 5, UNKNOWN_ORIENTATION = 6, DATA_SOURCE = 7, INSUFFICIENT_FREE_SPACE = 8, DATA_FLAGS_NOT_SUPPORTED = 9, UNITY_PLAYMODE_NOT_SUPPORTED = 100 } |
Recording start error. More... | |
enum | RecordingStatus { INITIALIZED = 1, RUNNING = 2, STOPPED = 3 } |
Status of the session recorder. More... | |
enum | RecordingStatusInfo { NORMAL = 0, SUCCESS = 1, ERROR_INTERNAL = 2, ERROR_ORIENTATION_CHANGED = 3, ERROR_DATA_SOURCE = 4, ERROR_INSUFFICIENT_FREE_SPACE = 5 } |
Session recording status info. More... | |
enum | RecordingVideoEncodingQuality { HIGH = 0x1, MEDIUM = 0x2 } |
Quality settings used for encoding the recorded video. More... | |
enum | Sensitivity { HIGH, MEDIUM, LOW } |
The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion. More... | |
enum | Status { NO_POSE = 0, LIMITED = 1, TRACKED = 3, EXTENDED_TRACKED = 4 } |
The tracking status of the TrackableBehaviour. More... | |
enum | StatusInfo { NORMAL = 0, NOT_OBSERVED = 1, UNKNOWN = 2, INITIALIZING = 3, RELOCALIZING = 4, EXCESSIVE_MOTION = 5, INSUFFICIENT_FEATURES = 6, INSUFFICIENT_LIGHT = 7, RECOMMENDING_GUIDANCE = 8, WRONG_SCALE = 9, MISSING_DATA = 10 } |
Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More... | |
enum | StorageType { APP = 1, APP_RESOURCE = 2, ABSOLUTE = 3 } |
Storage type is used to interpret a given path string. More... | |
enum | TrackingOptimization { DEFAULT, LOW_FEATURE_OBJECTS, AR_CONTROLLER } |
Optimize tracking quality and robustness for different target types More... | |
enum | VirtualButtonSensitivity { HIGH, MEDIUM, LOW } |
The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion. 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, INIT_SUCCESS = NONE, DEVICE_NOT_SUPPORTED = 0x1, INIT_EXTERNAL_DEVICE_NOT_DETECTED = DEVICE_NOT_SUPPORTED, PERMISSION_ERROR = 0x2, INIT_NO_CAMERA_ACCESS = PERMISSION_ERROR, LICENSE_ERROR = 0x3, INITIALIZATION = 0x4, INIT_ERROR = INITIALIZATION, DRIVER_CONFIG_LIBRARY_NOT_FOUND = 0x100, DRIVER_CONFIG_LOAD_ERROR = 0x101, INIT_VUFORIA_DRIVER_FAILED = DRIVER_CONFIG_LOAD_ERROR, DRIVER_CONFIG_FEATURE_NOT_SUPPORTED = 0x102, LICENSE_CONFIG_MISSING_KEY = 0x200, INIT_LICENSE_ERROR_MISSING_KEY = LICENSE_CONFIG_MISSING_KEY, LICENSE_CONFIG_INVALID_KEY = 0x201, INIT_LICENSE_ERROR_INVALID_KEY = LICENSE_CONFIG_INVALID_KEY, LICENSE_CONFIG_NO_NETWORK_PERMANENT = 0x202, INIT_LICENSE_ERROR_NO_NETWORK_PERMANENT = LICENSE_CONFIG_NO_NETWORK_PERMANENT, LICENSE_CONFIG_NO_NETWORK_TRANSIENT = 0x203, INIT_LICENSE_ERROR_NO_NETWORK_TRANSIENT = LICENSE_CONFIG_NO_NETWORK_TRANSIENT, LICENSE_CONFIG_BAD_REQUEST = 0x204, INIT_LICENSE_ERROR_BAD_REQUEST = LICENSE_CONFIG_BAD_REQUEST, LICENSE_CONFIG_KEY_CANCELED = 0x205, INIT_LICENSE_ERROR_CANCELED_KEY = LICENSE_CONFIG_KEY_CANCELED, LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH = 0x206, INIT_LICENSE_ERROR_PRODUCT_TYPE_MISMATCH = LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH, 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... | |
|
strong |
Area Target Capture creation error
|
strong |
Area Target Capture generation error
|
strong |
|
strong |
Enumerator | |
---|---|
NORMAL | The capture is running normally |
RELOCALIZING | The capture is relocalizing, the user should move around or return towards a previously mapped area in order to resume normal capturing |
EXCESSIVE_MOTION | The user is moving too quickly |
CAPACITY_WARNING | The capture is removing old data to make room for new data and should be stopped soon |
INTERRUPTED | The capture is unable to add new data, the user should stop the capture |
SUSPENDED | The capture was paused automatically by Engine, all operations will fail until Engine resumes the capture |
TRACKING_DATA_GENERATION | The capture is processing the captured data |
AUTHORING_DATA_GENERATION | The capture is generating the authoring artifacts (3dt, glb) |
DEVICE_DATABASE_GENERATION | The capture is generating the Vuforia device database (dat, xml) |
PACKAGE_GENERATION | The capture is generating the package(s) |
GENERATION_SUCCESS | Generation successful |
GENERATION_CANCELED | Generation was canceled |
GENERATION_ERROR_INTERNAL | Generation failed because an internal error occurred |
GENERATION_ERROR_NO_NETWORK_CONNECTION | Generation failed because the device has no network connection |
GENERATION_ERROR_SERVICE_NOT_AVAILABLE | Generation failed because the server was not found, is unreachable, or overloaded |
GENERATION_ERROR_AUTHORIZATION_FAILED | Generation failed because the credentials are wrong or outdated |
|
strong |
The mode used for camera capturing and video rendering. The camera device mode is set through the Unity inspector.
|
strong |
|
strong |
A list of the supported pixel formats by the driver for camera frames.
|
strong |
|
strong |
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. |
|
strong |
Used when calling GetActiveFusionProvider()
Vuforia Fusion is a capability, introduced with Vuforia 7, 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:
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. |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Pixel encoding types
|
strong |
|
strong |
|
strong |
Recording start error.
|
strong |
|
strong |
Session recording status info.
|
strong |
Quality settings used for encoding the recorded video.
|
strong |
|
strong |
|
strong |
Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED).
|
strong |
|
strong |
Optimize tracking quality and robustness for different target types
|
strong |
|
strong |
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. |
|
strong |
VuforiaInitError is an error value that is returned by Vuforia if something goes wrong at initialization.
Enumerator | |
---|---|
NONE | No error |
INIT_SUCCESS | |
DEVICE_NOT_SUPPORTED | The device is not supported |
INIT_EXTERNAL_DEVICE_NOT_DETECTED | |
PERMISSION_ERROR | One or more permissions required by Vuforia Engine are missing or not granted by user |
INIT_NO_CAMERA_ACCESS | |
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) |
INIT_ERROR | |
DRIVER_CONFIG_LIBRARY_NOT_FOUND | Specified library file not found |
DRIVER_CONFIG_LOAD_ERROR | An error occurred while loading the driver |
INIT_VUFORIA_DRIVER_FAILED | |
DRIVER_CONFIG_FEATURE_NOT_SUPPORTED | Vuforia Driver is not supported by the current license |
LICENSE_CONFIG_MISSING_KEY | License key is missing |
INIT_LICENSE_ERROR_MISSING_KEY | |
LICENSE_CONFIG_INVALID_KEY | Invalid license key passed to SDK |
INIT_LICENSE_ERROR_INVALID_KEY | |
LICENSE_CONFIG_NO_NETWORK_PERMANENT | Unable to verify license key due to network (Permanent error) |
INIT_LICENSE_ERROR_NO_NETWORK_PERMANENT | |
LICENSE_CONFIG_NO_NETWORK_TRANSIENT | Unable to verify license key due to network (Transient error) |
INIT_LICENSE_ERROR_NO_NETWORK_TRANSIENT | |
LICENSE_CONFIG_BAD_REQUEST | Malformed request sent to license server. Please ensure your app has valid name and version fields |
INIT_LICENSE_ERROR_BAD_REQUEST | |
LICENSE_CONFIG_KEY_CANCELED | Provided key is no longer valid |
INIT_LICENSE_ERROR_CANCELED_KEY | |
LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH | Provided key is not valid for current product |
INIT_LICENSE_ERROR_PRODUCT_TYPE_MISMATCH | |
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 |
|
strong |
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.