Documentation

Migration

Migrate from 6.1 to 7.0

  • ArchitectView:
  • Plugins API:
    • Plugin.h
      • deprecated:
        • void update(const std::list<RecognizedTarget>& recognizedTargets_). Use void update(const RecognizedTargetsBucket& recognizedTargetsBucket_) instead.
    • RecognizedTarget.h
      • deprecated class RecognizedTarget. Use ImageTarget instead.

Migrate from 6.0 to 6.1

Migrate from 5.3 to 6.0

  • Java API:
    • Plugins:
      • Plugin.java got moved from com.wikitude.architect.plugins to com.wikitude.common.plugins
      • ArchitectView as parameter of Plugin removed
      • JniRegistration function name has to be changed to Java_com_wikitude_common_plugins_internal_PluginManagerInternal_createNativePlugins
      • Input Plugin:
        • deprecated:
          • notifyRawCameraFieldOfViewChanged no longer used
          • notifyDynamicCameraFieldOfViewChanged use getCameraFrameSettings->setFrameFieldOfView instead
          • getInputFrameColorSpace use getCameraFrameSettings->setInputFrameColorSpace instead
          • getInputFrameSize use getCameraFrameSettings->setInputFrameSize instead
    • StartupConfiguration:
      • removed use ArchitectStartupConfiguration instead
      • moved StartupConfiguration.CameraPosition to CameraSettings.CameraPosition
    • new class ArchitectStartupConfiguration:
      • parameters are set by setters instead of as constructor parameters like in the StartupConfiguration
    • ArchitectView:
      • moved ArchitectView.CameraFocusMode to CameraSettings.CameraFocusMode
      • deprecated:
        • member getSdkVersion use static getSDKVersion instead
  • JS API:
    • The JS API is fully backwards compatible with SDK 5
    • Positioning:
      • AR.Drawable these changes affect all Drawables (e.g. AR.ImageDrawable, AR.Model):
        • removed:
          • roll use rotate.z or rotate.global.z instead
          • tilt use rotate.x or rotate.global.x instead
          • heading use rotate.y or rotate.global.y instead
        • deprecated:
          • rotate.tilt use rotate.x or rotate.global.x instead
          • rotate.heading use rotate.y or rotate.global.y instead
          • rotate.roll use rotate.z or rotate.global.z instead
      • AR.Drawable2D:
        • removed:
          • scaling use scale.x and scale.y instead
        • deprecated:
          • offsetX use translate.x or translate.global.x instead
          • offsetY use translate.y or translate.global.y instead
    • Trackers:
      • removed:
        • AR.Tracker
        • AR.Trackable2DObject:
          • getDistance
          • height
          • width
      • deprecated:
        • AR.ClientTracker use AR.TargetCollectionResource with an AR.ImageTracker instead
        • AR.CloudTracker use AR.CloudRecognitionService with an AR.ImageTracker instead
        • AR.Trackable2DObject use AR.ImageTrackable instead
        • AR.Trackable2DObject:
          • onEnterFieldOfVision use onImageRecognized instead
          • onExitFieldOfVision use onImageLost instead
    • AR.ActionRange:
      • removed:
        • geoLocation
        • positionX
        • positionY

Upgrading targets for SDK 6.0 (and later)

The Wikitude SDK 6.0 introduces an updated format for the target collection. The new format improves the recognition phase significantly. The updated format is not backward compatible with Wikitude 5.x (and prior) and can not be used in projects using Wikitude SDK 5.x or prior.

However you can use wtc-4.1 formats with the Wikitude SDK 6.0, although we strongly recommend to updated to the newest (wtc-5.0) version.

To use the new format you need to re-create your target collection in the target manager and download the .wtc file under the Download 6.0 link. Put this .wtc file in your app and replace the previous one.

It is not possible to use a wtc 5.0 file together with Wikitude SDK 5.x. Please download the respective wtc versions from the target manager and use them.
Wikitude SDK 3.x Wikitude SDK 4.0 Wikitude SDK 4.1 Wikitude SDK 5.0 Wikitude SDK 5.1-5.3 Wikitude SDK 6.0
wtc 3.x supported supported supported not supported not supported not supported
wtc 4.0 not supported supported supported not supported not supported not supported
wtc 4.1 not supported not supported supported supported supported supported
wtc 5.0 not supported not supported not supported not supported not supported supported

Upgrading targets for SDK 4.1

The Wikitude SDK 4.1 introduces an updated format for the target collection. The new format improves the recognition phase considerably. The updated format is not backward compatible with Wikitude SDK 3.x, 4.0 and can not be used in projects using Wikitude SDK 3.x or Wikitude SDK 4.0.

However you can use wtc-3.x and wtc-4.0 formats with the Wikitude SDK 4.1, although we strongly recommend to updated to the newest (wtc-4.1) version.

Support for wtc-3.x and wtc-4.0 is deprecated and will be not supported in Wikitude SDK 5.0 (later 2015).

To use the new format you need to re-create your target collection in the target manager and download the .wtc file under the Download 4.1 link. Put this .wtc file in your app and replace the previous one.

It is not possible to use a wtc 4.1 file together with Wikitude SDK 3.x or Wikitude SDK 4.0. Please download the respective wtc versions from the target manager and use them.

Migrating targets from SDK 1.x

If you have been using a dataset from the Qualcomm Vuforia target management, please follow these steps to convert your ARchitect World to the new approach:

  1. Create a new project with the Wikitude target management tool and upload your targets (see instructions above)
  2. Create a target collection and store it in the same location as the previously used dataset
  3. In your ARchitect World, update the AR.ClientTracker initialization to point to the URL of your new target collection