pqAnimationScene.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    pqAnimationScene.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqAnimationScene_h
#define pqAnimationScene_h

#include "pqProxy.h"
#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_11_0
#include <QPair>
#include <QSet>

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);

  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