documentation

Visometry.DesignSystem.NotificationDisplay Class Reference

The NotificationDisplay manages a list of Notifications that should be displayed depending on their kind after they have been added through the static NotificationManager. More...

Inherits Visometry.DesignSystem.UIDisplay.

Public Member Functions

void AddNotification (NotificationObject newNotification)
 Add a notification to the queue of notifications to be displayed. More...
 
void ResetNotifications ()
 Destroys all active notifications and clears the queue.
 

Additional Inherited Members

- Properties inherited from Visometry.DesignSystem.UIDisplay
Canvas DisplayCanvas [get]
 

Detailed Description

The NotificationDisplay manages a list of Notifications that should be displayed depending on their kind after they have been added through the static NotificationManager.

Add this component to a canvas or as its child to visualize notifications from the vlUnitySDK.

Member Function Documentation

◆ AddNotification()

void Visometry.DesignSystem.NotificationDisplay.AddNotification ( NotificationObject  newNotification)
inline

Add a notification to the queue of notifications to be displayed.

Notifications of kind "Info" will be displayed immediately (destroying other active "Info" notifications) and disappear automatically, while those of kind "Error" or "Warning" will be displayed one after another and only disappear through user interaction. Notifications with priority 1 will be prioritized compared to notifications with the default priority 0.