pqAnimationTimeWidget.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 pqAnimationTimeWidget_h
#define pqAnimationTimeWidget_h

#include "pqComponentsModule.h"
#include "pqDoubleLineEdit.h" // for pqDoubleLineEdit::RealNumberNotation.

#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_12_0

#include <QList>
#include <QScopedPointer>
#include <QVariant>
#include <QWidget>
#include <vector>

class pqAnimationScene;
class vtkSMProxy;

class PQCOMPONENTS_EXPORT pqAnimationTimeWidget : public QWidget
{
  Q_OBJECT
  Q_ENUMS(RealNumberNotation)
  Q_PROPERTY(QString playMode READ playMode WRITE setPlayMode NOTIFY playModeChanged)
  Q_PROPERTY(int numberOfFrames READ numberOfFrames WRITE setNumberOfFrames)
  Q_PROPERTY(double startTime READ startTime WRITE setStartTime)
  Q_PROPERTY(double endTime READ endTime WRITE setEndTime)
  Q_PROPERTY(QString timeLabel READ timeLabel WRITE setTimeLabel)
  Q_PROPERTY(QList<QVariant> timestepValues READ timestepValues WRITE setTimestepValues)

  typedef QWidget Superclass;

public:
  pqAnimationTimeWidget(QWidget* parent = nullptr);
  ~pqAnimationTimeWidget() override;
  using RealNumberNotation = pqDoubleLineEdit::RealNumberNotation;

  vtkSMProxy* animationScene() const;

  void setAnimationScene(pqAnimationScene* animationScene);


  void setTimestepValues(const QList<QVariant>& list);
  const QList<QVariant>& timestepValues() const;


  void setStartTime(double start);
  double startTime() const;


  void setEndTime(double end);
  double endTime() const;


  void setNumberOfFrames(int nbOfFrame);
  int numberOfFrames() const;

  void setCurrentTime(double t);

  RealNumberNotation notation() const;

  int precision() const;


  void setPlayMode(const QString& mode);
  QString playMode() const;


  void setTimeLabel(const QString& val);
  QString timeLabel() const;

Q_SIGNALS:
  void playModeChanged();
  void dummySignal();

public Q_SLOTS:
  PARAVIEW_DEPRECATED_IN_5_12_0("Unused. Display rely on global setting")
  void setNotation(RealNumberNotation _notation);

  PARAVIEW_DEPRECATED_IN_5_12_0("Unused. Display rely on global setting")
  void setPrecision(int precision);

  void render();

protected Q_SLOTS:
  void updateCurrentTime(double t);

private:
  Q_DISABLE_COPY(pqAnimationTimeWidget)

  class pqInternals;
  QScopedPointer<pqInternals> Internals;
};

#endif