optimizingVRPerformanceDialog.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file optimizingVRPerformanceDialog.h
//! \brief Defines the VR performance optimization tip dialog
//!
//! This file contains the DtOptimizingVRPerformanceDialog class which provides
//! a dialog with performance optimization tips for VR users. The dialog appears
//! when a user takes control of an entity with a VR display configuration,
//! offering suggestions for graphics settings and other adjustments to achieve
//! optimal frame rates in VR. Users can optionally choose to not see this dialog
//! again during the current application session.
 
#pragma once
 
#include "vrePlayerStation/export.h"
#include "vrePlayerStation/optimizingVRPerformanceDialogUI.hpp"
 
#include <QtWidgets/QDialog>
 
namespace makVrv
{
class DtDe;
}
 
namespace makVre
{
//! \brief Dialog for displaying VR performance optimization tips
//!
//! DtOptimizingVRPerformanceDialog displays a dialog with performance optimization
//! suggestions for users running VR-Engage in VR mode. It provides tips about
//! graphics settings and other configuration adjustments that can help achieve
//! optimal performance in VR, which requires high and consistent frame rates.
//!
//! The dialog includes a checkbox option allowing users to prevent it from
//! appearing again during the current application session.
class PLAYERSTATION_DLL DtOptimizingVRPerformanceDialog : public QDialog, public Ui::DtOptimizingVRPerformanceDialog
{
   Q_OBJECT
 
public:
   //! \brief Constructor
   //! \param parent Parent widget for this dialog
   //! \param flags Window flags controlling the dialog's appearance and behavior
   //!
   //! Creates a new VR performance optimization dialog with the specified parent
   //! and window flags. The dialog is initialized with performance tips and a
   //! checkbox to prevent showing it again.
   DtOptimizingVRPerformanceDialog(QWidget* parent = nullptr, const Qt::WindowFlags& flags = 0);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of dialog resources.
   virtual ~DtOptimizingVRPerformanceDialog() override;
 
   //! \brief Checks if the dialog should not be shown again
   //! \return True if the "Don't show again" checkbox is checked, false otherwise
   //!
   //! Returns the state of the "Don't show this dialog again" checkbox,
   //! allowing the calling code to respect the user's preference about
   //! seeing this dialog in the future.
   virtual bool neverShowAgain();
};
} // namespace makVre