The VuforiaApplication class provides a way to initialize and deinitialize Vuforia as well register to lifecycle events
More...
|
| bool | IsInitialized => CoreDependencies.Instance.Engine.IsInitialized |
| | Returns true if the Vuforia Engine was successfully initialized More...
|
| |
| bool | IsRunning => CoreDependencies.Instance.Engine.IsRunning |
| | Returns true if the Vuforia Engine has been started and is currently running More...
|
| |
The VuforiaApplication class provides a way to initialize and deinitialize Vuforia as well register to lifecycle events
◆ Deinit()
◆ GetVuforiaBehaviour()
◆ GetVuforiaLibraryVersion()
| static string GetVuforiaLibraryVersion |
( |
| ) |
|
|
inlinestatic |
Returns the version of the Vuforia SDK
◆ Initialize() [1/3]
Initialize Vuforia. Used when "delayed initialization" has been selected in the VuforiaConfiguration, otherwise this happens automatically While running in the Unity Editor, it takes couple frames to initialize.
◆ Initialize() [2/3]
Initialize Vuforia while specifying a configuration for the Fusion Provider. Used when "delayed initialization" has been selected in the VuforiaConfiguration.
- Parameters
-
| fusionProviderOption | The Fusion Provider configuration. |
◆ Initialize() [3/3]
| void Initialize |
( |
string |
driverName, |
|
|
IntPtr |
userData |
|
) |
| |
|
inline |
Initialize Vuforia while setting up the name of the library that is loaded dynamically and used as an external source of camera or other input data. The library must support the Vuforia Driver API and it must be placed inside the app package to be loaded properly. The exact path depends on the platform:
- Android: [apk-root-dir]/lib/[architecture]/library.so
- UWP: [appx-root-dir]/library.dll
- iOS: [appx-root-dir]/Frameworks/library.framework
Vuforia will try to initialize and use the functionality provided by the Driver.
To disable the Vuforia Driver functionality the following must be done:
- Call VuforiaApplication.Instance.Deinit()
- Call VuforiaApplication.Instance.Initialize()
This functionality is currently only supported on Editor, Android, iOS and UWP platforms.
- Parameters
-
| driverName | Full file name of the Driver library. Setting this to null or empty string, will disable the use of the Driver functionality. |
| userData | Optional user defined data to be passed into the library when it gets loaded. Vuforia only forwards the data and doesn't process it in any way. This value can be accessed at any time throughout the Vuforia lifecycle, so it MUST be valid until Vuforia is de-initialized. Set to IntPtr.Zero if not needed. |
◆ SetHint()
| void SetHint |
( |
int |
hint, |
|
|
bool |
value |
|
) |
| |
|
inline |
Advanced option to set an internal hint code before initialization
- Parameters
-
◆ IsInitialized
| bool IsInitialized => CoreDependencies.Instance.Engine.IsInitialized |
Returns true if the Vuforia Engine was successfully initialized
◆ IsRunning
| bool IsRunning => CoreDependencies.Instance.Engine.IsRunning |
Returns true if the Vuforia Engine has been started and is currently running
◆ Instance
◆ OnBeforeVuforiaInitialized
| Action OnBeforeVuforiaInitialized |
|
addremove |
Use this callback for configuring tasks before initializing Vuforia Engine. The callback is triggered before Vuforia Engine is initialized, provided that Delayed Initialization is enabled, or before performing an initialization after a deinitialization of Vuforia Engine.
◆ OnVuforiaInitialized
Triggered when Vuforia Engine has initialized
◆ OnVuforiaStarted
Triggered after Vuforia has started delivering frame updates
◆ OnVuforiaDeinitialized
| Action OnVuforiaDeinitialized |
Triggered when Vuforia has been deinitialized
◆ OnVuforiaError
Triggered when a lifecycle-related engine error occurs after initialization
◆ OnVuforiaPaused
| Action<bool> OnVuforiaPaused |
◆ OnVuforiaStopped
Triggered when Vuforia has been stopped
