All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
VuforiaBehaviour Class Reference

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...

Inheritance diagram for VuforiaBehaviour:
VuforiaMonoBehaviour

Public Member Functions

bool ClearAreaTargetObserverCloudCache ()
 Remove all data cached by Area Target observers.
 
bool ClearModelTargetDetectionCache ()
 Remove all detection data cached by Model Target observers.
 
DatabaseTargetInfo[] GetDatabaseTargetInfo (string databasePath, out DatabaseTargetInfoError error)
 Extract info on all targets from a database from which observers can be created.
 
bool SetMaximumSimultaneousTrackedImages (int maxNumberOfTargets)
 Set the maximum number of image-based Targets tracked at the same time.
 
bool SetModelTargetRecoWhileExtendedTracked (bool enable)
 Turn on the recognition engine for an Advanced (360) Model Target database while extended-tracking a model.
 
void SetWorldCenter (WorldCenterMode wcm, ObserverBehaviour observerBehaviour)
 Set the world center mode at runtime.
 

Properties

CameraDevice CameraDevice [get]
 Represents the physical camera.
 
DevicePoseBehaviour DevicePoseBehaviour [get]
 Returns the DevicePoseBehaviour which represents the device, such as a phone or a digital eyewear device, of which a position is tracked.
 
static VuforiaBehaviour Instance [get]
 A simple static singleton getter to the VuforiaBehaviour (if present in the scene) Will return null if no VuforiaBehaviour has been instantiated in the scene.
 
ObserverFactory ObserverFactory [get]
 ObserverFactory to create Vuforia target behaviours.
 
ISessionRecorder SessionRecorder [get]
 The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device. Returns null if Vuforia has not yet been initialized.
 
VideoBackground VideoBackground [get]
 The renderer which provides access to features of the video background.
 
World World [get]
 A representation of the physical world. Provides access to the current state and offers functionality to perform hit tests and create anchors.
 
ObserverBehaviour WorldCenter [get]
 The ObserverBehaviour which, when tracked, is the world center. Requires WorldCenterMode to be set to "SPECIFIC_TARGET".
 
WorldCenterMode WorldCenterMode [get]
 The world center mode.
 

Detailed Description

The central Vuforia class. Allows to start and stop the engine and provides access to the current state and physical camera among other things.

Member Function Documentation

◆ ClearAreaTargetObserverCloudCache()

bool ClearAreaTargetObserverCloudCache ( )
inline

Remove all data cached by Area Target observers.

Use this function to decrease the disk space usage by removing all Cloud Area Target data cached by Area Target observers. If there is any Area Target observer in the given engine instance this function will fail.

◆ ClearModelTargetDetectionCache()

bool ClearModelTargetDetectionCache ( )
inline

Remove all detection data cached by Model Target observers.

Use this function to decrease the disk space usage by removing all detection data cached by Model Target observers. If there is any Model Target observer in the given Vuforia Engine instance this function will fail.

Note that clearing the cache may take a significant amount of time, it is therefore recommended that this method is not called on the main/UI thread.

◆ GetDatabaseTargetInfo()

DatabaseTargetInfo[] GetDatabaseTargetInfo ( string databasePath,
out DatabaseTargetInfoError error )
inline

Extract info on all targets from a database from which observers can be created.

Parameters
databasePathThe path to the XML or DAT file of the database. Must be either an absolute path or relative to "StreamingAssets".
errorError encountered while retrieving the Target info in the database.
Returns
Info on the Targets contained in the Database.

◆ SetMaximumSimultaneousTrackedImages()

bool SetMaximumSimultaneousTrackedImages ( int maxNumberOfTargets)
inline

Set the maximum number of image-based Targets tracked at the same time.

This setting controls Image Targets, Cylinder Targets, Multi-Targets and VuMarks. The default value is 1.

◆ SetModelTargetRecoWhileExtendedTracked()

bool SetModelTargetRecoWhileExtendedTracked ( bool enable)
inline

Turn on the recognition engine for an Advanced (360) Model Target database while extended-tracking a model.

This can only be set when Vuforia is not running. The default value is true.

◆ SetWorldCenter()

void SetWorldCenter ( WorldCenterMode wcm,
ObserverBehaviour observerBehaviour )
inline

Set the world center mode at runtime.

Parameters
wcmWorld center mode
observerBehaviourBehaviour to be used as world center in SPECIFIC_TARGET mode

Property Documentation

◆ CameraDevice

Represents the physical camera.

◆ DevicePoseBehaviour

Returns the DevicePoseBehaviour which represents the device, such as a phone or a digital eyewear device, of which a position is tracked.

◆ Instance

VuforiaBehaviour Instance
staticget

A simple static singleton getter to the VuforiaBehaviour (if present in the scene) Will return null if no VuforiaBehaviour has been instantiated in the scene.

◆ ObserverFactory

ObserverFactory to create Vuforia target behaviours.

◆ SessionRecorder

ISessionRecorder SessionRecorder
get

The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device. Returns null if Vuforia has not yet been initialized.

Returns
Returns null is Vuforia is not initialized.

◆ VideoBackground

The renderer which provides access to features of the video background.

Returns
Returns null is Vuforia is not initialized.

◆ World

World World
get

A representation of the physical world. Provides access to the current state and offers functionality to perform hit tests and create anchors.

◆ WorldCenter

ObserverBehaviour WorldCenter
get

The ObserverBehaviour which, when tracked, is the world center. Requires WorldCenterMode to be set to "SPECIFIC_TARGET".

◆ WorldCenterMode

The world center mode.