pqAnimationModel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef pqAnimationModel_h
#define pqAnimationModel_h
 
#include "pqWidgetsModule.h"
 
#include "vtkParaViewDeprecation.h"
 
#include <QGraphicsScene>
#include <QObject>
#include <QPolygonF>
#include <QStandardItemModel>
 
class pqAnimationTrack;
class pqAnimationKeyFrame;
class QGraphicsView;
class pqCheckBoxPixMaps;
 
// a model that represents a collection of animation tracks
class PARAVIEW_DEPRECATED_IN_5_12_0(
  "See `pqTimeManagerWidget` for new design") PQWIDGETS_EXPORT pqAnimationModel
  : public QGraphicsScene
{
  Q_OBJECT
  Q_ENUMS(ModeType)
  Q_PROPERTY(ModeType mode READ mode WRITE setMode)
  Q_PROPERTY(int ticks READ ticks WRITE setTicks)
  Q_PROPERTY(double currentTime READ currentTime WRITE setCurrentTime)
  Q_PROPERTY(double startTime READ startTime WRITE setStartTime)
  Q_PROPERTY(double endTime READ endTime WRITE setEndTime)
  Q_PROPERTY(bool interactive READ interactive WRITE setInteractive)
public:
  enum ModeType
  {
    Real,
    Sequence,
    Custom
  };
 
  pqAnimationModel(QGraphicsView* p = nullptr);
  ~pqAnimationModel() override;
 
  int count();
  pqAnimationTrack* track(int);
 
  pqAnimationTrack* addTrack(pqAnimationTrack* trackToAdd = nullptr);
  void removeTrack(pqAnimationTrack* track);
 
  ModeType mode() const;
  int ticks() const;
  double currentTime() const;
  double startTime() const;
  double endTime() const;
  double zoomStartTime() const;
  double zoomEndTime() const;
  double zoomFactor() const;
 
  bool interactive() const;
 
  QAbstractItemModel* header();
  QAbstractItemModel* enabledHeader();
 
  void setRowHeight(int);
  int rowHeight() const;
 
  void positionZoom(double zoomStartTime);
 
  const QList<double>& customTicks() const { return this->CustomTicks; }
 
  void setEnabledHeaderToolTip(const QString& val);
  const QString& enabledHeaderToolTip() const { return this->EnabledHeaderToolTip; }
 
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
 
  void setMode(ModeType);
  void setTicks(int);
  void setCurrentTime(double);
  void setStartTime(double);
  void setEndTime(double);
  void setInteractive(bool);
  void setTickMarks(int num, double* tick_marks);
  void setTimePrecision(int precision);
 
  void setTimeNotation(const QChar& notation);
 
  void zoomTrack(pqAnimationTrack* track);
 
Q_SIGNALS:
  // emitted when a track is double clicked on
  void trackSelected(pqAnimationTrack*);
  // emitted when the current time was changed by this model
  void currentTimeSet(double);
  // emitted when the time of a keyframe was changed by this model
  void keyFrameTimeChanged(pqAnimationTrack* track, pqAnimationKeyFrame* kf, int end, double time);
  // emitted when the zoom factor or position are changed
  void zoomChanged();
 
protected Q_SLOTS:
 
  void resizeTracks();
  void trackNameChanged();
  void enabledChanged();
 
protected: // NOLINT(readability-redundant-access-specifiers)
  QPolygonF timeBarPoly(double time);
  double positionFromTime(double time);
  double timeFromPosition(double pos);
  double timeFromTick(int tick);
  int tickFromTime(double pos);
  void drawForeground(QPainter* painter, const QRectF& rect) override;
 
  QRectF drawTimeLabel(double time, const QRectF& row, QPainter* painter,
    const QFontMetrics& metrics, QList<const QRectF*> const& priorities);
 
  void updateNewTime(QGraphicsSceneMouseEvent* mouseEvent);
  bool hitTestCurrentTimePoly(const QPointF& pos);
  pqAnimationTrack* hitTestTracks(const QPointF& pos);
  pqAnimationKeyFrame* hitTestKeyFrame(pqAnimationTrack* t, const QPointF& pos);
 
  bool eventFilter(QObject* w, QEvent* e) override;
 
  void mouseDoubleClickEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
  void mousePressEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
  void mouseMoveEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
  void mouseReleaseEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
  void wheelEvent(QGraphicsSceneWheelEvent* wheelEvent) override;
 
  double timeToNormalizedTime(double) const;
  double normalizedTimeToTime(double) const;
 
  int currentTicks() const;
 
private:
  ModeType Mode = Real;
  int Ticks = 10;
  double CurrentTime = 0;
  double StartTime = 0;
  double EndTime = 1;
  double ZoomStartTime = 0;
  double ZoomEndTime = 1;
  double ZoomFactor = 1;
  int RowHeight;
  bool Interactive = false;
 
  QList<double> CustomTicks;
 
  // vars to support interaction
  bool CurrentTimeGrabbed = false;
  double NewCurrentTime = 0;
  double TimeLineGrabbedPosition = 0;
  double OldZoomStartTime = 0;
  bool TimeLineGrabbed = false;
  pqAnimationTrack* CurrentTrackGrabbed = nullptr;
  pqAnimationKeyFrame* CurrentKeyFrameGrabbed = nullptr;
  int CurrentKeyFrameEdge = 0;
  QPair<double, double> InteractiveRange;
  QList<double> SnapHints;
 
  QList<pqAnimationTrack*> Tracks;
 
  // model that provides names of tracks
  QStandardItemModel Header;
 
  // model that provides enabled state for the tracks.
  QStandardItemModel EnabledHeader;
 
  pqCheckBoxPixMaps* CheckBoxPixMaps;
 
  QString EnabledHeaderToolTip = "Enable/Disable Track";
 
  int TimePrecision = 6;
  QChar TimeNotation = 'g';
};
 
#endif // pqAnimationModel_h