pqTimelinePainter.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 pqTimelinePainter_h
#define pqTimelinePainter_h

#include "pqApplicationComponentsModule.h"

#include <QObject>

#include <memory> // for std::unique_ptr

class QPainter;
class QStyleOptionViewItem;
class QStandardItem;

class PQAPPLICATIONCOMPONENTS_EXPORT pqTimelinePainter : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqTimelinePainter(QObject* parent = nullptr);
  ~pqTimelinePainter() override;

  void paint(QPainter* painter, const QModelIndex& index, const QStyleOptionViewItem& option);

  void setSceneStartTime(double time);
  void setSceneEndTime(double time);
  void setSceneCurrentTime(double time);
  double getSceneCurrentTime();
  void setSceneLockStart(bool lock);
  void setSceneLockEnd(bool lock);


  void setDisplayTimeRange(double start, double end);
  QPair<double, double> displayTimeRange();

  bool hasStartEndLabels();
  QRect getStartLabelRect();
  QRect getEndLabelRect();


  double positionFromTime(double time, const QStyleOptionViewItem& option);
  double positionFromTime(double time);

  double indexTimeFromPosition(
    double pos, const QStyleOptionViewItem& option, const QModelIndex& index);
  double timeFromPosition(double pos, const QStyleOptionViewItem& option);
  double timeFromPosition(double pos);

  bool isTimeTrack(QStandardItem* item);
  bool isAnimationTrack(QStandardItem* item);
  std::vector<double> getTimes(QStandardItem* item);
  double getSourceTime(QStandardItem* item);
  QString getLabel(QStandardItem* item, int index);

protected:
  void paintBackground(QPainter* painter, const QStyleOptionViewItem& option, bool alternate);
  void paintTimeline(QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item,
    bool paintLabels, const QStyleOptionViewItem& labelsOption);
  void paintTimeTrack(QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item);
  void paintSourceTrack(QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item);
  void paintAnimationTrack(
    QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item);
  void paintSourcePipelineTime(
    QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item);
  void paintSceneCurrentTime(QPainter* painter, const QStyleOptionViewItem& option);
  bool paintTick(QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item,
    double time, bool paintLabels, const QStyleOptionViewItem& labelsOption, const QString& label);
  void paintTimeMark(QPainter* painter, const QStyleOptionViewItem& option, double pos);
  bool paintLabel(QPainter* painter, const QStyleOptionViewItem& option, QStandardItem* item,
    double time, const QString& label);

  double SceneCurrentTime = 0;
  double SceneStartTime = 0;
  double SceneEndTime = 1;

  double DisplayStartTime = 0.;
  double DisplayEndTime = 1.;

  bool SceneLockStart = false;
  bool SceneLockEnd = false;

private:
  struct pqInternals;
  std::unique_ptr<pqInternals> Internals;
};

#endif