MaxstARSDK  3.5.0
Public Types | Public Member Functions | Static Public Member Functions | Properties | List of all members
maxstAR.WearableCalibration Class Reference

API for wearable calibration. More...

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, int width, int height)
 Initialize the HMD device. More...
 
void Deinit ()
 Deinitialize the HMD device. 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...
 

Properties

string activeProfile [get, set]
 

Detailed Description

API for wearable calibration.

Definition at line 15 of file WearableCalibration.cs.

Member Enumeration Documentation

◆ EyeType

Types of HMD eyes

Enumerator
EYE_LEFT 

Left HMD eye

EYE_RIGHT 

Right HMD eye

EYE_NUM 

Number of eyes

Definition at line 20 of file WearableCalibration.cs.

◆ WearableType

Wearable Device Type

Enumerator
None 

None Wearable Device

OpticalSeeThrough 

Optical See-throught Wearable Device

Definition at line 41 of file WearableCalibration.cs.

Member Function Documentation

◆ Deinit()

void maxstAR.WearableCalibration.Deinit ( )

Deinitialize the HMD device.

Definition at line 137 of file WearableCalibration.cs.

◆ GetInstance()

static WearableCalibration maxstAR.WearableCalibration.GetInstance ( )
static

Get a WearableCalibration instance.

Returns
Return the WearableCalibration instance

Definition at line 60 of file WearableCalibration.cs.

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

Definition at line 196 of file WearableCalibration.cs.

◆ GetViewport()

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

Get HMD screen viewport.

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

Definition at line 171 of file WearableCalibration.cs.

◆ Init()

bool maxstAR.WearableCalibration.Init ( string  modelName,
int  width,
int  height 
)

Initialize the HMD device.

Parameters
modelNameDevice name
widthDevice screen width
heightDevice screen height
Returns
Result of device initialize

Definition at line 98 of file WearableCalibration.cs.

◆ IsActivated()

bool maxstAR.WearableCalibration.IsActivated ( )

Confirm that the HMD unit is initialized.

Returns
Result of device initialize

Definition at line 79 of file WearableCalibration.cs.


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