vreManagerWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreManagerWidget.h
//! \ingroup vreManager
//! \brief VREngage Manager widget for configuring and managing VREngage applications
//!
//! This file defines the DtVreManagerWidget class, which provides the main user
//! interface for managing VREngage applications, including role assignments,
//! entity control, and status monitoring.
 
#pragma once
 
#include "vreManager/export.h"
 
#include <vrvUtil/signalslib.h>
 
#include "vreManager/vreManagerWidget.hpp"
 
#include <vrvCoreQt/DtPage.h>
#include <QtWidgets/QWidget>
 
class DtVreTableModel;
class QModelIndex;
class DtVreStatusListener;
 
 
namespace makVre
{
class DtVreEntitySelectionDialog;
class DtRoleItemDelegate;
 
//! \brief Main widget for the VREngage Manager interface
//!
//! This class provides the main user interface for managing VREngage applications,
//! including monitoring application status, assigning roles and entities to
//! applications, and controlling spectator mode settings. It integrates with
//! the VREngage status listener to maintain real-time status information.
class VREMANAGER_DLL DtVreManagerWidget : public makVrv::DtPage
{
   Q_OBJECT
 
public:
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the manager widget, including the table model,
   //! entity selection dialog, and VREngage listener.
   virtual ~DtVreManagerWidget() override;
 
   //! \brief Gets the icon for this page
   //! \return Icon to display for this page in the application
   //!
   //! Returns the icon representing the VREngage Manager in the application UI.
   virtual QIcon icon() override;
 
   //! \brief Gets the title for this page
   //! \return Title to display for this page in the application
   //!
   //! Returns the human-readable title for the VREngage Manager page.
   virtual QString title() override;
 
   //! \brief Gets the class name of the page
   //! \return Reference to the unique class name string
   //!
   //! Returns the unique identifier for this page class type. This name is used
   //! for page identification and persistence purposes.
   virtual const std::string& pageClassName() const override;
 
   //! \brief Called when the page is displayed
   //!
   //! Activates the manager widget, setting up the necessary connections, initializing
   //! the table model, and refreshing the display. This is called whenever the
   //! page becomes visible to the user.
   virtual void activate() override;
 
   //! \brief Called when the page is hidden
   //!
   //! Deactivates the manager widget, cleaning up resources and disconnecting
   //! signals. This is called whenever the page becomes invisible to the user.
   virtual void deactivate() override;
 
   //! \brief Gets the icon configurations for the page
   //! \return The icon configuration settings
   //!
   //! Returns the configuration settings used to style the page's icon
   //! based on application settings and theme.
   virtual makVrv::DtQIconConfigurations qIconConfigurations() const override;
 
   //! \brief Static callback for VREngage application discovery
   //! \param id The unique identifier of the discovered application
   //! \param usr User-defined data (pointer to the manager widget instance)
   //!
   //! Static callback function invoked when a new VREngage application is discovered.
   //! Routes the callback to the appropriate instance method.
   static void vreAppAddedCallback(unsigned long id, void* usr);
 
   //! \brief Static callback for VREngage application removal
   //! \param id The unique identifier of the removed application
   //! \param usr User-defined data (pointer to the manager widget instance)
   //!
   //! Static callback function invoked when a VREngage application is removed.
   //! Routes the callback to the appropriate instance method.
   static void vreAppRemovedCallback(unsigned long id, void* usr);
 
   //! \brief Static callback for VREngage application status changes
   //! \param id The unique identifier of the changed application
   //! \param usr User-defined data (pointer to the manager widget instance)
   //!
   //! Static callback function invoked when a VREngage application's status changes.
   //! Routes the callback to the appropriate instance method.
   static void vreAppChangedCallback(unsigned long id, void* usr);
 
public slots:
   //! \brief Handles table item click events
   //! \param index The model index of the clicked item
   //!
   //! Called when the user clicks on an item in the VREngage manager table.
   //! Updates the selection state and UI accordingly.
   virtual void onTableItemClicked(const QModelIndex& index);
 
   //! \brief Handles submission of changes
   //!
   //! Called when the user submits changes to VREngage application settings.
   //! Applies the changes to the affected applications.
   virtual void onSubmit();
 
   //! \brief Handles reverting of changes
   //!
   //! Called when the user cancels changes to VREngage application settings.
   //! Reverts any pending changes and refreshes the display.
   virtual void onRevert();
 
   //! \brief Handles completion of user edits
   //!
   //! Called when the user completes an edit operation in the manager.
   //! Updates internal state and enables/disables UI elements accordingly.
   virtual void onUserEditComplete();
 
   //! \brief Handles VREngage application addition
   //! \param id The unique identifier of the added application
   //!
   //! Called when a new VREngage application is discovered. Updates the
   //! table model and refreshes the display to show the new application.
   virtual void handleVreAppAdded(unsigned long id);
 
   //! \brief Handles VREngage application removal
   //! \param id The unique identifier of the removed application
   //!
   //! Called when a VREngage application is removed or times out. Updates the
   //! table model and refreshes the display to remove the application.
   virtual void handleVreAppRemoved(unsigned long id);
 
   //! \brief Handles VREngage application status changes
   //! \param id The unique identifier of the changed application
   //!
   //! Called when a VREngage application's status changes. Updates the
   //! table model and refreshes the display to show the updated status.
   virtual void handleVreAppChanged(unsigned long id);
 
protected:
   //! \brief Handles entity selection
   //!
   //! Called when the user selects an entity for assignment to a VREngage
   //! application. Shows the entity selection dialog.
   virtual void onEntitySelected();
 
   //! \brief Handles completion of entity selection dialog
   //!
   //! Called when the entity selection dialog is closed. Processes the
   //! selected entity and updates the application settings accordingly.
   virtual void onEntitySelectionDialogDone();
 
   //! \brief Handles model set changes
   //!
   //! Populates the model sets that could possibly contain VREngage-controllable entities.
   //! This includes any SMS (Simulation Model Set) that derives from VR-Engage.sms
   //! somewhere in its ancestry. Called when the available model sets change.
   virtual void onModelSetChanged();
 
protected:
   //! Allows the creator class to create page instances
   friend class DtVreManagerWidgetCreator;
 
   //! \brief Internal activation handler
   //!
   //! Implementation of the activation logic. Called by activate().
   virtual void handleActivate();
 
   //! \brief Internal deactivation handler
   //!
   //! Implementation of the deactivation logic. Called by deactivate().
   virtual void handleDeactivate();
 
   //! \brief Constructor
   //! \param de The distributed environment reference
   //! \param parent The parent widget
   //! \param f Window flags to apply to the widget
   //!
   //! Initializes a new VREngage manager widget. This constructor is private
   //! and can only be called by the DtVreManagerWidgetCreator.
   DtVreManagerWidget(makVrv::DtDe& de, QWidget* parent = 0, Qt::WindowFlags f = 0);
 
   //! \brief Sets up the UI components
   //! \param p The parent widget to set up UI on
   //!
   //! Initializes and configures the user interface components of the manager widget.
   //! Creates the table, buttons, and other controls, and connects signals and slots.
   void setupUi(QWidget* p);
 
protected:
   //! \brief Class name for this page type
   //!
   //! Unique string identifier for this page class.
   std::string myClassName;
 
   //! \brief UI components generated from designer file
   Ui::DtVreManagerWidget myUI;
 
   //! \brief Table model for VREngage applications
   //!
   //! Maintains the data model for the applications table.
   DtVreTableModel* myModel;
 
   //! \brief Entity selection dialog
   //!
   //! Dialog for selecting entities to assign to VREngage applications.
   DtVreEntitySelectionDialog* mySelectEntityDialog;
 
   //! \brief VREngage status listener
   //!
   //! Tracks status information for VREngage applications.
   DtVreStatusListener* myVreListener;
 
   //! \brief Signal connection manager
   //!
   //! Manages Qt signal/slot connections for cleanup.
   makVrv::DtSignalConnectionManager myConnectionManager;
 
   //! \brief Flag indicating if the widget is in editing state
   //!
   //! True when the user is editing application settings, false otherwise.
   bool myInEditingState;
 
   //! \brief Currently loaded SMS filename
   //!
   //! The filename of the currently loaded Simulation Model Set.
   DtFilename myLoadedSMSFileName;
};
 
 
//! \brief Factory class for creating VREngage manager widgets
//!
//! This creator class is responsible for instantiating DtVreManagerWidget
//! objects for the application. It implements the DtPageCreator interface
//! to allow the manager to be added to the application's page system.
class VREMANAGER_DLL DtVreManagerWidgetCreator : public makVrv::DtPageCreator
{
public:
   //! \brief Constructor
   //! \param de The distributed environment reference
   //!
   //! Initializes a new creator for VREngage manager widgets.
   DtVreManagerWidgetCreator(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Allows for proper cleanup of derived classes.
   virtual ~DtVreManagerWidgetCreator() override;
 
   //! \brief Gets the page class name
   //! \return The unique class name string
   //!
   //! Returns the unique identifier for the page class this creator instantiates.
   //! This name should be unique across all pages. This is not the human-readable
   //! title of the page. When replacing a page, this class name should remain the same.
   virtual std::string pageClassName() const override;
 
   //! \brief Creates a new page instance
   //! \param parent The parent widget
   //! \param f Window flags to apply to the widget
   //! \return Pointer to the newly created page
   //!
   //! Creates a new instance of the DtVreManagerWidget class.
   virtual makVrv::DtPage* create(QWidget* parent = 0, Qt::WindowFlags f = 0) override;
};
} // namespace makVre