Holoboard Basic SDK  v1.4
Software Development Kit for developing applications on smartphones for Holoboard (www.myholo.io)
TesseractBasic.ARCamera Class Reference

This component is reponsible for camera pose tracking and steroe rendering, along with maintaining system states. More...

Inheritance diagram for TesseractBasic.ARCamera:

Public Member Functions

void Recenter ()
 Use this function to recenter the head orientation so that it faces the transform set by RecenterPoint More...
 
void SetRecenterPoint (Transform recenterPoint)
 Use this function to set the recenter Transform More...
 
void EnableHeadTracking ()
 Enables the head tracking. More...
 
void DisableHeadTracking ()
 Disables the head tracking. More...
 
void CloseApplication ()
 Closes the application. More...
 
bool GetHeadTrackingState ()
 Gets the state of the head tracking. More...
 
Vector2 GetGazePointOnScreen ()
 Gets the gaze point on screen that can be used for Raycasting. More...
 
Camera GetRayCastCamera ()
 Gets the ray cast camera that can be used for Raycasting More...
 
Transform GetHeadTransform ()
 Gets the head transform. More...
 
GameObject GetHeadGameObject ()
 Gets the head game object. More...
 
Ray GetRayFromGaze ()
 Gets the ray from gaze. More...
 
void StartCalibration ()
 Use this function to tell the system that you want to initiate IPD calibration. This is only required if you are designing your own custom calibration routine. DO NOT call this if you are using the default IPDCalibration Prefab provided with this package. Instead call IPDCalibration.BeginIPDCalibration . More...
 
void IncreaseIPD (float increment=-1)
 Increase IPD or Eye Separation by increment factor More...
 
void DecreaseIPD (float increment=-1)
 Decrease IPD or Eye Separation by increment factor More...
 
void StopIPDCalibration ()
 Completes the IPD calibration. Use this ONLY if you have a custom calibration UI. You should disable any custom calibration UI that you used with StartCalibration here. DO NOT call this if you are using the default IPDCalibration Prefab provided with this package. Instead call IPDCalibration.EndIPDCalibration . More...
 
bool IsHybridTrackingEnabled ()
 Is hybrid tracking enabled. More...
 
bool IsThirdPartySDKInUse ()
 Is any third party SDK in use. More...
 

Public Attributes

string APIKey
 Developer API Key corresponding to a particular Bundle ID. More...
 

Static Public Attributes

static ARCamera Instance = null
 Singleton Instance of ARCamera More...
 

Detailed Description

This component is reponsible for camera pose tracking and steroe rendering, along with maintaining system states.

Member Function Documentation

◆ CloseApplication()

void TesseractBasic.ARCamera.CloseApplication ( )

Closes the application.

◆ DecreaseIPD()

void TesseractBasic.ARCamera.DecreaseIPD ( float  increment = -1)

Decrease IPD or Eye Separation by increment factor

Parameters
incrementFactor to decrease the IPD with. Default is 0.01 if no argument is provided (optional)

◆ DisableHeadTracking()

void TesseractBasic.ARCamera.DisableHeadTracking ( )

Disables the head tracking.

◆ EnableHeadTracking()

void TesseractBasic.ARCamera.EnableHeadTracking ( )

Enables the head tracking.

◆ GetGazePointOnScreen()

Vector2 TesseractBasic.ARCamera.GetGazePointOnScreen ( )

Gets the gaze point on screen that can be used for Raycasting.

Returns
The gaze point on screen.

◆ GetHeadGameObject()

GameObject TesseractBasic.ARCamera.GetHeadGameObject ( )

Gets the head game object.

Returns
The head game object.

◆ GetHeadTrackingState()

bool TesseractBasic.ARCamera.GetHeadTrackingState ( )

Gets the state of the head tracking.

Returns
true, if head tracking is ON, false otherwise.

◆ GetHeadTransform()

Transform TesseractBasic.ARCamera.GetHeadTransform ( )

Gets the head transform.

Returns
The head transform.

◆ GetRayCastCamera()

Camera TesseractBasic.ARCamera.GetRayCastCamera ( )

Gets the ray cast camera that can be used for Raycasting

Returns
The ray cast camera.

◆ GetRayFromGaze()

Ray TesseractBasic.ARCamera.GetRayFromGaze ( )

Gets the ray from gaze.

Returns
The ray from gaze.

◆ IncreaseIPD()

void TesseractBasic.ARCamera.IncreaseIPD ( float  increment = -1)

Increase IPD or Eye Separation by increment factor

Parameters
incrementFactor to increase the IPD with. Default is 0.01 if no argument is provided.

◆ IsHybridTrackingEnabled()

bool TesseractBasic.ARCamera.IsHybridTrackingEnabled ( )

Is hybrid tracking enabled.

Returns
true, if hybrid tracking enabled was ised, false otherwise.

◆ IsThirdPartySDKInUse()

bool TesseractBasic.ARCamera.IsThirdPartySDKInUse ( )

Is any third party SDK in use.

Returns
true, if third party SDKI n use was ised, false otherwise.

◆ Recenter()

void TesseractBasic.ARCamera.Recenter ( )

Use this function to recenter the head orientation so that it faces the transform set by RecenterPoint

◆ SetRecenterPoint()

void TesseractBasic.ARCamera.SetRecenterPoint ( Transform  recenterPoint)

Use this function to set the recenter Transform

◆ StartCalibration()

void TesseractBasic.ARCamera.StartCalibration ( )

Use this function to tell the system that you want to initiate IPD calibration. This is only required if you are designing your own custom calibration routine. DO NOT call this if you are using the default IPDCalibration Prefab provided with this package. Instead call IPDCalibration.BeginIPDCalibration .

◆ StopIPDCalibration()

void TesseractBasic.ARCamera.StopIPDCalibration ( )

Completes the IPD calibration. Use this ONLY if you have a custom calibration UI. You should disable any custom calibration UI that you used with StartCalibration here. DO NOT call this if you are using the default IPDCalibration Prefab provided with this package. Instead call IPDCalibration.EndIPDCalibration .

Member Data Documentation

◆ APIKey

string TesseractBasic.ARCamera.APIKey

Developer API Key corresponding to a particular Bundle ID.

◆ Instance

ARCamera TesseractBasic.ARCamera.Instance = null
static

Singleton Instance of ARCamera


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