InputController.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "DllOption.h"
#include <QColor>
#include <QMouseEvent>
#include <QObject>
#include <QPolygonF>
#include <QRect>
 
class QMouseEvent;
class QWheelEvent;
class QKeyEvent;
class QPainter;
class QPixmap;
 
namespace MantidQt {
namespace MantidWidgets {
 
class EXPORT_OPT_MANTIDQT_COMMON InputController : public QObject {
  Q_OBJECT
public:
  explicit InputController(QObject *parent, bool contextAllowed = true);
  ~InputController() override = default;
 
  virtual void mousePressEvent(QMouseEvent * /*unused*/) {}
  virtual void mouseMoveEvent(QMouseEvent *event) {
    emit touchPointAt(event->position().toPoint().x(), event->position().toPoint().y());
  }
  virtual void mouseReleaseEvent(QMouseEvent * /*unused*/) {}
  virtual void wheelEvent(QWheelEvent * /*unused*/) {}
  virtual void keyPressEvent(QKeyEvent * /*unused*/) {}
  virtual void enterEvent(QEvent * /*unused*/) {}
  virtual void leaveEvent(QEvent * /*unused*/) {}
  virtual void onPaint(QPainter & /*unused*/) {}
  virtual void onEnabled() { emit enabled(); }
  virtual void onDisabled() { emit disabled(); }
 
  virtual void freezeRotation(bool) {}
 
  bool canShowContextMenu() const { return m_canShowContextMenu; }
 
signals:
  void enabled();
  void disabled();
  void touchPointAt(int /*_t1*/, int /*_t2*/);
 
private:
  bool m_canShowContextMenu;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputController3DMove : public InputController {
  Q_OBJECT
 
public:
  InputController3DMove(QObject *parent);
  void mousePressEvent(QMouseEvent * /*unused*/) override;
  void mouseMoveEvent(QMouseEvent * /*unused*/) override;
  void mouseReleaseEvent(QMouseEvent * /*unused*/) override;
  void wheelEvent(QWheelEvent * /*unused*/) override;
  void freezeRotation(bool) override;
 
signals:
  void initZoom(int x, int y);
  void initRotation(int x, int y);
  void initTranslation(int x, int y);
  void zoom(int x, int y);
  void wheelZoom(int x, int y, int d);
  void rotate(int x, int y);
  void translate(int x, int y);
  void finish();
 
private:
  bool m_isButtonPressed;
  bool m_isRotationFrozen = false;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputControllerPick : public InputController {
  Q_OBJECT
 
public:
  InputControllerPick(QObject *parent);
  void mousePressEvent(QMouseEvent * /*unused*/) override;
  void mouseMoveEvent(QMouseEvent * /*unused*/) override;
  void mouseReleaseEvent(QMouseEvent * /*unused*/) override;
 
signals:
  void pickPointAt(int /*_t1*/, int /*_t2*/);
  void touchPointAt(int /*_t1*/, int /*_t2*/);
  void setSelection(const QRect & /*_t1*/);
  void finishSelection();
 
private:
  bool m_isButtonPressed;
  QRect m_rect;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputControllerDrawShape : public InputController {
  Q_OBJECT
 
public:
  InputControllerDrawShape(QObject *parent);
  void mousePressEvent(QMouseEvent * /*unused*/) override;
  void mouseMoveEvent(QMouseEvent * /*unused*/) override;
  void mouseReleaseEvent(QMouseEvent * /*unused*/) override;
  void keyPressEvent(QKeyEvent * /*unused*/) override;
  void leaveEvent(QEvent * /*unused*/) override;
 
signals:
  void deselectAll();
  void addShape(const QString &type, int x, int y, const QColor &borderColor, const QColor &fillColor);
  void moveRightBottomTo(int /*_t1*/, int /*_t2*/);
  void selectAt(int /*_t1*/, int /*_t2*/);
  void selectCtrlAt(int /*_t1*/, int /*_t2*/);
  void moveBy(int /*_t1*/, int /*_t2*/);
  void touchPointAt(int /*_t1*/, int /*_t2*/);
  void removeSelectedShapes();
  void restoreOverrideCursor();
  void setSelection(const QRect & /*_t1*/);
  void finishSelection(const QRect & /*_t1*/);
  void copySelectedShapes();
  void pasteCopiedShapes();
 
public slots:
  void startCreatingShape2D(const QString &type, const QColor &borderColor, const QColor &fillColor);
  void onDisabled() override;
 
private:
  bool m_creating; 
  int m_x, m_y;
  QString m_shapeType;
  QColor m_borderColor, m_fillColor;
  bool m_isButtonPressed;
  QRect m_rect;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputControllerMoveUnwrapped : public InputController {
  Q_OBJECT
 
public:
  InputControllerMoveUnwrapped(QObject *parent);
  void mousePressEvent(QMouseEvent * /*unused*/) override;
  void mouseMoveEvent(QMouseEvent * /*unused*/) override;
  void mouseReleaseEvent(QMouseEvent * /*unused*/) override;
 
signals:
  void setSelectionRect(const QRect & /*_t1*/);
  void zoom();
  void resetZoom();
  void unzoom();
 
private:
  bool m_isButtonPressed;
  QRect m_rect;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputControllerDraw : public InputController {
  Q_OBJECT
 
public:
  InputControllerDraw(QObject *parent);
  ~InputControllerDraw() override;
  void mousePressEvent(QMouseEvent * /*unused*/) override;
  void mouseMoveEvent(QMouseEvent * /*unused*/) override;
  void mouseReleaseEvent(QMouseEvent * /*unused*/) override;
  void wheelEvent(QWheelEvent * /*unused*/) override;
 
  void enterEvent(QEvent * /*unused*/) override;
  void leaveEvent(QEvent * /*unused*/) override;
 
protected:
  int cursorSize() const { return m_size; }
  bool isLeftButtonPressed() const { return m_isLeftButtonPressed; }
  bool isRightButtonPressed() const { return m_isRightButtonPressed; }
  bool isActive() const { return m_isActive; }
 
private:
  void redrawCursor();
  virtual void signalLeftClick() = 0;
  virtual void signalRightClick();
  virtual void drawCursor(QPixmap *cursor) = 0;
  virtual void setPosition(const QPoint &pos) = 0;
  virtual void resize() = 0;
 
  const int m_max_size;
  int m_size; 
  bool m_isLeftButtonPressed;
  bool m_isRightButtonPressed;
  bool m_isActive;
  QPixmap *m_cursor;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputControllerSelection : public InputControllerDraw {
  Q_OBJECT
 
public:
  InputControllerSelection(QObject *parent, QPixmap *icon);
  ~InputControllerSelection() override;
  void onPaint(QPainter & /*unused*/) override;
 
signals:
  void selection(const QRect & /*_t1*/);
 
private:
  void drawCursor(QPixmap *cursor) override;
  void setPosition(const QPoint &pos) override;
  void resize() override;
  void signalLeftClick() override;
 
  QPixmap *m_image;
  QRect m_rect;
};
 
class EXPORT_OPT_MANTIDQT_COMMON InputControllerDrawAndErase : public InputControllerDraw {
  Q_OBJECT
 
public:
  InputControllerDrawAndErase(QObject *parent);
 
signals:
  void draw(const QPolygonF & /*_t1*/);
  void erase(const QPolygonF & /*_t1*/);
  void addShape(const QPolygonF &poly, const QColor &borderColor, const QColor &fillColor);
 
public slots:
  void startCreatingShape2D(const QColor &borderColor, const QColor &fillColor);
 
private:
  void drawCursor(QPixmap *cursor) override;
  void signalLeftClick() override;
  void signalRightClick() override;
  void setPosition(const QPoint &pos) override;
  void resize() override;
  void makePolygon();
 
  QPoint m_pos;
  QPolygonF m_rect;
  QColor m_borderColor, m_fillColor;
  bool m_creating;
};
} // namespace MantidWidgets
} // namespace MantidQt