maxstAR Namespace Reference

Classes
class	BackgroundRenderer
	Do background rendering. Background rendering includes camera image, feature point, slam initialization progress bar, watermark, surface mesh. More...
class	BackgroundTexture
	Contains information of background rendering texture. More...
class	CameraDevice
	class for camera device handling More...
class	Image
	image data which is used for tracker and rendering More...
class	ITrackable
	Container for individual tracking information. More...
class	ITrackingResult
	Contains tracked targets informations. More...
class	SensorDevice
	Control device sensor. More...
class	SurfaceMesh
	Contains surface's mesh data generated from slam tracking. More...
class	SurfaceThumbnail
	Contains surface thumbnail image information of first keyframe. More...
class	TrackerManager
	Control AR Engine. More...
class	TrackingState
class	WearableCalibration
	This class is for optical see-through wearable calibration. More...

Enumerations
enum	EyeType { EYE_LEFT = 0, EYE_RIGHT = 1, EYE_NUM = 2 }
	List of eye id. EYE_LEFT : Left eye id EYE_RIGHT : Right eye id EYE_NUM : Number of ids. More...
enum	DistanceType { DISTANCE_NEAR = 0, DISTANCE_MIDDLE = 1, DISTANCE_FAR = 2, DISTANCE_NUM = 3 }
	List of calibration distance. DISTANCE_NEAR : Calibration near distance DISTANCE_MIDDLE : Calibration middle distance DISTANCE_FAR : Calibration far distance DISTANCE_NUM : Number of ids. More...

Functions
MAXSTAR_API void	init (string appKey)
	Initialize AR engine. More...
MAXSTAR_API void	deinit ()
	Deinitialize AR Engine. More...
MAXSTAR_API bool	isInitialized ()
	Check AR engine has been initialized. More...
MAXSTAR_API void	onSurfaceCreated ()
	Called when surface created on rendering thread. More...
MAXSTAR_API void	onSurfaceChanged (int viewWidth, int viewHeight)
	Called when rendering surface's size changed (i.e. orientation change, resizing rendering surface) More...
MAXSTAR_API void	onSurfaceDestroyed ()
	Called when rendering surface about to destroyed. More...
MAXSTAR_API void	setScreenOrientation (ScreenOrientation orientation)
	Set device orientation. More...

Enumeration Type Documentation

DistanceType

enum maxstAR::DistanceType

List of calibration distance. DISTANCE_NEAR : Calibration near distance DISTANCE_MIDDLE : Calibration middle distance DISTANCE_FAR : Calibration far distance DISTANCE_NUM : Number of ids.

Enumerator
DISTANCE_NEAR
DISTANCE_MIDDLE
DISTANCE_FAR
DISTANCE_NUM

EyeType

enum maxstAR::EyeType

List of eye id. EYE_LEFT : Left eye id EYE_RIGHT : Right eye id EYE_NUM : Number of ids.

Enumerator
EYE_LEFT
EYE_RIGHT
EYE_NUM

Function Documentation

deinit()

MAXSTAR_API void maxstAR::deinit

(

)

Deinitialize AR Engine.

init()

MAXSTAR_API void maxstAR::init

(

string

appKey

)

Initialize AR engine.

Parameters

appKey

app key for this app generated from "developer.maxst.com" (Mobile only)

isInitialized()

MAXSTAR_API bool maxstAR::isInitialized

(

)

Check AR engine has been initialized.

onSurfaceChanged()

MAXSTAR_API void maxstAR::onSurfaceChanged	(	int	viewWidth,
		int	viewHeight
	)

Called when rendering surface's size changed (i.e. orientation change, resizing rendering surface)

Parameters

viewWidth	width size (pixel unit)
viewHeight	height size (pixel unit)

onSurfaceCreated()

MAXSTAR_API void maxstAR::onSurfaceCreated

(

)

Called when surface created on rendering thread.

onSurfaceDestroyed()

MAXSTAR_API void maxstAR::onSurfaceDestroyed

(

)

Called when rendering surface about to destroyed.

setScreenOrientation()

MAXSTAR_API void maxstAR::setScreenOrientation

(

ScreenOrientation

orientation

)

Set device orientation.

Parameters

orientation

Screen orientation. 2 is Configuration.ORIENTATION_LANDSCAPE, 1 is Configuration.ORIENTATION_PORTRAIT