ARImageTrackableSet Class Reference

#import <ARImageTrackableSet.h>

Inherits NSObject.

Instance Methods
(instancetype)	- initWithPath:
(instancetype)	- initWithBundledFile:
(void)	- allowRecoveryMode
(void)	- forceRecoveryMode
(void)	- prohibitRecoveryMode

Properties
NSUInteger	numberOfTrackables
NSArray *	trackables

Detailed Description

This class represents a set of ARImageTrackable objects, typically imported from a .KARMarker file.

Method Documentation

allowRecoveryMode

- (void) allowRecoveryMode

Set this marker set to use flow recovery, if the global setting is switched on (default to global setting). This applies to all markers in the set. To alter a specific marker within the set, it is necessary to take the trackable from the array and set it individually.

Example of use:

ARImageTrackableSet *trackableSet = [[ARImageTrackableSet alloc] initWithPath:@"example.KARMarker"];
[trackableSet allowRecoveryMode];

forceRecoveryMode

- (void) forceRecoveryMode

Make this marker set use flow recovery irrespective of the global setting. This applies to all markers in the set.

Example of use:

ARImageTrackableSet *trackableSet = [[ARImageTrackableSet alloc] initWithPath:@"example.KARMarker"];
[trackableSet forceRecoveryMode];

initWithBundledFile:

- (instancetype) initWithBundledFile:

(NSString *)

file

Initialise an ARImageTrackableSet with a trackable set file.

Example of use:

ARImageTrackableSet *trackableSet = [[ARImageTrackableSet alloc] initWithBundledFile:@"example.KARMarker"];

Parameters

file	The file relative to the main bundle, including the file extension. This file should have been generated using the Kudan AR Toolkit and be in the .KARMarker format.

initWithPath:

- (instancetype) initWithPath:

(NSString *)

path

Initialise an ARImageTrackableSet with a trackable set file.

Example of use:

NSString *filePath = [[[NSBundle mainBundle] resourcePath] stringByAppendingString:@"example.KARMarker"];
ARImageTrackableSet *imageTrackableSet = [[ARImageTrackable alloc] initWithPath:filePath];

Parameters

path	The full path name to the trackable set file. This includes all folders and the file extension. This file should have been generated by the Kudan AR Toolkit and be in the .KARMarker format.

prohibitRecoveryMode

- (void) prohibitRecoveryMode

Prevent this set marker from using flow recovery, irrespective of the global setting. This applies to all markers in the set.

Example of use:

ARImageTrackableSet *trackableSet = [[ARImageTrackableSet alloc] initWithPath:@"example.KARMarker"];
[trackableSet prohibitRecoveryMode];

Property Documentation

numberOfTrackables

- (NSUInteger) numberOfTrackables

readnonatomicassign

The number of trackables in this set.

trackables

- (NSArray *) trackables

readnonatomicassign

The array of ARImageTrackable objects in this set.

---

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

• ARImageTrackableSet.h
• ARImageTrackableSet.mm