QQuickVTKItem.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) John Stone
// SPDX-License-Identifier: BSD-3-Clause
#ifndef QQuickVTKItem_h
#define QQuickVTKItem_h

#include <QtQuick/QQuickItem>

#include <QtCore/QScopedPointer>

#include <functional>

#include "vtkGUISupportQtQuickModule.h" // for export macro
#include "vtkSmartPointer.h"

VTK_ABI_NAMESPACE_BEGIN

class vtkRenderWindow;
class vtkObject;

class QQuickVTKItemPrivate;
class VTKGUISUPPORTQTQUICK_EXPORT QQuickVTKItem : public QQuickItem
{
  Q_OBJECT

public:
  explicit QQuickVTKItem(QQuickItem* parent = nullptr);
  ~QQuickVTKItem() override;

  using vtkUserData = vtkSmartPointer<vtkObject>;

  static void setGraphicsApi();


  virtual vtkUserData initializeVTK(vtkRenderWindow* renderWindow)
  {
    Q_UNUSED(renderWindow)
    return {};
  }


  virtual void destroyingVTK(vtkRenderWindow* renderWindow, vtkUserData userData)
  {
    Q_UNUSED(renderWindow);
    Q_UNUSED(userData);
  }


  void dispatch_async(std::function<void(vtkRenderWindow* renderWindow, vtkUserData userData)> f);

  void scheduleRender();

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)

  Q_INVOKABLE void pinchHandlerRotate(const QPointF& position, double delta);
  Q_INVOKABLE void pinchHandlerScale(const QPointF& position, double delta);
  Q_INVOKABLE void pinchHandlerTranslate(const QPointF& position, const QVector2D& delta);

protected:
  bool event(QEvent*) override;

  QSGNode* updatePaintNode(QSGNode*, UpdatePaintNodeData*) override;
  bool isTextureProvider() const override;
  QSGTextureProvider* textureProvider() const override;
  void releaseResources() override;

private Q_SLOTS:
  void invalidateSceneGraph();

private: // NOLINT(readability-redundant-access-specifiers)
  Q_DISABLE_COPY(QQuickVTKItem)
  Q_DECLARE_PRIVATE_D(_d_ptr, QQuickVTKItem)
  QScopedPointer<QQuickVTKItemPrivate> _d_ptr;
};

VTK_ABI_NAMESPACE_END
#endif // QQuickVTKItem_h