Maxst AR SDK 4.0.0  4.0.0
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
com.maxst.ar.TrackerManager Class Reference

Classes

enum  TrackingOption
 

Public Member Functions

void startTracker (int trackerType)
 
void setCloudRecognitionSecretIdAndKey (String secretId, String secretKey)
 
void stopTracker ()
 
void destroyTracker ()
 
void addTrackerData (String trackingFileName, boolean isAndroidAssetFile)
 
void removeTrackerData (String trackingFileName)
 
void loadTrackerData ()
 
boolean isTrackerDataLoadCompleted ()
 
TrackingState updateTrackingState ()
 
void findSurface ()
 
void quitFindingSurface ()
 
void setTrackingOption (TrackingOption option)
 
SurfaceThumbnail saveSurfaceData (String fileName)
 
void getWorldPositionFromScreenCoordinate (float[] screenCoord, float[] worldPos)
 
GuideInfo getGuideInformation ()
 
void saveFrames ()
 

Static Public Member Functions

static TrackerManager getInstance ()
 

Static Public Attributes

static final int TRACKER_TYPE_CODE_SCANNER = 0X01
 
static final int TRACKER_TYPE_IMAGE = 0X02
 
static final int TRACKER_TYPE_MARKER = 0X04
 
static final int TRACKER_TYPE_OBJECT = 0X08
 
static final int TRACKER_TYPE_SLAM = 0x10
 
static final int TRACKER_TYPE_INSTANT = 0x20
 
static final int TRACKER_TYPE_CLOUD_RECOGNIZER = 0x30
 

Detailed Description

Control AR Engine

Member Function Documentation

◆ addTrackerData()

void com.maxst.ar.TrackerManager.addTrackerData ( String  trackingFileName,
boolean  isAndroidAssetFile 
)
inline

Add map file to candidate list.

Parameters
trackingFileNameabsolute file path if map file is located in sdcard, relative file name path map file is located in assets folder
isAndroidAssetFileflag for notify map file is located in assets folder

◆ destroyTracker()

void com.maxst.ar.TrackerManager.destroyTracker ( )
inline

Remove all tracking data (Map data and tracking result)

◆ findSurface()

void com.maxst.ar.TrackerManager.findSurface ( )
inline

Start to find the surface of an environment from a camera image (works on Instant Tracker and SLAM)

◆ getGuideInformation()

GuideInfo com.maxst.ar.TrackerManager.getGuideInformation ( )
inline

Get guide information describing SLAM status (initializing progress, # keyframes, # features and feature position) after the findSurface method has been called

Returns
GuideInfo instance

◆ getWorldPositionFromScreenCoordinate()

void com.maxst.ar.TrackerManager.getWorldPositionFromScreenCoordinate ( float []  screenCoord,
float []  worldPos 
)
inline

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

Parameters
screenCoordscreen touch x, y position
worldPosworld position x, y, z

◆ isTrackerDataLoadCompleted()

boolean com.maxst.ar.TrackerManager.isTrackerDataLoadCompleted ( )
inline

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

Returns
true if map loading is completed

◆ loadTrackerData()

void com.maxst.ar.TrackerManager.loadTrackerData ( )
inline

Load map files in candidate list to memory. This method don't block main(UI) thread

◆ quitFindingSurface()

void com.maxst.ar.TrackerManager.quitFindingSurface ( )
inline

Stop to find the surface (works on Instant Tracker and SLAM)

◆ removeTrackerData()

void com.maxst.ar.TrackerManager.removeTrackerData ( String  trackingFileName)
inline

Remove map file from candidate list.

Parameters
trackingFileNamemap file name. If set "" (empty) file list will be cleared.

◆ saveSurfaceData()

SurfaceThumbnail com.maxst.ar.TrackerManager.saveSurfaceData ( String  fileName)
inline

Save the surface data to file (works on only SLAM). A saved file is loaded and used in Object Tracker.

Parameters
fileNamefile path (should be absolute path)
Returns
SurfaceThumbnail instance if true else null

◆ setCloudRecognitionSecretIdAndKey()

void com.maxst.ar.TrackerManager.setCloudRecognitionSecretIdAndKey ( String  secretId,
String  secretKey 
)
inline

Set secret ID and key for access of cloud recognition

Parameters
secretIdsecret ID
secretKeysecret key

◆ setTrackingOption()

void com.maxst.ar.TrackerManager.setTrackingOption ( TrackingOption  option)
inline

Set tracking options.

Parameters
optiontracking option TrackingOption.NORMAL_TRACKING : Normal Tracking (Image Tracker Only, Default Option for Image Tracker) TrackingOption.EXTENDED_TRACKING : Extended Tracking (Image Tracker Only) TrackingOption.MULTI_TRACKING : Multiple Target Tracking (Image Tracker Only) TrackingOption.JITTER_REDUCTION_ACTIVATION : Jitter Reduction Activation (Marker, Image, and Object Tracker) TrackingOption.JITTER_REDUCTION_DEACTIVATION : Jitter Reduction Deactivation (Marker, Image, and Object Tracker, Default Option for Jitter Reduction)

◆ startTracker()

void com.maxst.ar.TrackerManager.startTracker ( int  trackerType)
inline

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

Parameters
trackerTypetracking engine type

◆ stopTracker()

void com.maxst.ar.TrackerManager.stopTracker ( )
inline

Stop tracking engine

◆ updateTrackingState()

TrackingState com.maxst.ar.TrackerManager.updateTrackingState ( )
inline

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

Returns
tracking state

Member Data Documentation

◆ TRACKER_TYPE_CLOUD_RECOGNIZER

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_CLOUD_RECOGNIZER = 0x30
static

Cloud recognizer

◆ TRACKER_TYPE_CODE_SCANNER

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_CODE_SCANNER = 0X01
static

Code scanner

◆ TRACKER_TYPE_IMAGE

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_IMAGE = 0X02
static

Planar image tracker

◆ TRACKER_TYPE_INSTANT

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_INSTANT = 0x20
static

Instant tracker

◆ TRACKER_TYPE_MARKER

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_MARKER = 0X04
static

Marker tracker

◆ TRACKER_TYPE_OBJECT

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_OBJECT = 0X08
static

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

◆ TRACKER_TYPE_SLAM

final int com.maxst.ar.TrackerManager.TRACKER_TYPE_SLAM = 0x10
static

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


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