CraftARTracking Class Reference

Inheritance diagram for CraftARTracking:

Instance Methods
(void)	- startTracking

(void)	- startTrackingWithTimeout:

(void)	- stopTracking

(BOOL)	- isTracking

(CraftARError *)	- addARItem:

(void)	- setCollection:withOnProgress:onDone:

(void)	- setCollection:withOnDone:

(void)	- removeARItem:

(void)	- removeAllARItems

(void)	- checkImageQuality:withOnSuccess:andOnError:

(bool)	- setMaxItemsTrackedSimultaneously:

Class Methods
(CraftARTracking *)	+ sharedTracking

Properties
id< CraftARTrackingEventsProtocol >	delegate
	The tracking delegate will receive events from the tracking (started/stop tracking an AR item)

Method Documentation

- (CraftARError*) addARItem: (CraftARItemAR *) item

Add a CraftAR AR item to initiate a tracking augmented reality experience

Parameters

item	to be added for tracking.

Returns: CraftARError NSError indicating if there has been any problem adding the item, nil if there are no errors.

See Also: CraftARItemAR

Note: This process can take some time, consider calling this method on a background queue.

- (void) checkImageQuality:	(UIImage *)	image
withOnSuccess:	(void(^)(float trackability))	onSuccess
andOnError:	(void(^)(NSError *error))	onError

Check the Quality of an image for AR. Tests how good the image is for tracking based on the texture it has. Calls back onSuccess with the trackability or onError if it was not possible to do the operation. Do not call this method while tracking, it may affect its performance.

- (BOOL) isTracking

Returns whether the tracking is enabled or not (startTracking has been called)

- (void) removeAllARItems

Removes all items

- (void) removeARItem: (CraftARItemAR *) item

Remove an AR item from the augmented reality experience if the item has not been added, this method has no effect.

Parameters

item	The item to be removed from the tracking module.

See Also: CraftARItemAR

- (void) setCollection:	(CraftAROnDeviceCollection *)	collection
withOnDone:	(void(^)(NSArray *errors))	onDoneBlock

Add All AR items from a collection to the tracking

Parameters

collection	CraftAROnDeviceCollection to add to the tracking.
onDone	Executed when the whole collection has been added containing errors for the ARItems that failed adding.

- (void) setCollection:	(CraftAROnDeviceCollection *)	collection
withOnProgress:	(void(^)(float progress))	onProgressBlock
onDone:	(void(^)(NSArray *errors))	onDoneBlock

Add All AR items from a collection to the tracking

Parameters

collection	CraftAROnDeviceCollection to add to the tracking.
onProgress	Executed upon progresss in the collection load into the tracking.
onDone	Executed when the whole collection has been added containing errors for the ARItems that failed adding.

- (bool) setMaxItemsTrackedSimultaneously: (int) maxItems

Set the maximum number of items to be tracked simultaneously. This limit only affects the number of ARItems that will be augmented at the same time, not how many items can be added for augmentation.

Parameters

maxItems The default vaule is 3

Returns: True if the operation was successful

+ (CraftARTracking*) sharedTracking

Get the singleton instance of the CraftARTracking class

- (void) startTracking

Starts tracking the added AR items.

- (void) startTrackingWithTimeout: (NSTimeInterval) timeout

Starts tracking the added AR items.

Parameters

timeout Maximum amount of time to wait to detect AR Items. If no item is detected after this time, the trackingTimeoutOver message will be sent to the delegate.

- (void) stopTracking

Stop the tracking.

The documentation for this class was generated from the following file: