The Wikitude item provides AR capabilities of the Wikitude JavaScript SDK. More...
| Import Statement: | import Felgo 4.0 |
| Since: | Felgo 2.17.0 |
| Inherits: |
The item supports the JavaScript SDK by Wikitude. The SDK lets you implement augmented reality (AR) apps in HTML and JavaScript. These apps are fully supported by the Felgo plugin.
For more information and usage examples, see the Wikitude Plugin page. For information on how to implement AR apps in HTML and JavaScript, see the Wikitude SDK homepage.
|
[since Felgo 2.17.0] altitude : real |
This property determines the device's altitude for geo AR applications, in meters, if overrideLocation is true.
The default value of this property is -32768, which means unknown altitude.
This property was introduced in Felgo 2.17.0.
See also overrideLocation, latitude, longitude, and locationAccuracy.
|
[since Felgo 2.17.0] arWorldSource : url |
This property sets the location of the AR world HTML file to load. It can be a URL to your project assets, i.e. file://, or assets:/ on Android, or a http(s):// URL.
Note: WikitudeArView does not support loading the AR world from Qt resources (qrc:// URLs). If you load your QML files from resources, you can place the
Wikitude HTML/JavaScript app in a separate folder that is deployed in the app's or game's assets instead. For more information about deployment folders, see the publishing guide. If your HTML/JavaScript app becomes large, you can consider loading it remotely with DownloadableResource.
This property was introduced in Felgo 2.17.0.
|
[since Felgo 2.17.0] cameraFocusMode : enumeration |
This property determines the camera's focus mode to use for the AR view. Set it to one of the enumeration values:
WikitudeArView.AutoFocus - The camera focuses once automatically and then stays at this focus until the camera is stopped or a new focus mode is set.WikitudeArView.AutoFocusContinuous - The camera will continuously try to find the best focus.WikitudeArView.ManualFocus - The camera uses the focus distance specified by cameraManualFocusDistance
The default value of this property is WikitudeArView.AutoFocusContinuous.
Note: This property can only be set initially when creating WikitudeArView and later changes won't have any effect.
This property was introduced in Felgo 2.17.0.
See also cameraManualFocusDistance.
|
[since Felgo 2.17.0] cameraManualFocusDistance : real |
This property determines the manual focus distance of the camera. It only has an effect when cameraFocusMode is set to
WikitudeArView.ManualFocus.
This property should be set to a value between 0, meaning shortest focusable distance, and 1, meaning focus at infinity.
The default value of this property is 0.
This property was introduced in Felgo 2.17.0.
See also cameraFocusMode.
|
[since Felgo 2.17.0] cameraPosition : enumeration |
This property determines the position of the camera to use for the AR view. Set it to one of the enumeration values:
WikitudeArView.FrontCamera - The SDK tries to start the front-facing camera. If the front-facing camera is not available, the SDK uses the first available camera.WikitudeArView.BackCamera - The SDK tries to start the back-facing camera. If the back-facing camera is not available, the SDK uses the first available camera.WikitudeArView.UnspecifiedCamera - The first available camera is used, this may be the front, back or an external camera.
Note: On some devices, WikitudeArView.UnspecifiedCamera does not find a camera, and it shows a black image instead.
The default value of this property is WikitudeArView.BackCamera.
This property was introduced in Felgo 2.17.0.
|
[since Felgo 2.17.0] cameraResolution : enumeration |
This property determines the camera resolution to use for the AR view. Set it to one of the enumeration values:
WikitudeArView.SD - Use a standard definition resolution of 640x480.WikitudeArView.HD - Use a high definition resolution of 1280x720.WikitudeArView.Full_HD - Use highest available resolution of 1920x1080.WikitudeArView.AutoResolution - Use the most optimal resolution in terms of quality and performance.The default value of this property is WikitudeArView.AutoResolution.
Note: This property can only be set initially when creating WikitudeArView and later changes won't have any effect.
This property was introduced in Felgo 2.17.0.
|
[since Felgo 2.17.0] latitude : real |
This property determines the device's latitude for geo AR applications, in degrees, if overrideLocation is true.
The default value of this property is 0.
This property was introduced in Felgo 2.17.0.
See also overrideLocation, longitude, altitude, and locationAccuracy.
|
[since Felgo 2.17.0] licenseKey : string |
Provide your license key retrieved from the Wikitude console here. If you do not have a Wikitude account yet, you can create a new one at http://www.wikitude.com/developer/sign-in. Once you are logged in, you can acquire a license key from the Wikitude store.
For testing purposes, you can also use the free trial license provided at the Wikitude console.
This property was introduced in Felgo 2.17.0.
|
[since Felgo 2.17.0] locationAccuracy : real |
This property determines the device's location's accuracy for geo AR applications, in meters, if overrideLocation is true.
The default value of this property is 1.
This property was introduced in Felgo 2.17.0.
See also overrideLocation, latitude, longitude, and altitude.
|
[since Felgo 2.17.0] longitude : real |
This property determines the device's longitude for geo AR applications, in degrees, if overrideLocation is true.
The default value of this property is 0.
This property was introduced in Felgo 2.17.0.
See also overrideLocation, latitude, altitude, and locationAccuracy.
|
[since Felgo 2.17.0] overrideLocation : bool |
This property determines if the device's internal location should be overwritten by a custom location. Set this property to false to use the internal location for geo AR applications. Set this property to
true to use the location set by latitude, longitude, altitude and locationAccuracy.
The default value of this property is true.
Note: If you set this property to false, Wikitude uses the device's location sensors (GPS, mobile network). On Android, this requires you to declare the permission ACCESS_FINE_LOCATION in
AndroidManifest.xml. On iOS, this requires you to add the NSLocationWhenInUseUsageDescription in Project-Info.plist.
This property was introduced in Felgo 2.17.0.
See also latitude, longitude, altitude, and locationAccuracy.
|
[since Felgo 2.17.0] running : bool |
This property determines if the AR application is currently running. Set it to false to pause the AR application including the camera view, image tracking and geo services.
The default value of this property is true.
This property was introduced in Felgo 2.17.0.
|
|
This signal gets emitted if the AR world uses AR.platform.sendJSONObject(...) to send a JSON object back to the QML application.
Note: The corresponding handler is onJavascriptCallback.
This signal was introduced in Felgo 2.17.0.
See also callJavascript().
|
|
Use this method to interact with the AR world. The supplied jsCommand will be evaluated as JavaScript code in the AR world's context.
This method was introduced in Felgo 2.17.0.
See also javascriptCallback().
