DtVirtualRealityMenuItem.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtVirtualRealityMenuItem.h
//! \brief Defines the VR menu item class for enabling/disabling virtual reality functionality
//! \ingroup vrvVirtualRealityQt
//!
//! This file contains the DtVirtualRealityMenuItem class which provides a menu item
//! that users can interact with to enable or disable the virtual reality mode within
//! the application. It extends DtCheckedItem to provide toggle functionality.
 
#pragma once
 
#include <vrvVirtualRealityQt/vrvVirtualRealityQt.h>
#include <vrvCoreQt/DtCheckedItem.h>
 
namespace makVrv
{
//! \brief Menu item for enabling and disabling virtual reality mode
//!
//! This class implements a checkable menu item that allows users to toggle
//! the virtual reality mode on and off. When checked, the application enters
//! VR mode and begins rendering to the VR headset. When unchecked, the application
//! returns to standard display mode.
//! \ingroup vrvVirtualRealityQt
class DT_DLL_VRVVRQT DtVirtualRealityMenuItem : public DtCheckedItem
{
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Initializes a new VR menu item associated with the specified display engine.
   //! The menu item state will reflect the current VR enabled state of the display engine.
   DtVirtualRealityMenuItem(DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources associated with the VR menu item.
   virtual ~DtVirtualRealityMenuItem();
 
   //! \brief Creates a QAction for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget for the QAction
   //! \return Newly created QAction instance
   //!
   //! Creates and configures a QAction that represents this menu item in the UI.
   //! The action is connected to the display engine's signals to keep its state
   //! synchronized with the VR enabled state.
   //!
   //! Overrides the base class implementation to add VR-specific connections.
   QAction* createAction(DtDe& de, QWidget* parent);
 
protected:
   //! \brief Sets the enabled state of the VR system
   //! \param value True to enable VR mode, false to disable it
   //!
   //! This method is called when the menu item is triggered by the user.
   //! It enables or disables the VR system in the display engine based on the value.
   //!
   //! Overrides the base class implementation to handle VR-specific state changes.
   virtual void setValue(bool value);
 
   //! \brief Gets the current VR enabled state
   //! \return True if VR mode is enabled, false otherwise
   //!
   //! Returns the current enabled state of the VR system from the display engine.
   //!
   //! Overrides the base class implementation to retrieve the VR-specific state.
   virtual bool getValue() const;
};
} // namespace makVrv