spectatorOverlay.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file spectatorOverlay.h
//! \brief Defines the Qt Quick overlay component for the spectator role
//! \ingroup vreSpectatorFrontend
 
#pragma once
 
#include <vreSpectatorFrontend/export.h>
 
#include "vrePlayerStation/playerComponent.h"
#include "vreCommonComponents/qtQuickOverlay.h"
 
namespace makVre
{
//! \brief Forward declaration of the player station persistent notification class
class DtPlayerStationPersistentNotification;
 
//! \brief Type identifier for DtOverlayComponent component
constexpr const char* DtSpectatorOverlayType = "DtSpectatorOverlay";
 
//! \brief Qt Quick overlay component for the spectator role
//!
//! This component provides a Qt Quick-based user interface overlay for the
//! spectator role. It displays information, controls, and notifications specific
//! to spectators, allowing them to interact with the simulation through a
//! graphical interface. The overlay manages persistent notifications and
//! provides spectator-specific UI elements.
class SPECTATOR_DLL DtSpectatorOverlay : public DtQtQuickOverlay
{
public:
   //! \brief Constructor
   //! \param className Name of the class (used for logging and identification)
   //!
   //! Creates a new spectator overlay with the specified class name
   DtSpectatorOverlay();
 
   //! \brief Virtual destructor
   virtual ~DtSpectatorOverlay() override;
 
   //! \brief Initializes the overlay component
   //! \param player Pointer to the player station
   //! \param config Reference to the initialization configuration
   //! \return True if initialization was successful, false otherwise
   //!
   //! Sets up the overlay and loads the Qt Quick UI
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates overlay state each frame
   //! \param dt Delta time since the last update in seconds
   //!
   //! Updates overlay elements based on current simulation state
   virtual void tick(double dt) override;
 
   //! \brief Performs cleanup when the component is shut down
   //!
   //! Releases overlay resources and cleans up UI elements
   virtual void shutdown() override;
 
   //! \brief Initializes the Qt Quick document with the root item
   //! \param root Pointer to the root QQuickItem
   //!
   //! Connects Qt Quick signals and slots and initializes UI elements
   virtual void initdoc(QQuickItem* root) override;
 
   //! \brief Checks if the persistent notification is visible
   //! \return True if the notification is visible, false otherwise
   //!
   //! Determines whether the persistent notification is currently displayed
   virtual bool isPersistentNotificationVisible();
 
   //! \brief Checks if the current player is a spectator
   //! \return True if the player is a spectator, false otherwise
   //!
   //! Determines whether the current player is in spectator mode
   virtual bool isSpectator();
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Shared pointer to the persistent notification
   //!
   //! Manages the persistent notification displayed to the spectator
   std::shared_ptr<DtPlayerStationPersistentNotification> myPersistentNotification;
 
   //! \brief Flag indicating if the player is in spectator mode
   bool mySpectator;
};
} // namespace makVre