vreWaitingPage.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreWaitingPage.h
//! \brief Defines the waiting page UI component for VR-Engage
//!
//! This file contains the DtVreWaitingPage class which provides a UI page
//! that displays when the user is waiting for a connection or operation to
//! complete. It includes functionality for displaying a waiting indicator
//! and handling back/cancel operations.
#pragma once
 
#include "vrePlayerStation/export.h"
#include "vrePlayerStation/vreHeaderFooterUIBase.h"
 
#include <QUrl>
 
class QQuickItem;
 
namespace makVre
{
//! \brief Forward declaration of the player station application class
class DtPlayerStationApp;
 
//! \brief Waiting page UI component for VR-Engage
//!
//! DtVreWaitingPage provides a UI page that is displayed when the user is
//! waiting for a connection or operation to complete. It typically shows
//! a waiting indicator or animation and provides the ability to cancel the
//! operation and go back to the previous screen. This page follows the standard
//! header/footer UI layout of VR-Engage.
class PLAYERSTATION_DLL DtVreWaitingPage : public DtVreHeaderFooterUIBase
{
   Q_OBJECT;
 
public:
   //! \brief Constructor
   //! \param app Reference to the player station application
   //! \param target_window Name of the window to display in (empty for default)
   //!
   //! Creates a new waiting page UI for the specified application and target window.
   DtVreWaitingPage(DtPlayerStationApp& app, const std::string& target_window = "");
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the waiting page.
   virtual ~DtVreWaitingPage() override;
 
   //! \brief Updates the waiting page each frame
   //! \param dt Time in seconds since the last update
   //!
   //! Called once per frame to update the waiting page UI elements,
   //! such as progress indicators or animations.
   virtual void tick(double dt) override;
 
   //! \brief Initializes the main content of the page
   //!
   //! Sets up the main content area of the page, including any
   //! waiting indicators and cancel buttons. Called during initialization.
   virtual void initMain() override;
 
   //! \brief Controls the background video playback
   //! \param visible True to play the video, false to pause it
   //!
   //! Controls whether any background video is playing or paused.
   virtual void setVideoPlaying(bool visible);
 
   //! \brief Sets the visibility of the waiting page
   //! \param visible True to show the page, false to hide it
   //!
   //! Controls whether the waiting page is visible. This override adds
   //! additional page-specific handling when visibility changes, such as
   //! updating waiting indicators or timers.
   virtual void setVisibility(bool visible) override;
 
   //! \brief Sets the visibility of the menu part of the page
   //! \param visible True to show the menu, false to hide it
   //!
   //! Controls whether the menu portion of the waiting page is visible.
   //! This allows showing/hiding just the menu while keeping the rest
   //! of the page visible.
   virtual void setMenuVisibility(bool visible);
 
public slots:
   //! \brief Handles back button clicks
   //!
   //! Called when the back button is clicked. This typically cancels
   //! the current operation and returns to the previous screen.
   virtual void slot_backClicked() override;
 
   //! \brief Handles connection button clicks
   //!
   //! Called when the connection button is clicked. This typically
   //! initiates or retries a connection operation.
   virtual void slot_connectionClicked() override;
};
 
} // namespace makVre