vtkTimestepsAnimationPlayer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkTimestepsAnimationPlayer_h
#define vtkTimestepsAnimationPlayer_h

#include "vtkAnimationPlayer.h"
#include "vtkRemotingAnimationModule.h" // needed for export macro

class vtkTimestepsAnimationPlayerSetOfDouble;

class VTKREMOTINGANIMATION_EXPORT vtkTimestepsAnimationPlayer : public vtkAnimationPlayer
{
public:
  static vtkTimestepsAnimationPlayer* New();
  vtkTypeMacro(vtkTimestepsAnimationPlayer, vtkAnimationPlayer);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void AddTimeStep(double time);
  void RemoveTimeStep(double time);

  void RemoveAllTimeSteps();

  unsigned int GetNumberOfTimeSteps();


  vtkSetClampMacro(FramesPerTimestep, unsigned long, 1, VTK_UNSIGNED_LONG_MAX);
  vtkGetMacro(FramesPerTimestep, unsigned long);

  double GetNextTimeStep(double time);


  double GetPreviousTimeStep(double time);

protected:
  vtkTimestepsAnimationPlayer();
  ~vtkTimestepsAnimationPlayer() override;


  // Initialize inner variables. Call it before any GetNextTime/GetPreviousTime call.
  void StartLoop(double, double, double, double* playbackWindow) override;
  void EndLoop() override{};
  // Get next time in loop. Take Count and Stride into account.
  double GetNextTime(double currentime) override;
  // Get previous time in loop. Take Count and Stride into account.
  double GetPreviousTime(double currenttime) override;

  double GoToNext(double, double, double currenttime) override
  {
    return this->GetNextTimeStep(currenttime);
  }

  double GoToPrevious(double, double, double currenttime) override
  {
    return this->GetPreviousTimeStep(currenttime);
  }

  double PlaybackWindow[2];
  unsigned long FramesPerTimestep;
  unsigned long Count;

private:
  vtkTimestepsAnimationPlayer(const vtkTimestepsAnimationPlayer&) = delete;
  void operator=(const vtkTimestepsAnimationPlayer&) = delete;

  double GetNextInternal(double time, double defaultVal);

  vtkTimestepsAnimationPlayerSetOfDouble* TimeSteps;
};

#endif