vreQtQuickRendererDrawable.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
#pragma once
 
//! \file vreQtQuickRendererDrawable.h
//! \ingroup vreQtQuickRenderer
//! \brief OSG drawable for rendering QML content into the scene graph
//!
//! This class implements the OSG drawable interface to integrate Qt Quick
//! rendering into the OSG scene graph. It handles the drawing of QML content
//! during the OSG rendering process, providing the bridge between Qt Quick
//! and OSG rendering pipelines.
 
#include "vreQtQuickRenderer/export.h"
 
#include <osg/Drawable>
 
namespace makVre
{
class DtQtQuickRenderer;
 
//! \brief OSG drawable for rendering Qt Quick content
//!
//! This class implements the OSG drawable interface for rendering Qt Quick content.
//! It manages the connection to the Qt Quick renderer and handles the drawing of
//! QML content during the OSG rendering process, either to the screen or to a texture.
class QTQUICKRENDERER_DLL DtQtQuickRendererDrawable : public osg::Drawable
{
public:
   //! \brief Default constructor
   //! \param renderer Pointer to the Qt Quick renderer
   //! \param rttMode True if this drawable is for render-to-texture, false otherwise
   DtQtQuickRendererDrawable(DtQtQuickRenderer* renderer = nullptr, bool rttMode = false);
 
   //! \brief Copy constructor
   //! \param reticle The drawable to copy
   //! \param copyop Copy operation mode
   DtQtQuickRendererDrawable(
      const DtQtQuickRendererDrawable& reticle, const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY);
 
   //! \brief Virtual destructor
   virtual ~DtQtQuickRendererDrawable() override;
 
   //! OSG meta object declaration
   META_Object(test, DtQtQuickRendererDrawable);
 
   //! \brief Implements the OSG drawing operation
   //! \param renderInfo Render information from OSG
   //!
   //! This method is called by OSG during the rendering process to draw
   //! the Qt Quick content into the scene
   virtual void drawImplementation(osg::RenderInfo& renderInfo) const override;
 
   //! \brief Sets the Qt Quick renderer
   //! \param r Pointer to the Qt Quick renderer
   virtual void setRenderer(DtQtQuickRenderer* r);
 
   //! \brief Gets the Qt Quick renderer
   //! \return Pointer to the Qt Quick renderer
   virtual DtQtQuickRenderer* getRenderer();
 
   //! \brief Sets whether this is a render-to-texture drawable
   //! \param isRTT True if this is a render-to-texture drawable, false otherwise
   virtual void setRTTDrawable(bool isRTT);
 
   //! \brief Checks if this is a render-to-texture drawable
   //! \return True if this is a render-to-texture drawable, false otherwise
   virtual bool getRTTDrawable();
 
protected:
   //! \brief Pointer to the Qt Quick renderer
   DtQtQuickRenderer* myRenderer;
   //! \brief Flag indicating if this is a render-to-texture drawable
   bool myRTTDrawable;
};
} // namespace makVre