pqVCRController.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
3 // SPDX-License-Identifier: BSD-3-Clause
4 
5 #ifndef pqVCRController_h
6 #define pqVCRController_h
7 
8 #include "pqComponentsModule.h"
9 #include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_11_0
10 #include <QObject>
11 #include <QPointer>
12 
13 class pqPipelineSource;
14 class pqAnimationScene;
15 class vtkObject;
16 
23 class PQCOMPONENTS_EXPORT pqVCRController : public QObject
24 {
25  Q_OBJECT
26 public:
27  pqVCRController(QObject* parent = nullptr);
28  ~pqVCRController() override;
29 
33  pqAnimationScene* getAnimationScene() const;
34 
35 Q_SIGNALS:
39  void timestepChanged();
40 
45  PARAVIEW_DEPRECATED_IN_5_11_0("Use overload with additional reversed argument.")
46  void playing(bool);
47 
54  void playing(bool, bool);
55 
62  void enabled(bool);
63 
67  void loop(bool);
68 
72  void timeRanges(double, double);
73 
74 public Q_SLOTS:
79  virtual void setAnimationScene(pqAnimationScene*);
80 
84  virtual void onTimeRangesChanged();
85 
87 
90  virtual void onFirstFrame();
91  virtual void onPreviousFrame();
92  virtual void onNextFrame();
93  virtual void onLastFrame();
94  virtual void onPlay();
95  virtual void onReverse();
96  virtual void onPause();
97  virtual void onLoop(bool checked);
99 
100 protected Q_SLOTS:
101  void onTick();
102  void onLoopPropertyChanged();
103  void onBeginPlay(vtkObject* caller, unsigned long, void*, void* reversed);
104  void onEndPlay(vtkObject* caller, unsigned long, void*, void* reversed);
105 
106 private:
107  Q_DISABLE_COPY(pqVCRController)
108 
109  QPointer<pqAnimationScene> Scene;
110 };
111 
112 #endif
loop
loop
vtkObject
pqAnimationScene
pqAnimationScene is a representation for a vtkSMAnimationScene proxy.
Definition: pqAnimationScene.h:22
Scene
Scene
vtkParaViewDeprecation.h
pqPipelineSource
PQ representation for a vtkSMProxy that can be involved in a pipeline.
Definition: pqPipelineSource.h:32
enabled
enabled
pqVCRController
pqVCRController is the QObject that encapsulates the VCR control functionality.
Definition: pqVCRController.h:23
PARAVIEW_DEPRECATED_IN_5_11_0
#define PARAVIEW_DEPRECATED_IN_5_11_0(reason)
Definition: vtkParaViewDeprecation.h:109