DtGlStudioInstrumentPanelBuilderRtt.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtGlStudioInstrumentPanelBuilderRtt.h
//! \brief Contains makVrv::DtGlStudioInstrumentPanelBuilderRtt class for render-to-texture instrument panels
//! \ingroup vrvGlStudioShared
//!
//! This file defines a specialized instrument panel builder that creates render-to-texture
//! channels for instrument panels. This allows instrument panels to be rendered to a
//! texture and then displayed on other surfaces or in separate viewports, providing
//! better performance and flexibility than traditional instrument panel rendering.
 
 
#pragma once
 
#include "export.h"
 
#include <vrvGlStudioShared/DtGlStudioInstrumentPanelBuilder.h>
 
namespace makVrv
{
//! Forward declaration of the display engine class
class DtDe;
 
//! \brief Specialized instrument panel builder that creates render-to-texture channels
//!
//! This class extends DtGlStudioInstrumentPanelBuilder to create instrument panels
//! that render to textures rather than directly to the screen. This allows instrument
//! panels to be displayed on other surfaces or in separate viewports, improving
//! performance and flexibility. It sets up observers, channels, and rendering
//! configurations to properly display instrument panels for selected objects.
//! \ingroup vrvGlStudioShared
class PLAYERSTATION_DLL DtGlStudioInstrumentPanelBuilderRtt : public DtGlStudioInstrumentPanelBuilder
{
public:
   //! Allow the creator class access to protected members
   friend class DtGlStudioInstrumentPanelBuilderRttCreator;
 
   //! \brief Constructor that initializes the builder with a display engine
   //! \param de Reference to the display engine to use for creating components
   //!
   //! Initializes the base class with the display engine reference.
   DtGlStudioInstrumentPanelBuilderRtt(DtDe& de);
 
   //! \brief Virtual destructor for proper cleanup
   virtual ~DtGlStudioInstrumentPanelBuilderRtt() override;
 
   //! \brief Creates an inset view for the currently selected object
   //!
   //! Creates an observer configuration, sets up a channel with specific viewport
   //! settings, and configures it as a render-to-texture channel. The channel is
   //! created for the currently selected object and attaches an observer to it.
   //! The channel is configured based on the model definition parameters and
   //! is set to render to a texture rather than directly to the screen.
   virtual void createInsetView() override;
 
   //! \brief Gets the name of the created channel
   //! \return String containing the channel name
   //!
   //! Returns the name of the channel created by the createInsetView() method.
   //! The name is composed of the display name of the selected object and the
   //! name of the model definition.
   virtual std::string channelName() const;
 
   //! \brief Gets the name of the created observer (commented out in current version)
   //! \return String containing the observer name
   //!
   //! This method is commented out in the current implementation.
   //       virtual std::string observerName() const;
 
protected:
   //! \brief Name of the channel created by createInsetView()
   //!
   //! This is set by createInsetView() and returned by channelName().
   //! The name is composed of the display name of the selected object and the
   //! name of the model definition.
   std::string myChannelName;
 
   //! \brief Name of the observer created by createInsetView() (commented out)
   //!
   //! This member is commented out in the current implementation.
   //       std::string myObserverName;
};
 
//! \brief Creator class for DtGlStudioInstrumentPanelBuilderRtt instances
//!
//! This creator class is used to create instances of DtGlStudioInstrumentPanelBuilderRtt.
//! It can be registered with the appropriate factory to make render-to-texture
//! instrument panels available in the application.
//! \ingroup vrvGlStudioShared
class PLAYERSTATION_DLL DtGlStudioInstrumentPanelBuilderRttCreator : public DtGlStudioInstrumentPanelBuilderCreator
{
public:
   //! \brief Creates a new DtGlStudioInstrumentPanelBuilderRtt instance
   //! \param de Reference to the display engine to use
   //! \return Pointer to a new DtGlStudioInstrumentPanelBuilderRtt instance
   //!
   //! Creates and returns a new DtGlStudioInstrumentPanelBuilderRtt instance
   //! that uses the specified display engine. The caller takes ownership
   //! of the returned pointer and is responsible for deleting it.
   virtual DtInstrumentPanelBuilder* create(DtDe& de) override;
};
} // namespace makVrv