pqAnimationTimeWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqAnimationTimeWidget.h
5 
6  Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 ========================================================================*/
32 #ifndef pqAnimationTimeWidget_h
33 #define pqAnimationTimeWidget_h
34 
35 #include "pqComponentsModule.h"
36 #include "pqDoubleLineEdit.h" // for pqDoubleLineEdit::RealNumberNotation.
37 #include "vtkLegacy.h" // for VTK_LEGACY
38 
39 #include <QList>
40 #include <QScopedPointer>
41 #include <QVariant>
42 #include <QWidget>
43 #include <vector>
44 
45 class vtkSMProxy;
46 
61 {
62  Q_OBJECT
63  Q_ENUMS(RealNumberNotation)
64  Q_PROPERTY(double timeValue READ timeValue WRITE setTimeValue NOTIFY timeValueChanged)
65  Q_PROPERTY(QString playMode READ playMode WRITE setPlayMode NOTIFY playModeChanged)
66  Q_PROPERTY(bool playModeReadOnly READ playModeReadOnly WRITE setPlayModeReadOnly)
67  Q_PROPERTY(QString timeLabel READ timeLabel WRITE setTimeLabel)
68  Q_PROPERTY(QList<QVariant> timestepValues READ timestepValues WRITE setTimestepValues)
69 
70  typedef QWidget Superclass;
71 
72 public:
73  pqAnimationTimeWidget(QWidget* parent = 0);
74  ~pqAnimationTimeWidget() override;
75 
77 
82  vtkSMProxy* animationScene() const;
83 
85 
89  void setTimestepValues(const QList<QVariant>& list);
90  const QList<QVariant>& timestepValues() const;
92 
94 
97  void setTimeValue(double time);
98  double timeValue() const;
100 
105  RealNumberNotation notation() const;
106 
111  int precision() const;
112 
114 
117  void setPlayMode(const QString& mode);
118  QString playMode() const;
120 
122 
126  void setPlayModeReadOnly(bool val);
127  bool playModeReadOnly() const;
129 
131 
134  void setTimeLabel(const QString& val);
135  QString timeLabel() const;
137 
139 
142  VTK_LEGACY(void setTimePrecision(int));
143  VTK_LEGACY(int timePrecision() const);
144  VTK_LEGACY(void setTimeNotation(const QChar& val));
145  VTK_LEGACY(QChar timeNotation() const);
147 
149 
153  VTK_LEGACY(void setTimeStepCount(int count));
154  VTK_LEGACY(int timeStepCount() const);
156 
157 Q_SIGNALS:
158  void timeValueChanged();
159  void playModeChanged();
160  void dummySignal();
161 
162 public Q_SLOTS:
167  void setAnimationScene(vtkSMProxy* animationScene);
168 
173  void setNotation(RealNumberNotation _notation);
174 
179  void setPrecision(int precision);
180 
181 private:
182  Q_DISABLE_COPY(pqAnimationTimeWidget)
183 
184  class pqInternals;
185  QScopedPointer<pqInternals> Internals;
186 };
187 
188 #endif
RealNumberNotation
This enum specifies which notations to use for displaying the value.
#define PQCOMPONENTS_EXPORT
#define VTK_LEGACY(method)
Definition: vtkLegacy.h:52
pqLineEdit subclass that supports a low precision view when inactive
pqAnimationTimeWidget is a widget that can be used to show/set the current animation time...
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
#define const
Definition: zconf.h:235