documentation

Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera Class Reference

Camera used to define the initial pose for the HoloLens model-based tracking. More...

Inherits Visometry.VisionLib.SDK.Core.TrackingManagerReference.

Public Member Functions

void Reset ()
 
void ResetToOriginalPose ()
 Restores the original transformation of the InitCamera. More...
 

Data Fields

HoloLensTracker holoLensTracker
 Reference to used HoloLensTracker. More...
 
Camera initCamera
 Reference to the Camera. More...
 
bool keepUpright = false
 Adapt initial pose to always be upright. More...
 
Vector3 upAxis = Vector3.up
 Defines the up-axis used by the keepUpright option. More...
 
bool usePoseFromTrackingConfig
 Overwrite camera transformation with values from tracking configuration. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Visometry.VisionLib.SDK.Core.TrackingManagerReference
virtual bool InitWorkerReference ()
 Initializes the trackingManager and Worker member variables. More...
 
virtual void ResetReference ()
 
- Properties inherited from Visometry.VisionLib.SDK.Core.TrackingManagerReference
TrackingManager trackingManager [get]
 Reference to used TrackingManager. More...
 
Worker worker [get]
 

Detailed Description

Camera used to define the initial pose for the HoloLens model-based tracking.

If there is no HoloLensInitCamera in the scene or the HoloLensInitCamera is disabled, then the HoloLens model-based tracking will not work correctly.

It's possible to change the camera position and orientation at runtime. The new initial pose will then be used while the tracking is lost.

Please make sure, that there is only one active HoloLensInitCamera in the scene. Otherwise both behaviours will try to set the initial pose, which will lead to unexpected behaviour.

Member Function Documentation

◆ ResetToOriginalPose()

void Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera.ResetToOriginalPose ( )
inline

Restores the original transformation of the InitCamera.

This might be useful if the InitCamera was transformed in some awkward way for some reason and we quickly want to restore the original state.

If usePoseFromTrackingConfig is set to false, then this will restore the transformation during the initialization of the HoloLensInitCamera. If usePoseFromTrackingConfig is set to true, then this will restore the transformation from the tracking configuration.

Field Documentation

◆ holoLensTracker

HoloLensTracker Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera.holoLensTracker

Reference to used HoloLensTracker.

If this is not defined, then the first found HoloLensTracker will be used automatically.

◆ initCamera

Camera Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera.initCamera

Reference to the Camera.

If this is not defined, then the Camera component attached to the current GameObject will be used automatically.

◆ keepUpright

bool Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera.keepUpright = false

Adapt initial pose to always be upright.

This only works correctly, if upAxis actually is the up-axis of the content.

◆ upAxis

Vector3 Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera.upAxis = Vector3.up

Defines the up-axis used by the keepUpright option.

In Unity usually the y-axis points up.

◆ usePoseFromTrackingConfig

bool Visometry.VisionLib.SDK.HoloLens.HoloLensInitCamera.usePoseFromTrackingConfig

Overwrite camera transformation with values from tracking configuration.

The InitCamera can then be transformed afterwards, but will get overwritten again after loading a new tracking configuration.