playerStationTempNotification.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file playerStationTempNotification.h
//! \brief Defines a UI component for temporary notifications in VR-Engage
//!
//! This file contains the DtPlayerStationTempNotification class which provides
//! a system for displaying temporary notifications to the user. These notifications
//! appear for a specified duration before automatically disappearing, making them
//! suitable for transient information or alerts.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <QObject>
 
//! \brief Forward declaration of QQuickItem
class QQuickItem;
 
namespace makVre
{
//! \brief Forward declaration of the player station application class
class DtPlayerStationApp;
 
//! \brief Temporary notification UI component for VR-Engage
//!
//! DtPlayerStationTempNotification provides a UI component for displaying
//! temporary notifications to the user. These notifications appear on screen
//! for a specified duration before automatically disappearing. This is useful
//! for providing feedback about events or state changes that don't require
//! persistent notification.
class PLAYERSTATION_DLL DtPlayerStationTempNotification : public QObject
{
   Q_OBJECT;
 
public:
   //! \brief Constructor
   //! \param app Reference to the player station application
   //! \param target_window Name of the target window to display in (empty for default)
   //!
   //! Creates a new temporary notification component associated with the
   //! specified player station application and target window.
   DtPlayerStationTempNotification(DtPlayerStationApp& app, const std::string& target_window = "");
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of notification resources.
   virtual ~DtPlayerStationTempNotification() override;
 
   //! \brief Displays a new temporary notification
   //! \param text Content of the notification to display
   //! \param lifetime Duration in seconds that the notification should remain visible
   //!
   //! Creates and displays a temporary notification with the specified text
   //! that will automatically disappear after the specified lifetime (default 3 seconds).
   //! If a notification is already visible, it will be replaced by this new one.
   virtual void newNotification(const QString& text, double lifetime = 3.0);
 
   //! \brief Initializes the notification system
   //!
   //! Ensures that the notification system is properly initialized before use.
   //! This sets up the QML components and prepares the system for displaying
   //! notifications. Called automatically when needed but can be called explicitly
   //! to prepare the system in advance.
   virtual void init();
 
protected:
   //! \brief Sets the text content of the notification
   //! \param str Text string to display in the notification
   //!
   //! Updates the text content of the notification. This is typically
   //! called internally by newNotification().
   virtual void setText(const QString& str);
 
   //! \brief Sets the lifetime of the notification
   //! \param time Duration in seconds that the notification should remain visible
   //!
   //! Sets how long the notification will remain visible before automatically
   //! disappearing. This is typically called internally by newNotification().
   virtual void setLifetime(double time);
 
   //! \brief Closes the notification
   //!
   //! Hides the notification UI element, typically called when the
   //! notification lifetime expires or when a new notification replaces it.
   virtual void close();
 
   //! \brief Opens the notification
   //!
   //! Shows the notification UI element with the current text content.
   //! This is typically called after setting the text and lifetime.
   virtual void open();
 
protected:
   //! \brief Current text content of the notification
   QString myText;
 
   //! \brief Current lifetime of the notification in seconds
   double myLifetime;
 
   //! \brief Reference to the player station application
   DtPlayerStationApp& myApp;
 
   //! \brief Target window name for displaying the notification
   std::string myTargetWindow;
 
   //! \brief Pointer to the root QML item for the notification UI
   QQuickItem* myRoot;
};
} // namespace makVre