DtVirtualRealitySettingsWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtVirtualRealitySettingsWidget.h
//! \brief Defines the widget for virtual reality settings configuration
//! \ingroup vrvVirtualRealityQt
//!
//! This file contains the DtVirtualRealitySettingsWidget class which implements
//! the user interface controls for configuring virtual reality options. This widget
//! is used by the DtVirtualRealitySettingsPage class to display VR settings in the
//! application settings dialog.
 
#pragma once
 
#include "vrvVirtualRealityQt/vrvVirtualRealityQt.h"
#include "vrvVirtualRealityQt/DtVirtualRealitySettingsInterface.h"
#include "vrvVirtualRealityQt/DtVirtualRealitySettingsWidgetUI.hpp"
 
namespace makVrv
{
//! \brief Widget for displaying and editing virtual reality settings
//!
//! This class implements a widget containing UI controls for viewing and
//! modifying virtual reality settings. It implements the DtVirtualRealitySettingsInterface
//! to provide a consistent interface for updating the UI and receiving user input.
//! The widget includes controls for enabling/disabling VR, configuring mirroring options,
//! selecting observer attachments, and other VR-specific settings.
class DT_DLL_VRVVRQT DtVirtualRealitySettingsWidget : public QWidget,
                                                      public Ui::DtVirtualRealitySettingsWidgetUI,
                                                      public DtVirtualRealitySettingsInterface
{
   Q_OBJECT
 
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //! \param parent Parent widget for this widget
   //!
   //! Initializes a new VR settings widget with references to the display engine
   //! and parent widget. Sets up the UI controls defined in the UI form file.
   DtVirtualRealitySettingsWidget(DtDe& de, QWidget* parent);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources associated with the VR settings widget.
   virtual ~DtVirtualRealitySettingsWidget();
 
   //! \brief Updates the VR enabled state in the UI
   //! \param enabled True to check the enabled checkbox, false to uncheck it
   //!
   //! Sets the state of the virtual reality enabled checkbox in the UI.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setEnabled(bool enabled);
 
   //! \brief Updates the mirroring mode in the UI
   //! \param view The mirroring mode to select in the UI
   //!
   //! Sets the selected option in the mirroring mode dropdown in the UI.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setMirroring(makArchives::DtVirtualRealitySettingsRecord::DtMirroring view);
 
   //! \brief Updates the selected mirror channel in the UI
   //! \param channelName The name of the channel to select in the UI
   //!
   //! Sets the selected option in the mirror channel dropdown in the UI.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setMirrorChannel(const std::string& channelName);
 
   //! \brief Updates the VR hardware availability state in the UI
   //! \param available True if VR hardware is available, false otherwise
   //!
   //! Enables or disables the VR settings controls based on hardware availability.
   //! When hardware is unavailable, the UI will indicate this and disable
   //! controls that require hardware to function.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setVirtualRealityAvailable(bool available);
 
   //! \brief Updates the list of available mirror channels in the UI
   //! \param names Vector of channel names to populate the dropdown with
   //!
   //! Populates the mirror channel dropdown with the provided list of channel names.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setChannelNames(const std::vector<std::string>& names);
 
   //! \brief Updates the list of available observers in the UI
   //! \param names Vector of observer names to populate the dropdown with
   //!
   //! Populates the observer dropdown with the provided list of observer names.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setObserverNames(const std::vector<std::string>& names);
 
   //! \brief Updates the selected attached observer in the UI
   //! \param observerName The name of the observer to select in the UI
   //!
   //! Sets the selected option in the observer dropdown in the UI.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setAttachedObserver(const std::string& observerName);
 
   //! \brief Updates the flip overlays setting in the UI
   //! \param flip True to check the flip overlays checkbox, false to uncheck it
   //!
   //! Sets the state of the flip overlays checkbox in the UI. Flipping overlays
   //! may be necessary to correct their orientation on certain HMD models.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setFlipOverlay(bool flip);
 
   //! \brief Enables or disables the flip overlays control in the UI
   //! \param enabled True to enable the control, false to disable it
   //!
   //! Enables or disables the flip overlays checkbox in the UI. This control
   //! should be disabled when flipping overlays is not supported by the current
   //! HMD model or configuration.
   //! Implements the corresponding method from DtVirtualRealitySettingsInterface.
   virtual void setFlipOverlayEnabled(bool enabled);
 
 
   //! \name UI Control Event Handlers
   //! \brief Slot methods that handle user interaction with UI controls
   //! @{
public slots:
 
   //! \brief Handles changes to the VR enabled checkbox
   //! \param state New state of the checkbox (Qt::Checked or Qt::Unchecked)
   //!
   //! This slot is connected to the enabled checkbox's stateChanged signal
   //! and emits the signal_enabledChanged signal when the user changes the checkbox.
   virtual void onEnabledChanged(int state);
 
   //! \brief Handles changes to the mirroring mode dropdown
   //! \param state Index of the newly selected item
   //!
   //! This slot is connected to the mirroring dropdown's currentIndexChanged signal
   //! and emits the signal_mirroringChanged signal when the user changes the selection.
   virtual void onMirroringChanged(int state);
 
   //! \brief Handles changes to the mirror channel dropdown
   //! \param state Index of the newly selected item
   //!
   //! This slot is connected to the mirror channel dropdown's currentIndexChanged signal
   //! and emits the signal_mirrorChannelChanged signal when the user changes the selection.
   virtual void onMirrorChannelChanged(int state);
 
   //! \brief Handles changes to the attached observer dropdown
   //! \param state Index of the newly selected item
   //!
   //! This slot is connected to the observer dropdown's currentIndexChanged signal
   //! and emits the signal_attachedObserverChanged signal when the user changes the selection.
   virtual void onAttachedObserverChanged(int state);
 
   //! \brief Handles changes to the flip overlays checkbox
   //! \param state New state of the checkbox (Qt::Checked or Qt::Unchecked)
   //!
   //! This slot is connected to the flip overlays checkbox's stateChanged signal
   //! and emits the signal_flipOverlaysChanged signal when the user changes the checkbox.
   virtual void onFlipOverlaysChanged(int state);
   //! @}
 
protected:
   //! \brief Reference to the display engine
   //!
   //! This reference is used to access VR system settings and other
   //! application services needed by the widget.
   DtDe& myDe;
};
} // namespace makVrv