DtVirtualRealitySettingsLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtVirtualRealitySettingsLogic.h
//! \brief Defines the business logic for the Virtual Reality settings GUI
//! \ingroup vrvVirtualRealityQt
//!
//! This file contains the DtVirtualRealitySettingsLogic class which implements
//! the business logic for the Virtual Reality settings user interface. It acts as
//! a mediator between the UI (DtVirtualRealitySettingsInterface) and the underlying
//! VR system settings, handling data flow and state synchronization in both directions.
 
#pragma once
 
#include "vrvVirtualRealityQt/vrvVirtualRealityQt.h"
 
#include "vrvVirtualReality/DtVirtualRealitySettingsRecord.h"
 
#include <vrvCoreQt/DtFileCacheInterface.h>
#include <vrvUtil/DtSignalConnectionManager.h>
 
namespace makVrv
{
class DtDe;
class DtObserver;
class DtVirtualRealitySettingsInterface;
class DtPersistenceControlsInterface;
class DtSettingsBackup;
 
//! \brief Business logic for the Virtual Reality settings user interface
//!
//! This class implements the business logic for the Virtual Reality settings
//! user interface. It serves as a mediator between the UI components and the
//! underlying VR system settings. The class connects to UI signals to handle
//! user inputs and updates the system settings accordingly. It also listens for
//! changes in the VR system and updates the UI to reflect those changes, ensuring
//! bidirectional synchronization.
class DT_DLL_VRVVRQT DtVirtualRealitySettingsLogic
{
private:
   //! \brief Default constructor (private)
   //!
   //! This constructor is private to prevent creating the logic without the
   //! required dependencies.
   DtVirtualRealitySettingsLogic();
 
   //! \brief Copy constructor (private)
   //! \param other The object to copy from
   //!
   //! This constructor is private to prevent copying the logic object,
   //! as it maintains connections and state that shouldn't be duplicated.
   DtVirtualRealitySettingsLogic(const DtVirtualRealitySettingsLogic& other);
 
   //! \brief Assignment operator (private)
   //! \param other The object to assign from
   //! \return Reference to this object
   //!
   //! This operator is private to prevent assigning the logic object,
   //! as it maintains connections and state that shouldn't be duplicated.
   DtVirtualRealitySettingsLogic& operator=(const DtVirtualRealitySettingsLogic& other);
 
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //! \param gui Reference to the VR settings GUI interface
   //! \param persistenceGui Reference to the persistence controls interface
   //!
   //! Initializes the logic with references to the display engine, settings GUI, and
   //! persistence controls. It establishes connections between the GUI signals and
   //! the corresponding logic slots, as well as connections from the VR settings
   //! to update the GUI when settings change from other sources.
   DtVirtualRealitySettingsLogic(
      DtDe& de, DtVirtualRealitySettingsInterface& gui, DtPersistenceControlsInterface& persistenceGui);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources and disconnects signal connections established
   //! during the lifetime of this object.
   virtual ~DtVirtualRealitySettingsLogic();
 
   //! \brief Updates the GUI to reflect the current VR settings
   //!
   //! Retrieves the current settings from the VR system and updates
   //! all GUI controls to match those settings. This method is called
   //! during initialization and whenever the settings are changed
   //! from outside the GUI.
   virtual void sendSettingsToGui();
 
protected:
   //! \name UI Change Handler Methods
   //! @{
   
   //! \brief Handles changes to the VR enabled state from the UI
   //!
   //! This slot is called when the user toggles the VR enabled checkbox in the UI.
   //! It updates the VR system settings to match the new state selected by the user.
   //!
   //! \param enabled New enabled state (true if enabled, false if disabled)
   virtual void slot_enabledChanged(bool enabled);
 
   //! \brief Handles changes to the mirroring mode from the UI
   //! \param view New mirroring mode selected by the user
   //!
   //! This slot is called when the user selects a different mirroring mode
   //! from the dropdown in the UI. It updates the VR system settings to use
   //! the new mirroring mode.
   virtual void slot_mirroringChanged(makArchives::DtVirtualRealitySettingsRecord::DtMirroring view);
 
   //! \brief Handles changes to the mirror channel from the UI
   //! \param channelName Name of the channel selected by the user
   //!
   //! This slot is called when the user selects a different mirror channel
   //! from the dropdown in the UI. It updates the VR system settings to use
   //! the new mirror channel.
   virtual void slot_mirrorChannelChanged(std::string channelName);
 
   //! \brief Handles changes to the attached observer from the UI
   //! \param observer Name of the observer selected by the user
   //!
   //! This slot is called when the user selects a different observer
   //! from the dropdown in the UI. It updates the VR system settings to
   //! attach the HMD view to the selected observer.
   virtual void slot_attachedObserverChanged(std::string observer);
 
   //! \brief Handles changes to the flip overlays setting from the UI
   //! \param flip New flip overlays state (true if enabled, false if disabled)
   //!
   //! This slot is called when the user toggles the flip overlays checkbox
   //! in the UI. It updates the VR system settings to apply or remove
   //! the vertical flip to overlays as requested.
   virtual void slot_flipOverlaysChanged(bool flip);
   //@ }
 
   //! \name Settings Change Handler Methods
   //! @{
   //! \brief this function is called when the settings manager changes whether or not VR is enabled so the gui can be
   //! updated
   virtual void slot_enabledUpdated(bool enabled);
 
   //! \brief this function is called when the settings manager changes the mirror setting so the gui can be updated
   virtual void slot_mirroringUpdated(makArchives::DtVirtualRealitySettingsRecord::DtMirroring view);
 
   //! \brief this function is called when the settings manager changes the mirror channel so the gui can be updated
   virtual void slot_mirrorChannelUpdated(std::string enabled);
 
   //! \brief this function is called when the settings manager changes the available channels so the gui can be updated
   virtual void slot_channelsUpdated();
 
   //! \brief this function is called when the settings manager changes the available observers so the gui can be
   //! updated
   virtual void slot_observersUpdated();
 
   //! \brief this function is called when an observer is removed and needs to be taken out of GUI list
   virtual void slot_observerRemoved(const DtObserver* obs);
 
   //! \brief this function is called with the settings manager changes the attached observer so the gui can be updated
   virtual void slot_attachedObserverUpdated(std::string observerName);
 
   //! \brief this function is called when the settings manager changes the flip overlays setting so the gui can be
   //! updated
   virtual void slot_flipOverlaysUpdated(bool flip);
   //@ }
 
   //! \name Persistence slots
   //@ {
   //! \brief this function is called when the import settings button is pressed
   void on_import();
 
   //! \brief this function is called when the export settings button is pressed
   void on_export();
 
   //! \brief this function is called when the import file path chosen button is pressed
   void on_importFilePathChosen(const std::string& filePath);
 
   //! \brief this function is called when the export path chosen button is pressed
   void on_exportFilePathChosen(const std::string& filePath);
   //@ }
 
   //! \brief Called when settings are restored.  Resets GUI if the restored
   //! object type is of this class
   virtual void settingsRestored(const DtSettingsBackup*);
 
protected:
   DtDe& myDe;
   DtVirtualRealitySettingsInterface& myInterface;
   DtPersistenceControlsInterface& myPersistenceControls;
   DtSignalConnectionManager myConnections;
};
} // namespace makVrv