MaxstARSDK
maxstAR::WearableCalibration Class Referenceabstract

This class is for optical see-through wearable calibration. More...

#include <WearableCalibration.h>

Collaboration diagram for maxstAR::WearableCalibration:
Collaboration graph

Public Member Functions

virtual bool isActivated ()=0
 Get wearable calibration activate state. More...
 
virtual bool init (std::string deviceName, int targetWidth, int targetHeight)=0
 Init wearable calibration process. More...
 
virtual void deinit ()=0
 Deinit wearable calibration process. More...
 
virtual void setSurfaceSize (int width, int height)=0
 Set screen size of target device. More...
 
virtual void setCameraToEyePose (int eyeType, int distanceType, float *pose)=0
 Set camera to eye 4x4 pose matrix for calibration. More...
 
virtual float * getRt4x4 (int eyeType)=0
 Get calibrated extrinsic parameter. More...
 
virtual float * getK3x3 (int eyeType)=0
 Get calibrated intrinsic parameter. More...
 
virtual float * getViewport (int eyeType)=0
 Get calibrated viewport for opengl. More...
 
virtual float * getProjectionMatrix (int eyeType)=0
 Get calibrated projection matrix for opengl. More...
 
virtual void getDistancePos (int distanceType, float &x, float &y, float &z)=0
 Get calibration guide target position according to distance type. More...
 
virtual float * getScreenCoordinate ()=0
 Get orthogonal screen projection matrix. More...
 
virtual void getTargetGLScale (int distanceType, float *scale)=0
 Get calibration guide target scale according to distance type for opengl. More...
 
virtual void getTargetGLPosition (int distanceType, float *position)=0
 Get calibration guide target position according to distance type for opengl. More...
 
virtual bool setProfile (char *profile)=0
 Set calibrated info array. More...
 
virtual bool writeProfile (std::string fileName)=0
 Write calibrated info to file. More...
 
virtual bool readProfile (std::string filePath)=0
 Read calibrated info to file. More...
 

Static Public Member Functions

static WearableCalibrationgetInstance ()
 

Detailed Description

This class is for optical see-through wearable calibration.

Member Function Documentation

◆ deinit()

virtual void maxstAR::WearableCalibration::deinit ( )
pure virtual

Deinit wearable calibration process.

◆ getDistancePos()

virtual void maxstAR::WearableCalibration::getDistancePos ( int  distanceType,
float &  x,
float &  y,
float &  z 
)
pure virtual

Get calibration guide target position according to distance type.

Parameters
distanceTypeType of distance
xPosition x of guide target
yPosition y of guide target
zPosition z of guide target

◆ getInstance()

static WearableCalibration* maxstAR::WearableCalibration::getInstance ( )
static

◆ getK3x3()

virtual float* maxstAR::WearableCalibration::getK3x3 ( int  eyeType)
pure virtual

Get calibrated intrinsic parameter.

Returns
3x3 intrinsic camera matrix

◆ getProjectionMatrix()

virtual float* maxstAR::WearableCalibration::getProjectionMatrix ( int  eyeType)
pure virtual

Get calibrated projection matrix for opengl.

Parameters
eyeTypeId of eye
Returns
projection matrix 4x4

◆ getRt4x4()

virtual float* maxstAR::WearableCalibration::getRt4x4 ( int  eyeType)
pure virtual

Get calibrated extrinsic parameter.

Returns
4x4 extrinsic camera matrix

◆ getScreenCoordinate()

virtual float* maxstAR::WearableCalibration::getScreenCoordinate ( )
pure virtual

Get orthogonal screen projection matrix.

Returns
projection matrix 4x4

◆ getTargetGLPosition()

virtual void maxstAR::WearableCalibration::getTargetGLPosition ( int  distanceType,
float *  position 
)
pure virtual

Get calibration guide target position according to distance type for opengl.

Parameters
distanceTypeType of distance
positiontarget position (x, y, z)

◆ getTargetGLScale()

virtual void maxstAR::WearableCalibration::getTargetGLScale ( int  distanceType,
float *  scale 
)
pure virtual

Get calibration guide target scale according to distance type for opengl.

Parameters
distanceTypeType of distance
scaletarget scale (x, y, z)

◆ getViewport()

virtual float* maxstAR::WearableCalibration::getViewport ( int  eyeType)
pure virtual

Get calibrated viewport for opengl.

Parameters
eyeTypeId of eye
Returns
viewport (x, y, width, height)

◆ init()

virtual bool maxstAR::WearableCalibration::init ( std::string  deviceName,
int  targetWidth,
int  targetHeight 
)
pure virtual

Init wearable calibration process.

Parameters
deviceNameSupported devices name
targetWidthCalibration target width
targetHeightCalibration target height

◆ isActivated()

virtual bool maxstAR::WearableCalibration::isActivated ( )
pure virtual

Get wearable calibration activate state.

Returns
true if wearable calibration is activated

◆ readProfile()

virtual bool maxstAR::WearableCalibration::readProfile ( std::string  filePath)
pure virtual

Read calibrated info to file.

Parameters
fileNamefile path for read
Returns
True if file is read

◆ setCameraToEyePose()

virtual void maxstAR::WearableCalibration::setCameraToEyePose ( int  eyeType,
int  distanceType,
float *  pose 
)
pure virtual

Set camera to eye 4x4 pose matrix for calibration.

Parameters
eyeTypeId of eye for calibration
distanceTypeType of distance for calibration
poseTracking pose for calibration

◆ setProfile()

virtual bool maxstAR::WearableCalibration::setProfile ( char *  profile)
pure virtual

Set calibrated info array.

Parameters
profilecalibrated info array
Returns
True if setting is successed

◆ setSurfaceSize()

virtual void maxstAR::WearableCalibration::setSurfaceSize ( int  width,
int  height 
)
pure virtual

Set screen size of target device.

Parameters
widthwidth of target device
heightheight of target device

◆ writeProfile()

virtual bool maxstAR::WearableCalibration::writeProfile ( std::string  fileName)
pure virtual

Write calibrated info to file.

Parameters
fileNamefile path for write
Returns
True if file is writed

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