QQuickVTKRenderItem.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef QQuickVTKRenderItem_h
#define QQuickVTKRenderItem_h
 
// Qt includes
#include <QOpenGLFunctions> // For QOpenGLFunctions
#include <QQuickItem>
 
// vtk includes
#include "QQuickVTKRenderWindow.h" // For QQuickVTKRenderWindow
#include "vtkDeprecation.h"
#include "vtkNew.h"      // For vtkNew
#include "vtkRenderer.h" // For vtkRenderer
 
#include "vtkGUISupportQtQuickModule.h" // for export macro
 
// Qt Forward declarations
class QHoverEvent;
class QKeyEvent;
class QMouseEvent;
 
VTK_ABI_NAMESPACE_BEGIN
// VTK Forward declarations
class QQuickVTKInteractiveWidget;
class vtkImageData;
 
class VTK_DEPRECATED_IN_9_3_0(
  "Use QQuickVTKItem instead") VTKGUISUPPORTQTQUICK_EXPORT QQuickVTKRenderItem
  : public QQuickItem
  , protected QOpenGLFunctions
{
  Q_OBJECT
  typedef QQuickItem Superclass;
 
  Q_PROPERTY(QQuickVTKRenderWindow* renderWindow READ renderWindow WRITE setRenderWindow)
 
public:
  QQuickVTKRenderItem(QQuickItem* parent = nullptr);
  ~QQuickVTKRenderItem() override = default;
 
 
  QQuickVTKRenderWindow* renderWindow() const;
  virtual void setRenderWindow(QQuickVTKRenderWindow* w);
 
  vtkRenderer* renderer() const;
 
  virtual vtkSmartPointer<vtkImageData> captureScreenshot();
 
 
  virtual void addWidget(QQuickVTKInteractiveWidget* w);
  virtual void removeWidget(QQuickVTKInteractiveWidget* w);
 
 
  virtual QQuickVTKInteractiveWidget* widgetByName(QString name) const;
  virtual void removeWidgetByName(QString name);
 
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  virtual void sync();
 
  virtual void init();
 
  virtual void paint();
 
  virtual void cleanup();
 
protected Q_SLOTS:
  virtual void handleWindowChanged(QQuickWindow* w);
 
protected: // NOLINT(readability-redundant-access-specifiers)
  // Helper members
  QQuickVTKRenderWindow* m_renderWindow = nullptr;
  vtkNew<vtkRenderer> m_renderer;
 
  QVector<QQuickVTKInteractiveWidget*> m_widgets;
 
  virtual void setViewport(const QRectF& rect);
 
  // Event handlers
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
  void geometryChanged(const QRectF& newGeometry, const QRectF& oldGeometry) override;
#else
  void geometryChange(const QRectF& newGeometry, const QRectF& oldGeometry) override;
#endif
  bool event(QEvent* ev) override;
 
private:
  QQuickVTKRenderItem(const QQuickVTKRenderItem&) = delete;
  void operator=(const QQuickVTKRenderItem) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // QQuickVTKRenderItem_h