MaxstARSDK
maxstAR.WearableCalibration Class Reference

API for wearable calibration. More...

Collaboration diagram for maxstAR.WearableCalibration:
Collaboration graph

Public Types

enum  EyeType { EyeType.EYE_LEFT = 0, EyeType.EYE_RIGHT = 1, EyeType.EYE_NUM = 2 }
 Types of HMD eyes More...
 
enum  WearableType { WearableType.None = 0, WearableType.OpticalSeeThrough = 1 }
 Wearable Device Type More...
 

Public Member Functions

bool IsActivated ()
 Confirm that the HMD unit is initialized. More...
 
bool Init (string modelName)
 Initialize the HMD device. More...
 
void Deinit ()
 Deinitialize the HMD device. More...
 
void SetSurfaceSize (int width, int height)
 Set the HMD device screen size. More...
 
float [] GetViewport (EyeType eyeType)
 Get HMD screen viewport. More...
 
float [] GetProjectionMatrix (EyeType eyeType)
 Get calibrated HMD projection matrix. More...
 

Static Public Member Functions

static WearableCalibration GetInstance ()
 Get a WearableCalibration instance. More...
 

Detailed Description

API for wearable calibration.

Member Enumeration Documentation

◆ EyeType

Types of HMD eyes

Enumerator
EYE_LEFT 

Left HMD eye

EYE_RIGHT 

Right HMD eye

EYE_NUM 

Number of eyes

◆ WearableType

Wearable Device Type

Enumerator
None 

None Wearable Device

OpticalSeeThrough 

Optical See-throught Wearable Device

Member Function Documentation

◆ Deinit()

void maxstAR.WearableCalibration.Deinit ( )

Deinitialize the HMD device.

◆ GetInstance()

static WearableCalibration maxstAR.WearableCalibration.GetInstance ( )
static

Get a WearableCalibration instance.

Returns
Return the WearableCalibration instance

◆ GetProjectionMatrix()

float [] maxstAR.WearableCalibration.GetProjectionMatrix ( EyeType  eyeType)

Get calibrated HMD projection matrix.

Parameters
eyeTypeTypes of HMD eyes
Returns
Projection matrix array(float type array, size 16).

◆ GetViewport()

float [] maxstAR.WearableCalibration.GetViewport ( EyeType  eyeType)

Get HMD screen viewport.

Parameters
eyeTypeTypes of HMD eyes
Returns
Viewport array(float type array, size 4).

◆ Init()

bool maxstAR.WearableCalibration.Init ( string  modelName)

Initialize the HMD device.

Parameters
modelNameDevice name
Returns
Result of device initialize

◆ IsActivated()

bool maxstAR.WearableCalibration.IsActivated ( )

Confirm that the HMD unit is initialized.

Returns
Result of device initialize

◆ SetSurfaceSize()

void maxstAR.WearableCalibration.SetSurfaceSize ( int  width,
int  height 
)

Set the HMD device screen size.

Parameters
widthScreen width
heightScreen height

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