Namespaces | |
| namespace | EditorClasses |
| namespace | Newtonsoft |
| namespace | UnityRuntimeCompiled |
Classes | |
| interface | Anchor |
| class | AnchorBehaviour |
| class | AnchorInputListenerBehaviour |
| class | AndroidDatasets |
| class | ARController |
| A camera listener gets all lifecycle events from the VuforiaBehaviour of an ARCamera. More... | |
| interface | AreaTarget |
| A trackable that represents a AreaTarget object More... | |
| class | AreaTargetBehaviour |
| class | AreaTargetDescriptorType |
| class | AreaTracker |
| The AreaTracker encapsulates methods to manage DataSets for Area Targets More... | |
| struct | ARFoundationImage |
| Data container for camera Image captured from AR Foundation More... | |
| class | BackgroundPlaneBehaviour |
| This Behaviour renders the video background from the camera in Unity. More... | |
| class | CameraDevice |
| This class provides access to camera methods and properties More... | |
| struct | CameraMode |
| 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 |
| interface | CylinderTarget |
| A trackable that represents a cylinder or conical object 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 | DatabaseLoadARController |
| This behaviour allows to automatically load and activate one or more DataSet on startup More... | |
| class | DataSet |
| This class represents a dataset that can be loaded and holds a collection of trackables. Trackables can also be created and destroyed at runtime. More... | |
| class | DataSetTrackableBehaviour |
| This is the base class for all trackables that are part of a dataset More... | |
| class | DatasetTracker |
| The abstract DatasetTracker encapsulates methods to manage DataSets More... | |
| class | DefaultInitializationErrorHandlerPlaceHolder |
| class | DefaultTrackableBehaviourPlaceholder |
| class | DefaultTrackableEventHandler |
| A custom handler that implements the ITrackableEventHandler interface. More... | |
| class | Device |
| Vuforia abstract representation of the Device (hardware) that it is running on. More... | |
| class | DeviceTracker |
| The DeviceTracker handles the rotational tracking for VR support More... | |
| class | DeviceTrackerARController |
| This is the main behaviour class that manages the device tracker More... | |
| class | DigitalEyewearARController |
| This class handles stereo rendering More... | |
| class | EyewearDevice |
| Specialization of Device which is provided when Vuforia is running on a dedicated Eyewear device. More... | |
| class | GLBHelper |
| class | GLErrorHandler |
| This Script can be used to set a full screen error message if an error happens on startup. (such as no OpenGL ES 2.0 support that is required for some samples). 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 |
| interface | IHoloLensApiAbstraction |
| class | IlluminationManager |
| Provides data on the estimated illumination values in the current frame such as illumination intensity or ambient light color temperature Get a configured instance of the IlluminationManager from the StateManager More... | |
| class | Image |
| Representation of an image, typically returned by the CameraDevice. More... | |
| class | ImageDescription |
| interface | ImageTarget |
| A trackable behaviour to represent a flat natural feature target. More... | |
| 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... | |
| struct | ImageTargetData |
| The basic data struct for an ImageTarget More... | |
| class | ImageTargetFinder |
| This class represents a service that retrieves image targets using cloud-based recognition. More... | |
| interface | InstanceId |
| The InstanceId contains the id for a particular VuMark. More... | |
| class | InteractiveHitTestBehaviour |
| interface | ISessionRecorder |
| The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More... | |
| interface | ITrackerManager |
| interface | IUnityARFoundationFacade |
| Provides access to AR Foundation functionality More... | |
| interface | IUnityPlayer |
| This class encapsulates functionality to detect various surface events (size, orientation changed) and delegate this to native. These are used by Unity Extension code and should usually not be called by app code. More... | |
| class | MaskOutBehaviour |
| Helper behaviour used to hide augmented objects behind the video background. More... | |
| class | MeshSetModelCreator |
| class | MidAirPositionerBehaviour |
| interface | ModelTarget |
| A trackable behaviour to represent a flat natural feature target. 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... | |
| interface | MultiTarget |
| A trackable that is made up of multiple targets with a fixed spatial relation. 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 | ObjectRecoBehaviour |
| This is the base class that encapsulates generic "object recognition" behaviour, such as Cloud Reocgnition of Image Targets and Model Recognition. Specialized implementations of Cloud Recognition and Model Recognition are in their respective classes. More... | |
| interface | ObjectTarget |
| A trackable that represents a ObjectTarget object More... | |
| class | ObjectTargetBehaviour |
| This class serves both as an augmentation definition for a ObjectTarget in the editor as well as a tracked ObjectTarget result at runtime More... | |
| class | ObjectTracker |
| The ObjectTracker encapsulates methods to manage DataSets for Object Targets More... | |
| struct | OrientedBoundingBox |
| This struct defines an oriented rectangle. It is internally used for defining the oriented bounding box of two trackables More... | |
| struct | OrientedBoundingBox3D |
| This struct defines a 3D box oriented around the Y axis. It is internally used for defining the oriented bounding box of two trackables More... | |
| class | PlaneFinderBehaviour |
| class | PositionalDeviceTracker |
| The PositionalDeviceTracker tracks a device in the world by relying on 6DOF sensor tracking, delivering both position and rotation. The PositionalDeviceTracker controls position and rotation of the camera in the Unity scene using a physical unit (meter). More... | |
| class | PreviewModelTurnOffBehaviour |
| A utility behaviour to disable rendering of an editor preview model at run time. 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... | |
| struct | RectangleIntData |
| This struct defines the 2D coordinates of a rectangle using integers. The struct is internally used for querying the region of interest for text tracking. More... | |
| class | RuntimeImageSource |
| A handle for creating a new Trackable from an image file in a DataSet. 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 | SmartTerrain |
| class | SmartTerrainARController |
| class | StateManager |
| This class is used to manage the state of all TrackableBehaviours, create them, associate them with Trackables, update their pose, etc. More... | |
| class | SurfaceUtilities |
| This class publicly exposes native methods that are related to surface management. These methods are used by the Unity Extension and usually should not be used in application code. More... | |
| class | TargetFinder |
| This class represents a service that retrieves targets using image and/or model recognition. More... | |
| interface | Trackable |
| The base class behaviour for all trackable types in Vuforia. More... | |
| class | TrackableBehaviour |
| The base class for all TrackableBehaviours in Vuforia This class serves both as an augmentation definition for a Trackable in the editor as well as a tracked Trackable result at runtime More... | |
| class | TrackableSource |
| An opaque handle for creating a new Trackable in a DataSet. More... | |
| class | Tracker |
| The common base class for all Tracker classes More... | |
| class | TrackerManager |
| This class serves as a singleton to retrieve the Trackers and the StateManager More... | |
| class | TurnOffBehaviour |
| A utility behaviour to disable rendering of a game object at run time. More... | |
| class | UnityARFoundationFacade |
| class | VideoBackgroundBehaviour |
| The VideoBackgroundBehaviour class handles native video background rendering. More... | |
| class | VideoBackgroundManager |
| class | VirtualButton |
| A virtual button on a trackable 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 | VuforiaARController |
| The VuforiaBehaviour class handles tracking and triggers native video background rendering. The class updates all Trackables in the scene. More... | |
| class | VuforiaBehaviour |
| class | VuforiaConfiguration |
| Global settings for Vuforia which are used for all scenes More... | |
| class | VuforiaManager |
| The VuforiaManager manages updating trackables, their state and position to the camera It is called from the VuforiaBehaviour. 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 | VuforiaRenderer |
| This class takes care about rendering the video background in the right size and orientation More... | |
| class | VuforiaRuntime |
| class | VuforiaRuntimeUtilities |
| A utility class containing various helper methods More... | |
| class | VuforiaUnity |
| A static utility class that exposes helper functions from Vuforia More... | |
| class | VuMarkBehaviour |
| This class serves both as an augmentation definition for a VuMark template in the editor as well as a tracked VuMark result at runtime More... | |
| class | VuMarkManager |
| This class manages all VuMark-targets which are created at runtime More... | |
| interface | VuMarkTarget |
| The VuMarkTarget contains all data for a VuMark which is available upon detection. This data does not change while the VuMark is tracked. More... | |
| interface | VuMarkTemplate |
| The VuMarkTemplate contains all static data of a VuMark which is available from the dataset. More... | |
| class | WebCamARController |
| This MonoBehaviour manages the usage of a webcam for Play Mode in Windows or Mac. More... | |
| class | WireframeBehaviour |
| This script renders the mesh from the MeshFilter as wireframe. This is mainly supposed to be used for visualization/debugging purpoes. It uses GL.LINES to draw the wireframe, which is not very fast for larger meshes. In order to draw large wireframe meshes in an app, it is recommended to use 3rd party libraries such as Vectrosity. More... | |
| class | WireframeTrackableEventHandler |
| A custom handler that also hides the wireframe-renderer in the smart terrain More... | |
| interface | WorldCenterTrackableBehaviour |
| This interface represents a TrackableBehaviour that can be set as the world center trackable More... | |
Typedefs | |
| using | TrackableIdPair = VuforiaManager.TrackableIdPair |
Enumerations | |
| enum | FusionProviderType { INVALID_OPERATION = -1, VUFORIA_VISION_ONLY = 1, VUFORIA_SENSOR_FUSION = 2, PLATFORM_SENSOR_FUSION = 4, ALL } |
| Used when calling setAllowedFusionProviders() and 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 } |
| The type of an ImageTarget. An ImageTarget can be predefined in a dataset, created at runtime as an Instant Image Target or fetched at runtime via cloud recognition More... | |
| enum | InstanceIdType { BYTES = 0, STRING = 1, NUMERIC = 2 } |
| enum | MeshState { UNLOADED, NATIVELOADING, NATIVELOADED, MESHASSEMBLING, LOADED, DEACTIVATED, NO_CONTENT } |
| enum | ModelTargetMotionHint { STATIC = 0, ADAPTIVE = 1 } |
| The two modes influence the tracking behaviour of the selected target: More... | |
| enum | ModelTargetTrackingMode { DEFAULT = 0, CAR = 1, SCAN = 2 } |
| enum | PIXEL_FORMAT { UNKNOWN_FORMAT = 0, RGB565 = 1, RGB888 = 2, GRAYSCALE = 4, RGBA8888 = 16, NV21 = 32, NV12 = 64, YV12 = 128, YUV420P = 256, YUYV = 512 } |
| Pixel encoding types More... | |
| enum | PlayModeType { WEBCAM, SIMULATOR, RECORDING } |
| enum | RecordingSource { CAMERA = 1, SENSORS = 2 } |
| The sources of data the session recorder can use. More... | |
| enum | RecordingStatus { NONE = 0, RECORDING_NOT_STARTED = 1, RECORDING_IN_PROGRESS = 2, SOURCES_NOT_AVAILABLE = 3, STORAGE_LOCATION_RETRIEVAL_ERROR = 4, SOURCE_OPERATION_ERROR = 5, INSUFFICIENT_FREE_SPACE = 6, ORIENTATION_NOT_SUPPORTED = 7, UNITY_PLAYMODE_NOT_SUPPORTED = 8 } |
| Status of the session recorder. More... | |
|
strong |
Used when calling setAllowedFusionProviders() and 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:
The enum values are bit-fields, except INVALID_OPERATION, to be combined using using the 'or' operation, and passed to setAllowedFusionProviders().
| Enumerator | |
|---|---|
| INVALID_OPERATION |
An invalid call has been made This value is returned when making a call to any of the FusionProvider functions at an invalid time. It should not be used as part of setting the allowed Fusion provider. |
| VUFORIA_VISION_ONLY |
Vision based tracking only Please note that not all Vuforia features are supported when using this provider. See setAllowedFusionProviders() for more information. |
| VUFORIA_SENSOR_FUSION |
Use the Vuforia provided sensor fusion. Vuforia will try to make use of camera and IMU information to create a tracking experience that, when compared to VUFORIA_VISION_ONLY, is more robust to erratic motions and featureless environments |
| PLATFORM_SENSOR_FUSION |
Use the Platform-provided technology for Fusion Vuforia will try to make use of tracking services offered by the underlying platfrom. Examples of this include ARKit on iOS, ARCore on Android, or Windows Holographic on UWP. |
| ALL |
Directs Fusion to automatically select the best provider This is the default and directy Vuforia to select the best technology available on the current device for Vuforia Fusion. |
|
strong |
|
strong |
The type of an ImageTarget. An ImageTarget can be predefined in a dataset, created at runtime as an Instant Image Target or fetched at runtime via cloud recognition
| Enumerator | |
|---|---|
| PREDEFINED | |
| CLOUD_RECO | |
| INSTANT | |
|
strong |
|
strong |
|
strong |
The two modes influence the tracking behaviour of the selected target:
| Enumerator | |
|---|---|
| STATIC | |
| ADAPTIVE | |
|
strong |
|
strong |
Pixel encoding types
|
strong |
|
strong |
|
strong |
