Class HUDPanel

Heads up display panel used to publish a key value pair on the screen. Items added to this need to have their values updated every frame, or else, they will be determined to be stale and removed from the view and re-used for a new entry.

Inheritance

Object

HUDPanel

Namespace: UnityEngine.Perception.GroundTruth

Syntax

public class HUDPanel : MonoBehaviour

Properties

entryCount

The number of labelers currently displaying real-time information on the visualization HUD

Declaration

public int entryCount { get; }

Property Value

Type	Description
Int32

Methods

RemoveEntries(CameraLabeler)

Removes all of the passed in entries from the HUD

Declaration

public void RemoveEntries(CameraLabeler labeler)

Parameters

Type	Name	Description
CameraLabeler	labeler	The labeler that requested the removal

RemoveEntry(CameraLabeler, String)

Removes the key value pair from the HUD

Declaration

public void RemoveEntry(CameraLabeler labeler, string key)

Parameters

Type	Name	Description
CameraLabeler	labeler	The labeler that requested the removal
String	key	The key of the entry to remove

UpdateEntry(CameraLabeler, String, String)

Updates (or creates) an entry with the passed in key value pair

Declaration

public void UpdateEntry(CameraLabeler labeler, string key, string value)

Parameters

Type	Name	Description
CameraLabeler	labeler	The labeler that requested the HUD entry
String	key	The key of the HUD entry
String	value	The value of the entry