WikitudeArView

The Wikitude item provides AR capabilities of the Wikitude JavaScript SDK. More...

Import Statement: import VPlayPlugins 1.0
Since: V-Play 2.17.0
Inherits:

Item

Properties

Signals

Methods

Detailed Description

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 V-Play plugin.

For more information and usage examples, see the Wikitude Plugin page. For information how to implement AR apps in HTML and JavaScript, see the Wikitude SDK homepage.

Property Documentation

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 QML property was introduced in V-Play 2.17.0.

See also overrideLocation, latitude, longitude, and locationAccuracy.


arWorldSource : url

This property sets the location of the AR world HTML file to load. It can be a URL relative to your QML file or a http(s) URL.

This QML property was introduced in V-Play 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 QML property was introduced in V-Play 2.17.0.

See also cameraManualFocusDistance.


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 QML property was introduced in V-Play 2.17.0.

See also cameraFocusMode.


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 will try to start the front-facing camera, if the front-facing camera is not available the SDK will use the first available camera.
  • WikitudeArView.BackCamera - The SDK will try to start the back-facing camera, if the back-facing camera is not available the SDK will use the first available camera.
  • WikitudeArView.UnspecifiedCamera - The first available camera is used, this may be the front, back or external camera.

The default value of this property is WikitudeArView.UnspecifiedCamera.

This QML property was introduced in V-Play 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 QML property was introduced in V-Play 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 QML property was introduced in V-Play 2.17.0.

See also overrideLocation, longitude, altitude, and locationAccuracy.


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 QML property was introduced in V-Play 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 QML property was introduced in V-Play 2.17.0.

See also overrideLocation, latitude, longitude, and altitude.


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 QML property was introduced in V-Play 2.17.0.

See also overrideLocation, latitude, altitude, and locationAccuracy.


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

This QML property was introduced in V-Play 2.17.0.

See also latitude, longitude, altitude, and locationAccuracy.


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 QML property was introduced in V-Play 2.17.0.


Signal Documentation

javascriptCallback(var jsObject)

This signal gets emitted when the AR world uses AR.platform.sendJSONObject(...) to send a JSON object back to the QML application.

This QML signal was introduced in V-Play 2.17.0.

See also callJavascript().


Method Documentation

real callJavascript(string jsCommand)

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 QML method was introduced in V-Play 2.17.0.

See also javascriptCallback().


Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support