VTK  9.3.20240329
vtkXMLWriterC.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 #ifndef vtkXMLWriterC_h
4 #define vtkXMLWriterC_h
5 
6 #include "vtkIOXMLModule.h" // For export macro
7 #include "vtkType.h" /* For scalar and vtkDataObject type enumerations. */
8 
9 #ifdef __cplusplus
10 extern "C"
11 {
12 #endif /*cplusplus*/
13 
18  typedef struct vtkXMLWriterC_s vtkXMLWriterC;
19 
24 #define vtkXMLWriterC_New VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_New)
25  VTKIOXML_EXPORT
27 
33 #define vtkXMLWriterC_Delete VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Delete)
34  VTKIOXML_EXPORT
36 
44 #define vtkXMLWriterC_SetDataObjectType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetDataObjectType)
45  VTKIOXML_EXPORT
47 
56 #define vtkXMLWriterC_SetDataModeType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetDataModeType)
57  VTKIOXML_EXPORT
58  void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC* self, int datamodetype);
59 
66 #define vtkXMLWriterC_SetExtent VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetExtent)
67  VTKIOXML_EXPORT
69 
82 #define vtkXMLWriterC_SetPoints VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetPoints)
83  VTKIOXML_EXPORT
84  void vtkXMLWriterC_SetPoints(vtkXMLWriterC* self, int dataType, void* data, vtkIdType numPoints);
85 
92 #define vtkXMLWriterC_SetOrigin VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetOrigin)
93  VTKIOXML_EXPORT
94  void vtkXMLWriterC_SetOrigin(vtkXMLWriterC* self, double origin[3]);
95 
102 #define vtkXMLWriterC_SetSpacing VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetSpacing)
103  VTKIOXML_EXPORT
105 
118 #define vtkXMLWriterC_SetCoordinates VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCoordinates)
119  VTKIOXML_EXPORT
121  vtkXMLWriterC* self, int axis, int dataType, void* data, vtkIdType numCoordinates);
122 
142 #define vtkXMLWriterC_SetCellsWithType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellsWithType)
143  VTKIOXML_EXPORT
145  vtkXMLWriterC* self, int cellType, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);
146 
161 #define vtkXMLWriterC_SetCellsWithTypes VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellsWithTypes)
162  VTKIOXML_EXPORT
164  vtkXMLWriterC* self, int* cellTypes, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);
165 
189 #define vtkXMLWriterC_SetPointData VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetPointData)
190  VTKIOXML_EXPORT
191  void vtkXMLWriterC_SetPointData(vtkXMLWriterC* self, const char* name, int dataType, void* data,
192  vtkIdType numTuples, int numComponents, const char* role);
193 
194 #define vtkXMLWriterC_SetCellData VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellData)
195  VTKIOXML_EXPORT
196  void vtkXMLWriterC_SetCellData(vtkXMLWriterC* self, const char* name, int dataType, void* data,
197  vtkIdType numTuples, int numComponents, const char* role);
198 
205 #define vtkXMLWriterC_SetFileName VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetFileName)
206  VTKIOXML_EXPORT
207  void vtkXMLWriterC_SetFileName(vtkXMLWriterC* self, const char* fileName);
208 
215 #define vtkXMLWriterC_Write VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Write)
216  VTKIOXML_EXPORT
218 
226 #define vtkXMLWriterC_SetNumberOfTimeSteps \
227  VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetNumberOfTimeSteps)
228  VTKIOXML_EXPORT
229  void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC* self, int numTimeSteps);
230 
238 #define vtkXMLWriterC_Start VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Start)
239  VTKIOXML_EXPORT
241 
252 #define vtkXMLWriterC_WriteNextTimeStep VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_WriteNextTimeStep)
253  VTKIOXML_EXPORT
254  void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC* self, double timeValue);
255 
262 #define vtkXMLWriterC_Stop VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Stop)
263  VTKIOXML_EXPORT
265 
266 #ifdef __cplusplus
267 } /* extern "C" */
268 #endif /*cplusplus*/
269 
270 #endif
271 // VTK-HeaderTest-Exclude: vtkXMLWriterC.h
@ extent
Definition: vtkX3D.h:345
@ spacing
Definition: vtkX3D.h:481
@ name
Definition: vtkX3D.h:219
@ data
Definition: vtkX3D.h:315
int vtkIdType
Definition: vtkType.h:315
#define vtkXMLWriterC_SetCellsWithTypes
Set a cell array on the data object to be written.
#define vtkXMLWriterC_Write
Write the data to a file immediately.
#define vtkXMLWriterC_SetDataObjectType
Set the VTK data object type that will be written.
Definition: vtkXMLWriterC.h:44
#define vtkXMLWriterC_SetSpacing
Set the spacing of an image data set.
#define vtkXMLWriterC_SetCellsWithType
Set a cell array on the data object to be written.
#define vtkXMLWriterC_Stop
Stop writing a time-series to the output file.
#define vtkXMLWriterC_WriteNextTimeStep
Write one time step of a time-series to the output file.
#define vtkXMLWriterC_Start
Start writing a time-series to the output file.
#define vtkXMLWriterC_SetExtent
Set the extent of a structured data set.
Definition: vtkXMLWriterC.h:66
#define vtkXMLWriterC_SetPointData
Set a point or cell data array by name.
#define vtkXMLWriterC_SetFileName
Set the name of the file into which the data are to be written.
#define vtkXMLWriterC_SetNumberOfTimeSteps
Set the number of time steps that will be written between upcoming Start and Stop calls.
#define vtkXMLWriterC_SetPoints
Set the points of a point data set.
Definition: vtkXMLWriterC.h:82
#define vtkXMLWriterC_Delete
Delete the writer object.
Definition: vtkXMLWriterC.h:33
#define vtkXMLWriterC_New
Create a new instance of vtkXMLWriterC.
Definition: vtkXMLWriterC.h:24
struct vtkXMLWriterC_s vtkXMLWriterC
vtkXMLWriterC is an opaque structure holding the state of an individual writer object.
Definition: vtkXMLWriterC.h:18
#define vtkXMLWriterC_SetCoordinates
Set the coordinates along one axis of a rectilinear grid data set.
#define vtkXMLWriterC_SetOrigin
Set the origin of an image data set.
Definition: vtkXMLWriterC.h:92
#define vtkXMLWriterC_SetCellData
#define vtkXMLWriterC_SetDataModeType
Set the VTK writer data mode to either:
Definition: vtkXMLWriterC.h:56