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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkExporter.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkExporter
* @brief abstract class to write a scene to a file
*
* vtkExporter is an abstract class that exports a scene to a file. It
* is very similar to vtkWriter except that a writer only writes out
* the geometric and topological data for an object, where an exporter
* can write out material properties, lighting, camera parameters etc.
* The concrete subclasses of this class may not write out all of this
* information. For example vtkOBJExporter writes out Wavefront obj files
* which do not include support for camera parameters.
*
* vtkExporter provides the convenience methods StartWrite() and EndWrite().
* These methods are executed before and after execution of the Write()
* method. You can also specify arguments to these methods.
* This class defines SetInput and GetInput methods which take or return
* a vtkRenderWindow.
* @warning
* Every subclass of vtkExporter must implement a WriteData() method.
*
* @sa
* vtkOBJExporter vtkRenderWindow vtkWriter
*/
#ifndef vtkExporter_h
#define vtkExporter_h
#include "vtkIOExportModule.h" // For export macro
#include "vtkObject.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkRenderWindow;
class vtkRenderer;
class VTKIOEXPORT_EXPORT vtkExporter : public vtkObject
{
public:
vtkTypeMacro(vtkExporter, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Write data to output. Method executes subclasses WriteData() method, as
* well as StartWrite() and EndWrite() methods.
*/
virtual void Write();
/**
* Convenient alias for Write() method.
*/
void Update();
///@{
/**
* Set/Get the rendering window that contains the scene to be written.
*/
virtual void SetRenderWindow(vtkRenderWindow*);
vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
///@}
///@{
/**
* Set/Get the renderer that contains actors to be written.
* If it is set to nullptr (by default), then in most subclasses
* the behavior is to only export actors of the first renderer.
* In some subclasses, if ActiveRenderer is nullptr then
* actors of all renderers will be exported.
* The renderer must be in the renderer collection of the specified
* RenderWindow.
* \sa SetRenderWindow()
*/
virtual void SetActiveRenderer(vtkRenderer*);
vtkGetObjectMacro(ActiveRenderer, vtkRenderer);
///@}
///@{
/**
* These methods are provided for backward compatibility. Will disappear
* soon.
*/
void SetInput(vtkRenderWindow* renWin) { this->SetRenderWindow(renWin); }
vtkRenderWindow* GetInput() { return this->GetRenderWindow(); }
///@}
/**
* Specify a function to be called before data is written. Function will
* be called with argument provided.
*/
void SetStartWrite(void (*f)(void*), void* arg);
/**
* Specify a function to be called after data is written.
* Function will be called with argument provided.
*/
void SetEndWrite(void (*f)(void*), void* arg);
/**
* Set the arg delete method. This is used to free user memory.
*/
void SetStartWriteArgDelete(void (*f)(void*));
/**
* Set the arg delete method. This is used to free user memory.
*/
void SetEndWriteArgDelete(void (*f)(void*));
/**
* Returns the MTime also considering the RenderWindow.
*/
vtkMTimeType GetMTime() override;
protected:
vtkExporter();
~vtkExporter() override;
vtkRenderWindow* RenderWindow;
vtkRenderer* ActiveRenderer;
virtual void WriteData() = 0;
void (*StartWrite)(void*);
void (*StartWriteArgDelete)(void*);
void* StartWriteArg;
void (*EndWrite)(void*);
void (*EndWriteArgDelete)(void*);
void* EndWriteArg;
private:
vtkExporter(const vtkExporter&) = delete;
void operator=(const vtkExporter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
