vreQtQRenderControl.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
//! \file vreQtQRenderControl.h
//! \ingroup vreQtQuickRenderer
//! \brief Extended QQuickRenderControl for integrating with VREngage
//!
//! This class extends the default QQuickRenderControl to provide control over
//! synchronization and rendering timing within the VREngage environment. It enables
//! proper integration between Qt Quick and OSG rendering pipelines.
 
#pragma once
 
#include "vreQtQuickRenderer/export.h"
 
#include <QtQuick/QQuickRenderControl>
 
namespace makVre
{
//! \brief Extended rendering control for Qt Quick in VREngage
//!
//! This class extends QQuickRenderControl to provide control over when
//! Qt Quick scenes are synchronized and rendered. It also manages the
//! association with a window for rendering.
class QTQUICKRENDERER_DLL DtQtQRenderControl : public QQuickRenderControl
{
public:
   //! \brief Constructor
   //! \param p Parent QObject
   //! \param w Associated window for rendering
   DtQtQRenderControl(QObject* p, QWindow* w);
 
   //! \brief Virtual destructor
   virtual ~DtQtQRenderControl() override;
 
   //! \brief Returns the window being rendered to
   //! \param offset Output parameter for window offset
   //! \return Pointer to the window being rendered to
   virtual QWindow* renderWindow(QPoint* offset) Q_DECL_OVERRIDE;
 
   //! \brief Gets the associated window
   //! \return Pointer to the associated window
   QWindow* getWindow();
 
   //! \brief Sets the associated window
   //! \param window Pointer to the window to associate with this control
   void setWindow(QWindow* window);
 
   //! \brief Checks if rendering is needed
   //! \return True if rendering is needed, false otherwise
   bool getNeedsRender();
 
   //! \brief Sets whether rendering is needed
   //! \param needed True if rendering is needed, false otherwise
   void setNeedsRender(bool needed);
 
   //! \brief Checks if polish and sync operations are needed
   //! \return True if polish and sync are needed, false otherwise
   bool getNeedsPolishAndSync();
 
   //! \brief Sets whether polish and sync operations are needed
   //! \param needed True if polish and sync are needed, false otherwise
   void setNeedsPolishAndSync(bool needed);
 
protected:
   //! \brief Pointer to the associated window
   QWindow* myWindow;
 
   //! \brief Flag indicating if rendering is needed
   bool myNeedsRender;
   //! \brief Flag indicating if polish and sync operations are needed
   bool myNeedsPolishAndSync;
};
} // namespace makVre