playerStationPersistentNotification.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file playerStationPersistentNotification.h
//! \brief Defines a UI component for persistent notifications in VR-Engage
//!
//! This file contains the DtPlayerStationPersistentNotification class which
//! provides a persistent notification system that can display state information
//! to the user, such as the current play/pause state during engagement.
 
#pragma once
 
#include "vrePlayerStation/export.h"
#include "vrePlayerStation/vreHeaderFooterUIBase.h"
 
#include <QObject>
 
//! \brief Forward declaration of QQuickItem
class QQuickItem;
 
namespace makVre
{
//! \brief Forward declaration of the player station application class
class DtPlayerStationApp;
 
//! \brief Persistent notification UI component for VR-Engage
//!
//! DtPlayerStationPersistentNotification provides a UI component for displaying
//! persistent notifications to the user during gameplay. It typically shows
//! important state information, such as whether the simulation is running or paused,
//! and can be positioned in the header or footer area of the application window.
class PLAYERSTATION_DLL DtPlayerStationPersistentNotification : public DtVreHeaderFooterUIBase
{
   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 persistent notification component associated with the
   //! specified player station application and target window.
   DtPlayerStationPersistentNotification(DtPlayerStationApp& app, const std::string& target_window = "");
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of notification resources.
   virtual ~DtPlayerStationPersistentNotification() override;
 
   //! \brief Initializes the main notification UI
   //!
   //! Sets up the QML components and connects signals and slots for
   //! the notification system. This should be called after construction
   //! but before the notification is used.
   virtual void initMain() override;
 
   //! \brief Updates the notification each frame
   //! \param dt Time in seconds since the last update
   //!
   //! Handles per-frame updates for the notification, such as
   //! checking for state changes that should be displayed.
   virtual void tick(double dt) override;
 
   //! \brief Sets the visibility of the notification
   //! \param visible True to show the notification, false to hide it
   //!
   //! Controls whether the notification is visible to the user.
   //! This overrides the base class implementation to provide
   //! notification-specific visibility behavior.
   virtual void setVisibility(bool visible) override;
 
   //! \brief Checks if the notification is visible
   //! \return True if the notification is visible, false otherwise
   //!
   //! Currently commented out implementation of isVisible() override.
   // virtual bool isVisible() override;
 
public slots:
   //! \brief Handles updates to the simulation running state
   //! \param runState True if the simulation is running, false if paused
   //!
   //! Slot called from QML when the running state changes, allowing
   //! the notification to update its display accordingly.
   virtual void runningStateUpdated(bool runState) override;
 
protected:
   //! \brief Sets the running state for the notification
   //! \param running True if the simulation is running, false if paused
   //!
   //! Updates the internal running state and triggers UI updates
   //! to reflect the new state in the notification display.
   virtual void setRunning(bool running);
 
protected:
   //! \brief Flag indicating whether the simulation is currently playing
   //!
   //! Tracks whether the simulation is in a running (true) or paused (false) state.
   //! This affects how the notification is displayed to the user.
   bool myIsPlaying;
};
} // namespace makVre