DtVirtualRealitySettingsPage.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtVirtualRealitySettingsPage.h
//! \brief Defines the settings page for virtual reality configuration
//! \ingroup vrvVirtualRealityQt
//!
//! This file contains the DtVirtualRealitySettingsPage class which implements
//! a page in the application settings dialog for configuring virtual reality options.
//! The page integrates with the DtPage framework and provides a UI for adjusting
//! all VR-related settings.
 
#pragma once
 
#include "vrvVirtualRealityQt/vrvVirtualRealityQt.h"
#include "vrvVirtualRealityQt/DtVirtualRealitySettingsInterface.h"
#include "vrvVirtualRealityQt/DtVirtualRealitySettingsWidget.h"
 
#include <vrvCoreQt/DtPage.h>
 
namespace makVrv
{
class DtPersistenceToolbarWidget;
class DtVirtualRealitySettingsLogic;
class DtVirtualRealitySettingsWidget;
 
//! \brief Settings page for configuring Virtual Reality options
//!
//! This class implements a settings page that allows users to configure
//! virtual reality options through a graphical interface. It integrates with
//! the application's settings dialog system by extending DtPage. The page
//! contains controls for enabling/disabling VR, configuring mirroring options,
//! selecting observer attachments, and other VR-specific settings.
//! \ingroup vrvVirtualRealityQt
class DT_DLL_VRVVRQT DtVirtualRealitySettingsPage : public DtPage
{
   Q_OBJECT
 
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //! \param parent Parent widget for this page
   //! \param f Window flags for the page widget
   //!
   //! Initializes a new VR settings page with references to the display engine
   //! and parent widget. Creates the settings widget, logic, and toolbar components
   //! needed for the page to function.
   DtVirtualRealitySettingsPage(DtDe& de, QWidget* parent, Qt::WindowFlags f = Qt::Widget);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources associated with the VR settings page, including
   //! the settings widget, logic, and toolbar components.
   virtual ~DtVirtualRealitySettingsPage();
 
   //! \brief Gets the icon for this page
   //! \return QIcon representing the VR settings page
   //!
   //! Returns the icon that represents this page in the settings dialog.
   //! For VR settings, this is typically a VR headset icon.
   virtual QIcon icon();
 
   //! \brief Gets the title for this page
   //! \return QString containing the page title
   //!
   //! Returns the title that is displayed for this page in the settings dialog.
   //! For VR settings, this is typically "Virtual Reality".
   virtual QString title();
 
   //! \brief Gets the class name of this page
   //! \return Reference to a string containing the class name
   //!
   //! Returns the class name of this page, which is used for identification
   //! and persistence purposes in the settings system.
   virtual const std::string& pageClassName() const;
 
   //! \brief Gets the class name of this page type (static method)
   //! \return Reference to a string containing the class name
   //!
   //! Static method that returns the class name of the VR settings page.
   //! This is used by the page creator and settings system to identify
   //! and instantiate the correct page type.
   static const std::string& thePageClassName();
 
protected:
   //! \brief Sets up the user interface components
   //!
   //! Creates and arranges the UI components including the settings widget
   //! and toolbar. This method is called from the constructor.
   //!
   //! \note This method is intentionally non-virtual since it's called from the constructor.
   void setupGui();
 
   //! \brief Called when the page is displayed
   //!
   //! This method is called when the user navigates to this page in the
   //! settings dialog. It updates the UI to reflect the current VR settings
   //! and prepares the page for user interaction.
   virtual void activate();
 
   //! \brief Called when the page is hidden
   //!
   //! This method is called when the user navigates away from this page
   //! in the settings dialog. It performs any necessary cleanup or state
   //! saving operations.
   virtual void deactivate();
 
protected:
   //! \brief The main settings widget containing VR configuration controls
   DtVirtualRealitySettingsWidget* myWidget;
 
   //! \brief The business logic that connects the UI to the VR system
   DtVirtualRealitySettingsLogic* myLogic;
 
   //! \brief Toolbar widget for persistence controls (save, restore, etc.)
   DtPersistenceToolbarWidget* myToolbar;
 
   //! \brief Container widget for the main layout
   QWidget* myMainWidget;
};
 
//! \brief Creator type for instantiating VR settings pages
//!
//! This typedef defines a creator class that can instantiate VR settings
//! pages. It uses the DtPageCreatorTemplate to implement the standard
//! page creation interface expected by the settings system.
typedef DtPageCreatorTemplate<DtVirtualRealitySettingsPage> DtVirtualRealitySettingsPageCreator;
} // namespace makVrv