VLDebugImageBehaviour Class Reference

The VLDebugImageBehaviour can be used to visualize debug images using the Unity GUI system. More...

Inherits VLWorkerReferenceBehaviour.

Public Types
enum	Tracker { Tracker.Undefined = 0, Tracker.ModelTracker_v1 = 1, Tracker.HololensModelTracker_v1 = 2 }

Public Member Functions
void	ToggleDebugImageVisibility ()
	Turns the debug image on or off Triggered with voice command More...

Data Fields
GameObject	imageObject
	Target object with the RawImage component for displaying the debug image. More...
Tracker	tracker = Tracker.Undefined
	Used tracking method. More...
string	id = "CurrentImageRGBA"
	Used image label / key. More...
Data Fields inherited from VLWorkerReferenceBehaviour
VLWorkerBehaviour	workerBehaviour
	Reference to used VLWorkerBehaviour. More...

Static Public Attributes
static readonly string [][]	keys
	Array with available internal image keys for different trackers. More...
static readonly string [][]	labels
	Array with labels for the available internal image keys. 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

The VLDebugImageBehaviour can be used to visualize debug images using the Unity GUI system.

Please use the VLDebugImage prefab. It will ensure the correct object hierarchy.

Member Enumeration Documentation

Tracker

enum VLDebugImageBehaviour.Tracker

strong

Enumerator
Undefined
ModelTracker_v1
HololensModelTracker_v1

Member Function Documentation

ToggleDebugImageVisibility()

void VLDebugImageBehaviour.ToggleDebugImageVisibility ( )

inline

Turns the debug image on or off Triggered with voice command

Field Documentation

id

string VLDebugImageBehaviour.id = "CurrentImageRGBA"

Used image label / key.

imageObject

GameObject VLDebugImageBehaviour.imageObject

Target object with the RawImage component for displaying the debug image.

keys

readonly string [][] VLDebugImageBehaviour.keys

static

Initial value:

= new string[][]
    {
        
        new string[]
        {
            ""
        },
        
        new string[]
        {
            "LineTrackerDebugImage1",
            "LineTrackerDebugImage0",
            "CurrentImageRGBA"
        },
        
        new string[]
        {
            "LineTrackerDebugImage1",
            "LineTrackerDebugImage0",
            "CurrentImageRGBADisplay"
        }
    }

Array with available internal image keys for different trackers.

labels

readonly string [][] VLDebugImageBehaviour.labels

static

Initial value:

= new string[][]
    {
        
        new string[]
        {
            ""
        },
        
        new string[]
        {
            "LineTracker_Coarse",
            "LineTracker_Fine",
            "CameraImage"
        },
        
        new string[]
        {
            "LineTracker_Coarse",
            "LineTracker_Fine",
            "CameraImage"
        }
    }

Array with labels for the available internal image keys.

tracker

Tracker VLDebugImageBehaviour.tracker = Tracker.Undefined

Used tracking method.

Using Tracker.Undefined allows you to manually enter an internal image key. Please notice, that the image keys might change in future. Therefore you might want to stick to defined tracking methods and the corresponding image labels.