documentation

VLHoloLensInitCameraBehaviour Class Reference

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

Inherits VLWorkerReferenceBehaviour.

Data Fields

VLHoloLensTrackerBehaviour holoLensTrackerBehaviour
 Reference to used VLHoloLensTrackerBehaviour. More...
 
Camera initCamera
 Reference to the Camera behaviour. More...
 
bool overwriteOnLoad
 Overwrite camera transformation with values from tracking configuration. 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...
 
- Data Fields inherited from VLWorkerReferenceBehaviour
VLWorkerBehaviour workerBehaviour
 Reference to used VLWorkerBehaviour. More...
 

Additional Inherited Members

- Protected Member Functions inherited from VLWorkerReferenceBehaviour
bool InitWorkerReference ()
 Initializes the workerBehaviour and worker member variables. More...
 
- Protected Attributes inherited from VLWorkerReferenceBehaviour
VLWorker worker
 

Detailed Description

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

If there is no VLHoloLensInitCameraBehaviour in the scene or the VLHoloLensInitCameraBehaviour 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 VLHoloLensInitCameraBehaviour in the scene. Otherwise both behaviours will try to set the initial pose, which will lead to unexpected behaviour.

Field Documentation

◆ holoLensTrackerBehaviour

VLHoloLensTrackerBehaviour VLHoloLensInitCameraBehaviour.holoLensTrackerBehaviour

Reference to used VLHoloLensTrackerBehaviour.

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

◆ initCamera

Camera VLHoloLensInitCameraBehaviour.initCamera

Reference to the Camera behaviour.

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

◆ keepUpright

bool VLHoloLensInitCameraBehaviour.keepUpright = false

Adapt initial pose to always be upright.

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

◆ overwriteOnLoad

bool VLHoloLensInitCameraBehaviour.overwriteOnLoad

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.

◆ upAxis

Vector3 VLHoloLensInitCameraBehaviour.upAxis = Vector3.up

Defines the up-axis used by the keepUpright option.

In Unity usually the y-axis points up.