WTTrackerManager Class Reference

Inherits from NSObject
Declared in WTTrackerManager.h

Overview

WTTrackerManger provides factory methods to create certain tracker objects.

– createTargetCollectionResourceFromURL:

Returns a weak pointer to a newly created WTTargetCollectionResource object, used to load a target collection file.

- (WTTargetCollectionResource *)createTargetCollectionResourceFromURL:(NSURL *)resourceURL

Parameters

resourceURL

A URL from where the target collection resource should be loaded from. Files can be loaded from the application bundle or a remote server.

Return Value

WTTargetCollectionResource * A pointer to a newly created WTTargetCollectionResource object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createTargetCollectionResourceFromURL:completion:

Returns a weak pointer to a newly created WTTargetCollectionResource object, used to load a target collection file.

- (WTTargetCollectionResource *)createTargetCollectionResourceFromURL:(NSURL *)resourceURL completion:(WTTargetCollectionResourceCompletionHandler)errorHandler

Parameters

resourceURL

A URL from where the target collection resource should be loaded from. Files can be loaded from the application bundle or a remote server.

errorHandler

An object that conforms to the WTTargetCollectionResourceCompletionHandler protocol.

Return Value

WTTargetCollectionResource * A pointer to a newly created WTTargetCollectionResource object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createCloudRecognitionServiceWithClientToken:groupId:targetCollectionId:completion:

Returns a weak pointer to a newly created WTCloudRecognitionService object, used to offload image target recognition to the Wikitude cloud recognition servers.

- (WTCloudRecognitionService *)createCloudRecognitionServiceWithClientToken:(NSString *)clientToken groupId:(NSString *)groupId targetCollectionId:(NSString *)targetCollectionId completion:(WTCloudRecognitionServiceInitializationHandler)completionHandler

Parameters

clientToken

The client token that is associated with your Wikitude cloud recognition account.

groupId

The groupId that is associated with your Wikitude cloud recognition account.

targetCollectionId

The identifier for the target collection that should be loaded on the Wikitude cloud recognition server.

completionHandler

An object that conforms to the WTCloudRecognitionServiceInitializationHandler protocol.

Return Value

WTCloudRecognitionService * A pointer to a newly created WTCloudRecognitionService object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createCloudRecognitionServiceWithClientToken:targetCollectionId:completion:

Returns a weak pointer to a newly created WTCloudRecognitionService object, used to offload image target recognition to the Wikitude cloud recognition servers.

- (WTCloudRecognitionService *)createCloudRecognitionServiceWithClientToken:(NSString *)clientToken targetCollectionId:(NSString *)targetCollectionId completion:(WTCloudRecognitionServiceInitializationHandler)completionHandler

Parameters

clientToken

The client token that is associated with your Wikitude cloud recognition account.

targetCollectionId

The identifier for the target collection that should be loaded on the Wikitude cloud recognition server.

completionHandler

An object that conforms to the WTCloudRecognitionServiceInitializationHandler protocol.

Return Value

WTCloudRecognitionService * A pointer to a newly created WTCloudRecognitionService object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createCloudRecognitionServiceWithClientToken:groupId:targetCollectionId:configuration:completion:

Returns a weak pointer to a newly created WTCloudRecognitionService object, used to offload image target recognition to the Wikitude cloud recognition servers.

- (WTCloudRecognitionService *)createCloudRecognitionServiceWithClientToken:(NSString *)clientToken groupId:(NSString *)groupId targetCollectionId:(NSString *)targetCollectionId configuration:(nullable void ( ^ ) ( WTCloudRecognitionServiceConfiguration *cloudRecognitionServiceConfiguration ))configuration completion:(WTCloudRecognitionServiceInitializationHandler)completionHandler

Parameters

clientToken

The client token that is associated with your Wikitude cloud recognition account.

groupId

The groupId that is associated with your Wikitude cloud recognition account.

targetCollectionId

The identifier for the target collection that should be loaded on the Wikitude cloud recognition server.

configuration

The configuration that should be used when the WTCloudRecognitionService is created. Please have a look at WTCloudRecognitionServiceConfiguration for all possible configurations.

completionHandler

An object that conforms to the WTCloudRecognitionServiceInitializationHandler protocol.

Return Value

WTCloudRecognitionService * A pointer to a newly created WTCloudRecognitionService object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createCloudRecognitionServiceWithClientToken:targetCollectionId:configuration:completion:

Returns a weak pointer to a newly created WTCloudRecognitionService object, used to offload image target recognition to the Wikitude cloud recognition servers.

- (WTCloudRecognitionService *)createCloudRecognitionServiceWithClientToken:(NSString *)clientToken targetCollectionId:(NSString *)targetCollectionId configuration:(nullable void ( ^ ) ( WTCloudRecognitionServiceConfiguration *cloudRecognitionServiceConfiguration ))configuration completion:(WTCloudRecognitionServiceInitializationHandler)completionHandler

Parameters

clientToken

The client token that is associated with your Wikitude cloud recognition account.

targetCollectionId

The identifier for the target collection that should be loaded on the Wikitude cloud recognition server.

configuration

The configuration that should be used when the WTCloudRecognitionService is created. Please have a look at WTCloudRecognitionServiceConfiguration for all possible configurations.

completionHandler

An object that conforms to the WTCloudRecognitionServiceInitializationHandler protocol.

Return Value

WTCloudRecognitionService * A pointer to a newly created WTCloudRecognitionService object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createImageTrackerFromTargetCollectionResource:delegate:configuration:

Returns a weak pointer to a newly created WTImageTracker object, configured for 2d tracking using a wtc file loaded by a WTTargetCollectionResource.

- (WTImageTracker *)createImageTrackerFromTargetCollectionResource:(WTTargetCollectionResource *)targetCollectionResource delegate:(id<WTImageTrackerDelegate>)delegate configuration:(nullable void ( ^ ) ( WTImageTrackerConfiguration *imageTrackerConfiguration ))configuration

Parameters

targetCollectionResource

The target collection resource used to load the wtc file.

delegate

An object that conforms to the WTImageTrackerDelegate protocol.

configuration

A configuration object used to define how the image tracker behaves.

Return Value

WTImageTracker * A pointer to a newly created WTImageTracker object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property. In case the given target collection resource is not yet loading, -load: would be called.

Declared In

WTTrackerManager.h

– createImageTrackerFromCloudRecognitionService:delegate:configuration:

Returns a weak pointer to a newly created WTImageTracker object, configured for 2d tracking using the WTCloudRecognitionService to offload recognition to the Wikitude cloud recognition servers.

- (WTImageTracker *)createImageTrackerFromCloudRecognitionService:(WTCloudRecognitionService *)cloudRecognitionService delegate:(id<WTImageTrackerDelegate>)delegate configuration:(nullable void ( ^ ) ( WTImageTrackerConfiguration *imageTrackerConfiguration ))configuration

Parameters

cloudRecognitionService

The cloud recognition service used to communicate with the Wikitude cloud recognition servers.

delegate

An object that conforms to the WTImageTrackerDelegate protocol.

configuration

A configuration object used to define how the image tracker behaves.

Return Value

WTImageTracker * A pointer to a newly created WTImageTracker object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– createObjectTrackerFromTargetCollectionResource:delegate:

Returns a weak pointer to a newly created WTObjectTracker object, configured for 3d tracking using a wmc file loaded by a WTTargetCollectionResource.

- (WTObjectTracker *)createObjectTrackerFromTargetCollectionResource:(WTTargetCollectionResource *)targetCollectionResource delegate:(id<WTObjectTrackerDelegate>)delegate

Parameters

targetCollectionResource

The target collection resource used to load the wmc file.

delegate

An object that conforms to the WTObjectTrackerDelegate protocol.

Return Value

WTObjectTracker * A pointer to a newly created WTObjectTracker object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property. In case the given target collection resource is not yet loading, -load: would be called.

Declared In

WTTrackerManager.h

– createObjectTrackerFromTargetCollectionResource:delegate:configuration:

Returns a weak pointer to a newly created WTObjectTracker object, configured for 3d tracking using a wmc file loaded by a WTTargetCollectionResource.

- (WTObjectTracker *)createObjectTrackerFromTargetCollectionResource:(WTTargetCollectionResource *)targetCollectionResource delegate:(id<WTObjectTrackerDelegate>)delegate configuration:(nullable void ( ^ ) ( WTObjectTrackerConfiguration *objectTrackerConfiguration ))configuration

Parameters

targetCollectionResource

The target collection resource used to load the wmc file.

delegate

An object that conforms to the WTObjectTrackerDelegate protocol.

configuration

A configuration object used to define how the image tracker behaves.

Return Value

WTObjectTracker * A pointer to a newly created WTObjectTracker object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property. In case the given target collection resource is not yet loading, -load: would be called.

Declared In

WTTrackerManager.h

– createInstantTracker:configuration:

Returns a weak pointer to a newly created WTInstantTracker object, configured for 3d tracking of a scene without any markers

- (WTInstantTracker *)createInstantTracker:(id<WTInstantTrackerDelegate>)delegate configuration:(nullable void ( ^ ) ( WTInstantTrackerConfiguration *instantTrackerConfiguration ))configuration

Parameters

delegate

An object that conforms to the WTObjectTrackerDelegate protocol.

configuration

A configuration object used to define how the instant tracker should behave.

Return Value

WTObjectTracker * A pointer to a newly created WTObjectTracker object.

Discussion

Callers need to make sure to retain the reference count e.g. by assigning to a strong property.

Declared In

WTTrackerManager.h

– isPlatformAssistedTrackingSupported

Returns a boolean value indicating whether SMART will be able to run using ARKit.

- (bool)isPlatformAssistedTrackingSupported

Return Value

bool The returned value is true if ARKit is available, false otherwise.

Declared In

WTTrackerManager.h

– setCustomTrackerConfiguration:

Enables a custom Tracker configuration to be applied.

- (bool)setCustomTrackerConfiguration:(NSString *)configuration

Parameters

configuration

A JSON String containing the custom configuration for Trackers.

Return Value

bool The returned value is true if the custom tracker configuration is set successfuly, false otherwise.

Declared In

WTTrackerManager.h