MaxstARSDK  3.5.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...
 
(int) - getKeyframeCount
 Get the number of keyframes included in surface data. 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
 

Protected Member Functions

(typedef) - NS_ENUM
 
(typedef) - NS_ENUM
 

Detailed Description

Control AR Engine.

Definition at line 18 of file MasTrackerManager.h.

Method Documentation

◆ addTrackerData:()

- (void) addTrackerData: (NSString*)  trackingFileName

Add map file to candidate list.

Parameters
trackingFileNameabsolute file path

Definition at line 44 of file MasTrackerManager.mm.

◆ getGuideInfo()

- (MasGuideInfo *) getGuideInfo

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

Returns
MasSurfaceMesh instance

Definition at line 102 of file MasTrackerManager.mm.

◆ getKeyframeCount()

- (int) getKeyframeCount

Get the number of keyframes included in surface data.

Returns
key frame count

Definition at line 98 of file MasTrackerManager.mm.

◆ 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

Definition at line 94 of file MasTrackerManager.mm.

◆ isTrackerDataLoadCompleted()

- (bool) isTrackerDataLoadCompleted

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

Returns
true if map loading is completed

Definition at line 56 of file MasTrackerManager.mm.

◆ 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.

Definition at line 48 of file MasTrackerManager.mm.

◆ 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

Definition at line 80 of file MasTrackerManager.mm.

◆ 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)

Definition at line 115 of file MasTrackerManager.mm.

◆ startTracker:()

- (void) startTracker: (TrackerType)  trackerMask

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

Parameters
trackerMasktracking engine type

Definition at line 32 of file MasTrackerManager.mm.

◆ updateTrackingState()

- (MasTrackingState *) updateTrackingState

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

Returns
Tracking state container

Definition at line 60 of file MasTrackerManager.mm.


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