vtkSMAnimationSceneWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMAnimationSceneWriter_h
#define vtkSMAnimationSceneWriter_h
 
#include "vtkRemotingAnimationModule.h" //needed for exports
#include "vtkSMSessionObject.h"
 
class vtkSMAnimationScene;
class vtkSMProxy;
 
class VTKREMOTINGANIMATION_EXPORT vtkSMAnimationSceneWriter : public vtkSMSessionObject
{
public:
  vtkTypeMacro(vtkSMAnimationSceneWriter, vtkSMSessionObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void SetAnimationScene(vtkSMProxy*);
 
 
  virtual void SetAnimationScene(vtkSMAnimationScene*);
  vtkGetObjectMacro(AnimationScene, vtkSMAnimationScene);
 
  bool Save();
 
 
  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);
 
 
  vtkSetMacro(StartFileCount, int);
  vtkGetMacro(StartFileCount, int);
 
 
  vtkSetVector2Macro(PlaybackTimeWindow, double);
  vtkGetVector2Macro(PlaybackTimeWindow, double);
 
 
  vtkSetMacro(Stride, int);
  vtkGetMacro(Stride, int);
 
protected:
  vtkSMAnimationSceneWriter();
  ~vtkSMAnimationSceneWriter() override;
 
  unsigned long ObserverID;
  vtkSMAnimationScene* AnimationScene;
 
  virtual bool SaveInitialize(int countStart) = 0;
 
  virtual bool SaveFrame(double time) = 0;
 
  virtual bool SaveFinalize() = 0;
 
  void ExecuteEvent(vtkObject* caller, unsigned long eventid, void* calldata);
 
  // Flag indicating if we are currently saving.
  // Set on entering Save() and cleared before leaving Save().
  bool Saving;
  bool SaveFailed;
  char* FileName;
  double PlaybackTimeWindow[2];
  int StartFileCount;
  int Stride = 1;
 
private:
  vtkSMAnimationSceneWriter(const vtkSMAnimationSceneWriter&) = delete;
  void operator=(const vtkSMAnimationSceneWriter&) = delete;
};
 
#endif