windowLayoutComponent.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file windowLayoutComponent.h
//! \brief Component that modifies the application window geometry for specific roles
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/playerComponent.h"
 
#include <QRect>
 
#include <string>
 
namespace makVrv
{
class DtDe;
}
 
class QMainWindow;
 
namespace makVre
{
class DtInitTable;
class DtPlayerStation;
 
namespace WindowLayoutComponentConfig
{
//! \ingroup RoleConfigParams
//! \defgroup WindowLayoutComponentRoleParams Window Layout Component Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for window layout component role.
//! @{
 
//! \vreRoleParam{height,int,768,windowLayoutComponent,Height of the application window in pixels when this role is active.}
constexpr const char* height = "height";
 
//! \vreRoleParam{positionX,int,100,windowLayoutComponent,Horizontal position of the application window in pixels from the left edge of the screen.}
constexpr const char* positionX = "positionX";
 
//! \vreRoleParam{positionY,int,300,windowLayoutComponent,Vertical position of the application window in pixels from the top edge of the screen.}
constexpr const char* positionY = "positionY";
 
//! \vreRoleParam{width,int,1024,windowLayoutComponent,Width of the application window in pixels when this role is active.}
constexpr const char* width = "width";
 
//! @}
} // namespace WindowLayoutComponentConfig
 
//! \brief Type identifier for DtWindowLayoutComponent component
constexpr const char* DtWindowLayoutComponentType = "DtWindowLayoutComponent";
 
//! \brief Component that modifies and restores main window geometry for specific roles
//!
//! DtWindowLayoutComponent changes the size and position of the main application window
//! when a player engages in a role that includes this component, and restores the
//! original window geometry when the player leaves the role. This allows different
//! roles to have customized window layouts optimized for their specific needs.
class VRECOMMONCOMPONENTS_DLL DtWindowLayoutComponent : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtWindowLayoutComponent
   //!
   //! Initializes the component with default settings
   DtWindowLayoutComponent();
 
   //! \brief Virtual destructor for DtWindowLayoutComponent
   virtual ~DtWindowLayoutComponent() override;
 
   //! \brief Initializes the window layout component
   //! \param station Pointer to the player station this component belongs to
   //! \param config Configuration table containing window geometry settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Reads window geometry parameters from the configuration, including width, height,
   //! and position coordinates. Caches the current main window geometry to allow
   //! restoration when leaving the role or shutting down the component.
   virtual bool initialize(DtPlayerStation* station, DtInitTable& config) override;
 
   //! \brief Called every frame to update the component state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! On the first tick, applies the configured window geometry settings
   //! to the main application window
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the window layout component
   //!
   //! Restores the original window geometry that was cached during initialization
   //! and removes the state change callback
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtWindowLayoutComponent
   virtual const char* type() const override;
 
protected:
   //! \brief Handler for application state changes
   //! \param state The new application state name
   //!
   //! Applies configured window geometry when entering ENGAGED_STATE and
   //! restores the cached geometry when entering MENU_STATE
   virtual void onCurrentStateChanged(std::string state);
 
protected:
   //! \brief Configured window height in pixels
   int myHeight;
 
   //! \brief Configured window width in pixels
   int myWidth;
 
   //! \brief Configured window X position in screen coordinates
   int myPositionX;
 
   //! \brief Configured window Y position in screen coordinates
   int myPositionY;
 
   //! \brief Original window geometry cached during initialization
   QRect myCachedGeometry;
 
   //! \brief Flag indicating if this is the first tick
   bool myFirstTick;
 
   //! \brief Pointer to the main application window
   QMainWindow* myMainWindow;
};
 
} // namespace makVre