1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*=========================================================================
Program: ParaView
Module: vtkSMAnimationSceneWriter.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMAnimationSceneWriter
* @brief helper class used
* to write animations.
*
* vtkSMAnimationSceneWriter is an abstract superclass for writers
* that can write animations out.
*/
#ifndef vtkSMAnimationSceneWriter_h
#define vtkSMAnimationSceneWriter_h
#include "vtkPVAnimationModule.h" //needed for exports
#include "vtkSMSessionObject.h"
class vtkSMAnimationScene;
class vtkSMProxy;
class VTKPVANIMATION_EXPORT vtkSMAnimationSceneWriter : public vtkSMSessionObject
{
public:
vtkTypeMacro(vtkSMAnimationSceneWriter, vtkSMSessionObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Convenience method to set the proxy.
*/
virtual void SetAnimationScene(vtkSMProxy*);
//@{
/**
* Get/Set the animation scene that this writer will write.
*/
virtual void SetAnimationScene(vtkSMAnimationScene*);
vtkGetObjectMacro(AnimationScene, vtkSMAnimationScene);
//@}
/**
* Begin the saving. This will result in playing of the animation.
* Returns the status of the save.
*/
bool Save();
//@{
/**
* Get/Set the filename.
*/
vtkSetStringMacro(FileName);
vtkGetStringMacro(FileName);
//@}
//@{
/**
* Get/Set the start file count.
*/
vtkSetMacro(StartFileCount, int);
vtkGetMacro(StartFileCount, int);
//@}
//@{
/**
* Get/Set time window that we want to write
* If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we
* want to export the full time range available.
*/
vtkSetVector2Macro(PlaybackTimeWindow, double);
vtkGetVector2Macro(PlaybackTimeWindow, double);
//@}
protected:
vtkSMAnimationSceneWriter();
~vtkSMAnimationSceneWriter();
unsigned long ObserverID;
vtkSMAnimationScene* AnimationScene;
/**
* Subclasses should override this method.
* Called to initialize saving.
*/
virtual bool SaveInitialize(int countStart) = 0;
/**
* Subclasses should override this method.
* Called to save a particular frame.
*/
virtual bool SaveFrame(double time) = 0;
/**
* Subclasses should override this method.
* Called to finalize saving.
*/
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;
private:
vtkSMAnimationSceneWriter(const vtkSMAnimationSceneWriter&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMAnimationSceneWriter&) VTK_DELETE_FUNCTION;
};
#endif
|
