pqAnimationScene.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 pqAnimationScene_h
#define pqAnimationScene_h
 
#include "pqProxy.h"
#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_11_0
#include <QPair>
#include <QSet>
 
struct pqAnimatedPropertyInfo;
class pqAnimationCue;
class QSize;
class vtkObject;
 
class PQCORE_EXPORT pqAnimationScene : public pqProxy
{
  Q_OBJECT
  typedef pqProxy Superclass;
 
public:
  pqAnimationScene(const QString& group, const QString& name, vtkSMProxy* proxy, pqServer* server,
    QObject* parent = nullptr);
  ~pqAnimationScene() override;
 
  pqAnimationCue* getCue(vtkSMProxy* proxy, const char* propertyname, int index) const;
 
 
  pqAnimationCue* createCue(vtkSMProxy* proxy, const char* propertyname, int index);
  pqAnimationCue* createCue(
    vtkSMProxy* proxy, const char* propertyname, int index, const QString& cuetype);
  pqAnimationCue* createCue(const QString& cuetype);
  pqAnimationCue* createCue(const pqAnimatedPropertyInfo& propInfo);
 
  void removeCues(vtkSMProxy* proxy);
 
  void removeCue(pqAnimationCue* cue);
 
  bool contains(pqAnimationCue*) const;
 
  QPair<double, double> getClockTimeRange() const;
 
  QSet<pqAnimationCue*> getCues() const;
 
  double getAnimationTime() const;
 
  QList<double> getTimeSteps() const;
 
Q_SIGNALS:
  void preAddedCue(pqAnimationCue*);
 
  void addedCue(pqAnimationCue*);
 
  void preRemovedCue(pqAnimationCue*);
 
  void removedCue(pqAnimationCue*);
 
  void cuesChanged();
 
  void playModeChanged();
 
  void loopChanged();
 
  void clockTimeRangesChanged();
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use the overload with VTK callback signature.")
  void beginPlay();
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use the overload with VTK callback signature.")
  void endPlay();
 
  void beginPlay(vtkObject* caller, unsigned long, void*, void* reversed);
 
  void endPlay(vtkObject* caller, unsigned long, void*, void* reversed);
 
  void tick(int percentCompleted);
 
  void animationTime(double time);
 
  void frameCountChanged();
 
  void timeStepsChanged();
 
  void timeLabelChanged();
 
public Q_SLOTS:
  void play();
 
  void pause();
 
  void setAnimationTime(double time);
 
private Q_SLOTS:
  void onCuesChanged();
 
  void onTick(vtkObject* caller, unsigned long, void*, void* info);
 
  void onAnimationTimePropertyChanged();
 
protected:
  void initializeCue(vtkSMProxy* proxy, const char* propertyname, int index, pqAnimationCue* cue);
 
private:
  Q_DISABLE_COPY(pqAnimationScene)
 
  class pqInternals;
  pqInternals* Internals;
 
  pqAnimationCue* createCueInternal(
    const QString& cuetype, vtkSMProxy* proxy, const char* propertyname, int index);
};
 
#endif