Migrate
Migration notes for the Wikitude SDK Native API (iOS)
Migrate from 8.3.2 to 8.4
- Xcode 10.1 or older required to build the Swift example app for now
WTWikitudeNativeSDK
- added:
isDeviceSupportingFeatures:error:
is now the preferred way to check if the current device supports the iOS capabilities required for an AR experience
- added:
Migrate from 8.0 to 8.1
WTTrackerManager
- deprecated:
-createCloudRecognitionServiceWithClientToken:targetCollectionId:completion:
Use-createCloudRecognitionServiceWithClientToken:groupId:targetCollectionId:completion:
instead-createCloudRecognitionServiceWithClientToken:targetCollectionId:configuration:completion:
Use-createCloudRecognitionServiceWithClientToken:groupId:targetCollectionId:configuration:completion:
instead
- deprecated:
WTCloudRecognitionService
- added:
groupId
- added:
WTImageTrackerConfiguration
- added:
trackerEfficiencyMode
- added:
WTInstantTrackerConfiguration
- added:
trackerEffieciencyMode
enablePlaneDetection:
- added:
WTInstantTrackerDelegate
- added:
-instantTracker:didRecognizePlane:
-instantTracker:didTrackPlane:
-instantTracker:didLosePlane:
- added:
WTObjectTrackerConfiguration
- added:
trackerEfficiencyMode
- added:
Added:
WTExtent
WTPlane
WTPlaneDetectionConfiguration
WTPlaneFilter
WTPlaneType
WTPoint2D
Migrate from 7.2 to 8.0
WTWikitudeNativeSDK+Plugins
- removed:
-registerPlugin:
- removed:
WTTrackerManager
:- deprecated:
-createTargetCollectionResourceFromURL:completion:
Use-createTargetCollectionResourceFromURL:
instead-createCloudRecognitionServiceWithClientToken:targetCollectionId:completion:
Use-createCloudRecognitionServiceWithClientToken:targetCollectionId:configuration:completion:
instead-createObjectTrackerFromTargetCollectionResource:delegate:
Use-createObjectTrackerFromTargetCollectionResource:delegate:configuration:
instead
- removed:
isPlatformAssistedTrackingSupported()
- added:
isPlatformAssistedTrackingSupported(IsPlatformAssistedTrackingAvailableCallback)
is now an async API that performs an ongoing query rather than a sync call that immediately returns a result-createTargetCollectionResourceFromURL:
is now the preferred way to create target collection resources-createObjectTrackerFromTargetCollectionResource:delegate:configuration:
is now the prefrerred way to create object tracker. The configuration parameter is optional.
- deprecated:
WTTargetCollectionResource
:- added:
-load:
- added:
WTObjectTracker
:- added:
-setExtendedTargets:
-stopExtendedTracking
-isExtendedTrackingActive
- added:
WTInstantTracker
:- deprecated:
-requestCurrentPointCloudOnQueue:representedThroughDataProvider:
Use-requestCurrentPointCloudRepresentedThroughDataProvider:
instead-convertScreenCoordinate:toPointCloudCoordinateOnQueue:completion:
Use-convertScreenCoordinateToPointCloudCoordinate:success:error:
instead
- added:
-saveCurrentInstantTargetWithSceneName:success:error:
-loadExistingInstantTargetWithTargetCollectionResource:restoration:success:error:
- deprecated:
WTInstantTrackerDelegate
:- deprecated:
-instantTrackerDidStartTracking:
Use-instantTracker:didStartTracking:
instead
- deprecated:
WTImageTarget
- added:
-distanceTo:
-targetAreaInCameraFrame
-targetAreaInScreenSpace:
- added:
WTCaptureDeviceManager
:- deprecated:
-exposeAtPointOfInterest:withMode:
cameraRenderingTargetTexture
ImplementcameraFrameRenderingTargetTextureId
from the WTOpenGLESRenderingMode protocol instead.
- added:
-focusAtPointOfInterest:
-exposeAtPointOfInterest:
- deprecated:
WTCloudRecognitionServiceConfiguration
- added:
WTCloudRecognitionTargetConflictSolver
- added:
WTExternalMetalRenderingProtocol
- added:
-metalPixelFormatForVideoCameraInWikitudeNativeSDK:
- added:
WTNativeSDKStartupConfiguration
- removed:
targetRenderingAPI
- removed:
Plugin
:- removed:
addToJavaScriptQueue
cameraFrameAvailable(Frame&)
endRender()
getJavaScriptQueue
getPluginType()
getRenderingContext()
initialize()
internalError(const std::string&)
requestRendering()
setRenderingContext(std::shared_ptr<sdk::RenderingContext>)
startRender()
surfaceChanged(Size<int>, Size<float>, InterfaceOrientation)
update(std::list<RecognizedTarget>&)
updatePositionables(std::unordered_map<std::string, sdk_core::PositionableWrapper*>&)
- added:
cameraFrameAvailable(common_code::ManagedCameraFrame&)
canPerformTrackingOperationsAlongOtherPlugins()
canUpdateMultipleTrackingInterfacesSimultaneously()
getCameraFrameInputPluginModule()
getDeviceIMUInpputPluginModule()
getDirectXRenderingPluginModule()
getImageTrackingPluginModule()
getInstantTrackingPluginModule()
getMetalRenderingPluginModule()
getObjectTrackingPluginModule()
getOpenGLESRenderingPluginModule()
initialize(const std::string&, PluginParameterCollection&)
iterateEnabledPluginModules(std::function<void(PluginModule& activePluginModule_)>)
setCameraFrameInputPluginModule(std::unique_ptr<CameraFrameInputPluginModule>)
setDeviceIMUInputPluginModule(std::unique_ptr<DeviceIMUInputPluginModule>)
setDirectXRenderingPluginModule(std::unique_ptr<DirectXRenderingPluginModule>)
setImageTrackingPluginModule(std::unique_ptr<ImageTrackingPluginModule>)
setInstantTrackingPluginModule(std::unique_ptr<InstantTrackingPluginModule>)
setMetalRenderingPluginModule(std::unique_ptr<MetalRenderingPluginModule>)
setObjectTrackingPluginModule(std::unique_ptr<ObjectTrackingPluginModule>)
setOpenGLESRenderingPluginModule(std::unique_ptr<OpenGLESRenderingPluginModule>)
- removed:
Added Classes:
CameraFrameInputPluginModule
DeviceIMUInputPluginModule
ImageTrackingPluginModule
InstantTrackingPluginModule
ObjectTrackingPluginModule
OpenGLESRenderingPluginModule
PluginModule
PluginParameterCollection
RenderingPluginModule
WTInstantTargetRestorationConfiguration
WTObjectTrackerConfiguration
Removed deprecated classes:
WTBaseTracker
WTClientTracker
WTCloudRecognitionResponse
WTCloudTracker
Migrate from 7.1 to 7.2
- WTTrackerManager
- new function
-isPlatformAssistedTrackingSupported
- should be used to guard methods that are not available when running with platform assisted tracking
- new function
- WTInstantTracker
- new function
-canStartTracking
- new function
- WTInstantTrackerDelegate
- new function
-instantTracker:didFailWithError:
- new function
- WTInstantTrackerConfiguration
- when running with platform assisted tracking, some functionality is not available; these functions will raise an error through the error callback when called regardless
- new parameter
trackingPlaneOrientation
- new parameter
- new parameter
SMARTEnabled
- when running with platform assisted tracking, some functionality is not available; these functions will raise an error through the error callback when called regardless
- WTCaptureDeviceManager
- new function
-exposeAtPointOfInterest:withMode:
- when running with platform assisted tracking, some functionality is not available; these functions will raise an error through the error callback when called regardless
activeCaptureDevicePosition
focusMode
focusDistance
autoFocusRangeRestriction
zoomLevel
maxZoomLevel
torchMode
hasTorch
fieldOfView
- new function
Migrate from 7.0 to 7.1
no changes required
Migrate from 2.1 to 7.0
- iOS 9.0 or higher is now required
- WTWikitudeNativeSDKDelegate
-wikitudeNativeSDK:didCreatedExternalUpdateHandler:
Use-didCreateExternalOpenGLESUpdateHandler
defined inWTExternalOpenGLESRenderingProtocol
instead.-wikitudeNativeSDK:didCreatedExternalDrawHandler:
Use-didCreateExternalOpenGLESDrawHandler
defined inWTExternalOpenGLESRenderingProtocol
instead-wikitudeNativeSDK:didSetupRendererWithAPI:
UseselectRenderingConfiguration
instead-eaglViewSizeForExternalRenderingInWikitudeNativeSDK:
Use-eaglViewSizeForExternalRenderingInWikitudeNativeSDK
defined inWTExternalOpenGLESRenderingProtocol
instead-eaglContextForVideoCameraInWikitudeNativeSDK:
Use-eaglContextForVideoCameraInWikitudeNativeSDK
defined inWTExternalOpenGLESRenderingProtocol
instead-eaglContextForVideoCameraToTextureRenderingInWikitudeNativeSDK:
Use-eaglContextForVideoCameraToTextureRenderingInWikitudeNativeSDK
defined inWTExternalOpenGLESRenderingProtocol
instead-wikitudeNativeSDKNeedsExternalUpdateHandler:
Use-wikitudeNativeSDKNeedsExternalOpenGLESUpdateHandler
defined inWTInternalOpenGLESRenderingProtocol
instead-wikitudeNativeSDKNeedsExternalDrawHandler:
Use-wikitudeNativeSDKNeedsExternalOpenGLESDrawHandler
defined inWTInternalOpenGLESRenderingProtocol
instead
WTWikitudeNativeSDK
- deprecated property
renderingMode
UseWTInternalOpenGLESRenderingMode
orWTExternalOpenGLESRenderingMode
instead - deprecated method
-initWithRenderingMode:delegate:
Use-initWithRenderingConfiguration:delegate
instead - deprecated method
-createEAGLView
UseWTInternalOpenGLESRenderingMode
instead
- deprecated property
- Plugins API:
- Plugin.h
- deprecated:
void update(const std::list<RecognizedTarget>& recognizedTargets_)
. Usevoid update(const RecognizedTargetsBucket& recognizedTargetsBucket_)
instead. * RecognizedTarget.h
- deprecated class
RecognizedTarget
. UseImageTarget
instead.
- deprecated:
- Plugin.h
Migrate from 2.0 to 2.1
WTNativeSDKStartupConfiguration
- new property
targetRenderingAPI
- new property
-
- new method
-registerPlugin:error:
- deprecated method
-registerPlugin
- new method
Migrate from 1.4 to 2.0
- New protocol
WTImageTrackerDelegate
New protocol
WTInstantTrackerDelegate
New class
WTAuthorizationRequestManager
- New class
WTTargetCollectionResource
- New class
WTCloudRecognitionService
- New class
WTImageTrackerConfiguration
- New class
WTImageTracker
- New class
WTImageTarget
- New class
WTInstantTracker
- New class
WTInitializationPose
- New class
WTInstantTarget
New class
WTNativeSDKStartupConfiguration
Deprecated class
WTBaseTracker
- Deprecates class
WTClientTracker
. UseWTTargetCollectionResource
+WTImageTracker
instead. Deprecated class
WTCloudTracker
. UseWTCloudRecognitionService
+WTImageTracker
instead.-
- New method
+SDKBuildInformation
- New method
+resolveCaptureDeviceSettings:toSize:targetFrameRate:
- New method
-
- New method
-createTargetCollectionResourceFromURL:completion
- New method
-createCloudRecognitionService:completion
- New method
-createImageTrackerFromTargetCollectionResource:delegate:configuration:
- New method
-createImageTrackerFromCloudRecognitionService:delegate:configuration:
- New method
-createInstantTracker:delegate:configuration:
- Deprecated method
-create2DClientTrackerFromURL:extededTargets:andDelegate:
- Deprecated method
-create3DClientTrackerFromURL:andDelegate:
- Deprecated method
-createCloudTrackerWithToken:targetCollectionId:extededTargets:andDelegate
- New method
WTCaptureDeviceManagerDelegate
- New property
hasTorch
- New property
cameraRenderingTargetTexture
- New property
Migrate from 1.3 to 1.4
iOS 10 now requires a camera usage description. Please make sure that you add the NSCameraUsageDescription
key to your applications .plist.
WTWikitudeNativeSDK
- new
-clearCache
. Use this method to clear all internal SDK caches.
- new
Migrate from 1.0 to 1.1
-
- new
-create2DClientTrackerFromURL:extendedTargets:andDelegate:
Use this method to create a newWTClientTracker
object which is configured for 2D tracking. new
-create3DClientTrackerFromURL:andDelegate:
Use this method to create a newWTClientTracker
object that is configured for 3D tracking.deprecated
-createClientTrackerFromURL:extendedTargets:andDelegate:
Use-create2DClientTrackerFromURL:extendedTargets:andDelegate:
instead.
- new
new
WTTrackingMapRecorder
Use this class to record and save so called 'Tracking Maps' that are needed for 3D tracking.