vtkSMAnimationSceneWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMAnimationSceneWriter.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
24 #ifndef vtkSMAnimationSceneWriter_h
25 #define vtkSMAnimationSceneWriter_h
26 
27 #include "vtkRemotingAnimationModule.h" //needed for exports
28 #include "vtkSMSessionObject.h"
29 
31 class vtkSMProxy;
32 
34 {
35 public:
37  void PrintSelf(ostream& os, vtkIndent indent) override;
38 
42  virtual void SetAnimationScene(vtkSMProxy*);
43 
45 
48  virtual void SetAnimationScene(vtkSMAnimationScene*);
49  vtkGetObjectMacro(AnimationScene, vtkSMAnimationScene);
51 
56  bool Save();
57 
59 
62  vtkSetStringMacro(FileName);
63  vtkGetStringMacro(FileName);
65 
67 
70  vtkSetMacro(StartFileCount, int);
71  vtkGetMacro(StartFileCount, int);
73 
75 
80  vtkSetVector2Macro(PlaybackTimeWindow, double);
81  vtkGetVector2Macro(PlaybackTimeWindow, double);
83 
84 protected:
86  ~vtkSMAnimationSceneWriter() override;
87 
88  unsigned long ObserverID;
90 
95  virtual bool SaveInitialize(int countStart) = 0;
96 
101  virtual bool SaveFrame(double time) = 0;
102 
107  virtual bool SaveFinalize() = 0;
108 
109  void ExecuteEvent(vtkObject* caller, unsigned long eventid, void* calldata);
110 
111  // Flag indicating if we are currently saving.
112  // Set on entering Save() and cleared before leaving Save().
113  bool Saving;
115  char* FileName;
116  double PlaybackTimeWindow[2];
118 
119 private:
121  void operator=(const vtkSMAnimationSceneWriter&) = delete;
122 };
123 
124 #endif
superclass for any server manager classes that are related to a session
helper class used to write animations.
animation scene for ParaView.
vtkSMAnimationScene * AnimationScene
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
#define VTKREMOTINGANIMATION_EXPORT
void PrintSelf(ostream &os, vtkIndent indent) override