pqTimeInspectorWidget.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 pqTimeInspectorWidget_h
#define pqTimeInspectorWidget_h

#include "pqApplicationComponentsModule.h"

#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_12_0

#include <QScopedPointer>
#include <QVariant>
#include <QWidget>

class pqAnimationScene;
class pqAnimationTrack;
class pqServer;
class pqServerManagerModelItem;
class vtkSMProxy;

class PARAVIEW_DEPRECATED_IN_5_12_0(
  "Use `pqTimeManagerWidget` instead") PQAPPLICATIONCOMPONENTS_EXPORT pqTimeInspectorWidget
  : public QWidget
{
  Q_OBJECT
  Q_PROPERTY(double sceneStartTime READ sceneStartTime WRITE setSceneStartTime)
  Q_PROPERTY(double sceneEndTime READ sceneEndTime WRITE setSceneEndTime)
  Q_PROPERTY(QString scenePlayMode READ scenePlayMode WRITE setScenePlayMode)
  Q_PROPERTY(QList<QVariant> sceneTimeSteps READ sceneTimeSteps WRITE setSceneTimeSteps)
  Q_PROPERTY(int sceneNumberOfFrames READ sceneNumberOfFrames WRITE setSceneNumberOfFrames)
  Q_PROPERTY(QList<QVariant> timeSources READ timeSources WRITE setTimeSources)
  Q_PROPERTY(
    QList<QVariant> suppressedTimeSources READ suppressedTimeSources WRITE setSuppressedTimeSources)

  typedef QWidget Superclass;

public:
  pqTimeInspectorWidget(QWidget* parent = nullptr);
  ~pqTimeInspectorWidget() override;

  pqServer* server() const;

  double sceneStartTime() const;
  void setSceneStartTime(double);

  double sceneEndTime() const;
  void setSceneEndTime(double);

  QString scenePlayMode() const;
  void setScenePlayMode(const QString&);

  QList<QVariant> sceneTimeSteps() const;
  void setSceneTimeSteps(const QList<QVariant>& val);

  int sceneNumberOfFrames() const;
  void setSceneNumberOfFrames(int val);

  QList<QVariant> timeSources() const;
  void setTimeSources(const QList<QVariant>& proxies);

  QList<QVariant> suppressedTimeSources() const;
  void setSuppressedTimeSources(const QList<QVariant>& proxies);

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void setServer(pqServer* server);

  void setSceneCurrentTime(double);

  void setAnimationScene(pqAnimationScene* scene);

protected Q_SLOTS:
  void updateSceneTime();

private Q_SLOTS:
  void updateScene();

  void handleProxyNameChanged(pqServerManagerModelItem*);

  void toggleTrackSuppression(pqAnimationTrack*);

  void generalSettingsChanged();

Q_SIGNALS:
  void dummySignal();
  void suppressedTimeSourcesChanged();

private:
  Q_DISABLE_COPY(pqTimeInspectorWidget)

  class pqInternals;
  const QScopedPointer<pqInternals> Internals;
  class PropertyLinksConnection;
  class TimeTrack;
};

#endif