QQuickVTKInteractorAdapter.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 QQuickVTKInteractorAdapter_h
#define QQuickVTKInteractorAdapter_h
 
// VTK includes
#include "QVTKInteractorAdapter.h"
#include "vtkDeprecation.h"
#include "vtkGUISupportQtQuickModule.h" // for export macro
 
// Qt includes
#include <QList>    // for QList
#include <QPointer> // for QPointer
 
// Qt Forward declarations
class QEnterEvent;
class QEvent;
class QFocusEvent;
class QHoverEvent;
class QKeyEvent;
class QMouseEvent;
class QQuickItem;
class QQuickWindow;
class QWheelEvent;
 
VTK_ABI_NAMESPACE_BEGIN
// VTK Forward declarations
class vtkRenderWindowInteractor;
class vtkRenderer;
 
class VTK_DEPRECATED_IN_9_3_0(
  "Use QQuickVTKItem instead") VTKGUISUPPORTQTQUICK_EXPORT QQuickVTKInteractorAdapter
  : public QVTKInteractorAdapter
{
  Q_OBJECT
  typedef QVTKInteractorAdapter Superclass;
 
public:
  QQuickVTKInteractorAdapter(QObject* parent = nullptr);
 
  void setQQuickWindow(QQuickWindow* win);
 
  void QueueHoverEvent(QQuickItem* item, QHoverEvent* e);
  void QueueKeyEvent(QQuickItem* item, QKeyEvent* e);
  void QueueFocusEvent(QQuickItem* item, QFocusEvent* e);
  void QueueMouseEvent(QQuickItem* item, QMouseEvent* e);
  void QueueGeometryChanged(const QRectF& newGeometry, const QRectF& oldGeometry);
  void QueueWheelEvent(QQuickItem* item, QWheelEvent* e);
 
  void ProcessEvents(vtkRenderWindowInteractor* interactor);
 
  /*
   * Map the event position to VTK display coordinates
   * The mapping considers the following:
   *  - VTK widgets expect display coordinates, not viewport/local coordinates
   *  - vtkRenderWindowInteractor flips Y before processing the event.
   * Because of the inherent flip in the superclass, the mapping does not flip Y implicitly.
   * To map and flip Y, use mapEventPositionFlipY.
   *
   * \sa mapEventPositionFlipY
   */
  static QPointF mapEventPosition(QQuickItem* item, const QPointF& localPos);
 
  /*
   * Map the event position to VTK display coordinates and flip the Y axis to switch the point from
   * the Qt coordinate reference system to VTK's.
   *
   * \sa mapEventPosition
   */
  static QPointF mapEventPositionFlipY(QQuickItem* item, const QPointF& localPos);
 
protected:
  void QueueEvent(QEvent* e);
 
private:
  QPointer<QQuickWindow> m_qwindow;
  QList<QEvent*> m_queuedEvents;
 
  Q_DISABLE_COPY(QQuickVTKInteractorAdapter)
};
 
VTK_ABI_NAMESPACE_END
#endif // QQuickVTKInteractorAdapter_h