vtkCompositeAnimationPlayer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCompositeAnimationPlayer_h
#define vtkCompositeAnimationPlayer_h
 
#include "vtkAnimationPlayer.h"
#include "vtkRemotingAnimationModule.h" // needed for export macro
 
#include "vtkParaViewDeprecation.h"
 
class vtkSequenceAnimationPlayer;
class vtkTimestepsAnimationPlayer;
 
class VTKREMOTINGANIMATION_EXPORT vtkCompositeAnimationPlayer : public vtkAnimationPlayer
{
public:
  static vtkCompositeAnimationPlayer* New();
  vtkTypeMacro(vtkCompositeAnimationPlayer, vtkAnimationPlayer);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum Modes
  {
    SEQUENCE = 0,
    SNAP_TO_TIMESTEPS = 2
  };
 
 
  vtkSetMacro(PlayMode, int);
  vtkGetMacro(PlayMode, int);
 
  void SetNumberOfFrames(int val);
 
  PARAVIEW_DEPRECATED_IN_5_12_0("Use `SetStride` and vtkSequenceAnimationPlayer instead")
  void SetDuration(int val);
 
 
  void AddTimeStep(double val);
  void RemoveAllTimeSteps();
  void SetFramesPerTimestep(int val);
 
 
  void SetStride(int _val) override;
 
protected:
  vtkCompositeAnimationPlayer();
  ~vtkCompositeAnimationPlayer() override;
 
 
  void StartLoop(double starttime, double endtime, double curtime, double* playbackWindow) override;
  void EndLoop() override;
  double GetNextTime(double currentime) override;
  double GetPreviousTime(double currenttime) override;
  double GoToNext(double start, double end, double currenttime) override;
  double GoToPrevious(double start, double end, double currenttime) override;
 
  vtkAnimationPlayer* GetActivePlayer();
 
  vtkSequenceAnimationPlayer* SequenceAnimationPlayer;
  vtkTimestepsAnimationPlayer* TimestepsAnimationPlayer;
 
  int PlayMode;
 
private:
  vtkCompositeAnimationPlayer(const vtkCompositeAnimationPlayer&) = delete;
  void operator=(const vtkCompositeAnimationPlayer&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
#endif