DtVirtualRealitySettingsInterface.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtVirtualRealitySettingsInterface.h
//! \brief Defines the interface for virtual reality settings configuration
//! \ingroup vrvVirtualRealityQt
//!
//! This file contains the DtVirtualRealitySettingsInterface abstract class which defines
//! the interface for configuring virtual reality settings through a GUI. It provides
//! signals for notifying when settings are changed by the user and methods for updating
//! the UI to reflect current settings.
 
#pragma once
 
#include "vrvVirtualRealityQt/vrvVirtualRealityQt.h"
 
#include "vrvVirtualReality/DtVirtualRealitySettingsRecord.h"
 
#include <vrvUtil/signalslib.h>
#include <vrvUtil/DtUnicode.h>
 
#include <string>
#include <vector>
 
namespace makVrv
{
//! \brief Interface for virtual reality settings GUI interaction
//!
//! This abstract class defines the interface for interacting with the virtual reality
//! settings GUI. It provides signals that are emitted when the user changes settings
//! in the UI, and setter methods that allow the application to update the UI to
//! reflect current settings. Implementations of this interface serve as the bridge
//! between the UI and the underlying virtual reality system.
class DT_DLL_VRVVRQT DtVirtualRealitySettingsInterface
{
public:
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources in derived classes.
   virtual ~DtVirtualRealitySettingsInterface();
 
   //! \name Signal Declarations
   //! @{
   //! \brief Signal emitted when the VR enabled state is changed
   //!
   //! This signal is emitted when the user toggles the virtual reality
   //! enabled checkbox in the UI.
   //! \param enabled The new enabled state (true if enabled, false if disabled)
   boost::signalslib::signal<void(bool)> signal_enabledChanged;
 
   //! \brief Signal emitted when the mirroring mode is changed
   //!
   //! This signal is emitted when the user selects a different mirroring
   //! option from the dropdown in the UI.
   //! \param mirroring The new mirroring mode selected
   boost::signalslib::signal<void(makArchives::DtVirtualRealitySettingsRecord::DtMirroring)> signal_mirroringChanged;
 
   //! \brief Signal emitted when the mirror channel is changed
   //!
   //! This signal is emitted when the user selects a different channel
   //! for mirroring the HMD view in the UI.
   //! \param channelName The name of the selected mirror channel
   boost::signalslib::signal<void(std::string)> signal_mirrorChannelChanged;
 
   //! \brief Signal emitted when the attached observer is changed
   //!
   //! This signal is emitted when the user selects a different observer
   //! to attach the HMD view to in the UI.
   //! \param observerName The name of the selected observer
   boost::signalslib::signal<void(std::string)> signal_attachedObserverChanged;
 
   //! \brief Signal emitted when the flip overlays setting is changed
   //!
   //! This signal is emitted when the user toggles the flip overlays
   //! checkbox in the UI. Flipping overlays may be necessary to correct
   //! their orientation on certain HMD models.
   //! \param flip True if overlays should be flipped, false otherwise
   boost::signalslib::signal<void(bool)> signal_flipOverlaysChanged;
   //@}
 
   //! \name UI Update Methods
   //! @{
 
   //! \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.
   //! This should be called when the VR enabled state changes outside the UI.
   virtual void setEnabled(bool enabled) = 0;
 
   //! \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.
   //! This should be called when the mirroring mode changes outside the UI.
   virtual void setMirroring(makArchives::DtVirtualRealitySettingsRecord::DtMirroring view) = 0;
 
   //! \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.
   //! This should be called when the mirror channel changes outside the UI.
   virtual void setMirrorChannel(const std::string& channelName) = 0;
 
   //! \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 should indicate this and disable
   //! controls that require hardware to function.
   virtual void setVirtualRealityAvailable(bool available) = 0;
 
   //! \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.
   //! This should be called when the available channels change.
   virtual void setChannelNames(const std::vector<std::string>& names) = 0;
 
   //! \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.
   //! This should be called when the available observers change.
   virtual void setObserverNames(const std::vector<std::string>& names) = 0;
 
   //! \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.
   //! This should be called when the attached observer changes outside the UI.
   virtual void setAttachedObserver(const std::string& observerName) = 0;
 
   //! \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.
   //! This should be called when the flip overlays setting changes outside the UI.
   virtual void setFlipOverlay(bool flip) = 0;
 
   //! \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.
   virtual void setFlipOverlayEnabled(bool enabled) = 0;
 
   //@}
};
} // namespace makVrv