Maxst AR SDK 4.0.0  4.0.0
Instance Methods | Protected Member Functions | List of all members
MasTrackerManager Class Reference

Control AR Engine. More...

#import <MasTrackerManager.h>

Inheritance diagram for MasTrackerManager:

Instance Methods

(void) - startTracker:
 Start AR engine. Only one tracking engine could be run at one time. More...
 
(void) - stopTracker
 Stop tracking engine.
 
(void) - destroyTracker
 Remove all tracking data (Map data and tracking result)
 
(void) - addTrackerData:
 Add map file to candidate list. More...
 
(void) - removeTrackerData:
 Remove map file from candidate list. More...
 
(void) - loadTrackerData
 Load map files in candidate list to memory. This method don't block main(UI) thread.
 
(bool) - isTrackerDataLoadCompleted
 Get map files loading state. This is for UI expression. More...
 
(MasTrackingState *) - updateTrackingState
 
(void) - findSurface
 Start to find the surface of an environment from a camera image.
 
(void) - quitFindingSurface
 Stop to find the surface.
 
(MasSurfaceThumbnail *) - saveSurfaceData:
 Save the surface data to file. More...
 
(void) - getWorldPositionFromScreenCoordinate:world:
 Get 3d world coordinate corresponding to given 2d screen position. More...
 
(MasGuideInfo *) - getGuideInfo
 Get surface mesh information of the found surface after the findSurface method has been called. More...
 
(void) - setTrackingOption:
 Set tracking options. 1, 2, 4 cannot run simultaneously. More...
 
(void) - saveFrames
 
(void) - setCloudRecognitionSecretId:secretKey:
 Set secret ID and key for access of cloud recognition. More...
 

Protected Member Functions

(typedef) - NS_ENUM
 
(typedef) - NS_ENUM
 

Detailed Description

Control AR Engine.

Method Documentation

◆ addTrackerData:()

- (void) addTrackerData: (NSString*)  trackingFileName

Add map file to candidate list.

Parameters
trackingFileNameabsolute file path

◆ getGuideInfo()

- (MasGuideInfo *) getGuideInfo

Get surface mesh information of the found surface after the findSurface method has been called.

Returns
MasSurfaceMesh instance

◆ getWorldPositionFromScreenCoordinate:world:()

- (void) getWorldPositionFromScreenCoordinate: (float*)  screen
world: (float*)  world 

Get 3d world coordinate corresponding to given 2d screen position.

Parameters
screenscreen touch x, y position
worldworld position x, y, z

◆ isTrackerDataLoadCompleted()

- (bool) isTrackerDataLoadCompleted

Get map files loading state. This is for UI expression.

Returns
true if map loading is completed

◆ NS_ENUM() [1/2]

- (typedef) NS_ENUM (int) 
(TrackerType)   

Code scanner

Planar image tracker

Code scanner

Object tracker (Object data should be created via SLAM tracker)

Visual slam tracker (Can create surface data and save it)

Instant tracker

Cloud recognizer

◆ NS_ENUM() [2/2]

- (typedef) NS_ENUM (int) 
(TrackingOption)   

Normal Tracking (Image Tracker Only)

Extended Tracking (Image Tracker Only)

Multi Target Tracking (Image Tracker Only)

Jitter Reduction Activation (Marker, Image, and object trackers)

Jitter Reduction Deactivation (Marker, Image, and object trackers)

◆ removeTrackerData:()

- (void) removeTrackerData: (NSString*)  trackingFileName

Remove map file from candidate list.

Parameters
trackingFileNamemap file name. This name should be same which added. If set "" (empty) file list will be cleared.

◆ saveSurfaceData:()

- (MasSurfaceThumbnail *) saveSurfaceData: (NSString*)  outputFileName

Save the surface data to file.

Parameters
outputFileNamefile path (should be absolute path)
Returns
MasSurfaceThumbnail instance if true else null

◆ setCloudRecognitionSecretId:secretKey:()

- (void) setCloudRecognitionSecretId: (NSString*)  secretId
secretKey: (NSString*)  secretKey 

Set secret ID and key for access of cloud recognition.

Parameters
secretIdsecret ID
secretKeysecret key

◆ setTrackingOption:()

- (void) setTrackingOption: (TrackingOption)  option

Set tracking options. 1, 2, 4 cannot run simultaneously.

Parameters
option1 : Normal Tracking (Image Tracker Only) 2 : Extended Tracking (Image Tracker Only) 4 : Multiple Target Tracking (Image Tracker Only)

◆ startTracker:()

- (void) startTracker: (TrackerType)  trackerMask

Start AR engine. Only one tracking engine could be run at one time.

Parameters
trackerMasktracking engine type

◆ updateTrackingState()

- (MasTrackingState *) updateTrackingState

Update tracking state. This function should be called before getTrackingResult and background rendering

Returns
Tracking state container

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