VTK  9.3.0
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  VTKIOXML_EXPORT
26 
32  VTKIOXML_EXPORT
34 
42  VTKIOXML_EXPORT
44 
53  VTKIOXML_EXPORT
54  void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC* self, int datamodetype);
55 
62  VTKIOXML_EXPORT
64 
77  VTKIOXML_EXPORT
78  void vtkXMLWriterC_SetPoints(vtkXMLWriterC* self, int dataType, void* data, vtkIdType numPoints);
79 
86  VTKIOXML_EXPORT
87  void vtkXMLWriterC_SetOrigin(vtkXMLWriterC* self, double origin[3]);
88 
95  VTKIOXML_EXPORT
97 
110  VTKIOXML_EXPORT
112  vtkXMLWriterC* self, int axis, int dataType, void* data, vtkIdType numCoordinates);
113 
133  VTKIOXML_EXPORT
135  vtkXMLWriterC* self, int cellType, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);
136 
151  VTKIOXML_EXPORT
153  vtkXMLWriterC* self, int* cellTypes, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);
154 
178  VTKIOXML_EXPORT
179  void vtkXMLWriterC_SetPointData(vtkXMLWriterC* self, const char* name, int dataType, void* data,
180  vtkIdType numTuples, int numComponents, const char* role);
181  VTKIOXML_EXPORT
182  void vtkXMLWriterC_SetCellData(vtkXMLWriterC* self, const char* name, int dataType, void* data,
183  vtkIdType numTuples, int numComponents, const char* role);
184 
191  VTKIOXML_EXPORT
192  void vtkXMLWriterC_SetFileName(vtkXMLWriterC* self, const char* fileName);
193 
200  VTKIOXML_EXPORT
202 
210  VTKIOXML_EXPORT
211  void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC* self, int numTimeSteps);
212 
220  VTKIOXML_EXPORT
222 
233  VTKIOXML_EXPORT
234  void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC* self, double timeValue);
235 
242  VTKIOXML_EXPORT
244 
245 #ifdef __cplusplus
246 } /* extern "C" */
247 #endif /*cplusplus*/
248 
249 #endif
250 // 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
VTKIOXML_EXPORT void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC *self, int datamodetype)
Set the VTK writer data mode to either:
VTKIOXML_EXPORT void vtkXMLWriterC_SetExtent(vtkXMLWriterC *self, int extent[6])
Set the extent of a structured data set.
VTKIOXML_EXPORT void vtkXMLWriterC_SetCellsWithType(vtkXMLWriterC *self, int cellType, vtkIdType ncells, vtkIdType *cells, vtkIdType cellsSize)
Set a cell array on the data object to be written.
VTKIOXML_EXPORT void vtkXMLWriterC_SetCellsWithTypes(vtkXMLWriterC *self, int *cellTypes, vtkIdType ncells, vtkIdType *cells, vtkIdType cellsSize)
Set a cell array on the data object to be written.
VTKIOXML_EXPORT void vtkXMLWriterC_SetOrigin(vtkXMLWriterC *self, double origin[3])
Set the origin of an image data set.
VTKIOXML_EXPORT void vtkXMLWriterC_Stop(vtkXMLWriterC *self)
Stop writing a time-series to the output file.
VTKIOXML_EXPORT void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC *self, int objType)
Set the VTK data object type that will be written.
VTKIOXML_EXPORT void vtkXMLWriterC_Start(vtkXMLWriterC *self)
Start writing a time-series to the output file.
VTKIOXML_EXPORT void vtkXMLWriterC_SetCoordinates(vtkXMLWriterC *self, int axis, int dataType, void *data, vtkIdType numCoordinates)
Set the coordinates along one axis of a rectilinear grid data set.
VTKIOXML_EXPORT void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC *self, int numTimeSteps)
Set the number of time steps that will be written between upcoming Start and Stop calls.
VTKIOXML_EXPORT void vtkXMLWriterC_SetCellData(vtkXMLWriterC *self, const char *name, int dataType, void *data, vtkIdType numTuples, int numComponents, const char *role)
VTKIOXML_EXPORT int vtkXMLWriterC_Write(vtkXMLWriterC *self)
Write the data to a file immediately.
VTKIOXML_EXPORT void vtkXMLWriterC_SetSpacing(vtkXMLWriterC *self, double spacing[3])
Set the spacing of an image data set.
VTKIOXML_EXPORT void vtkXMLWriterC_SetFileName(vtkXMLWriterC *self, const char *fileName)
Set the name of the file into which the data are to be written.
VTKIOXML_EXPORT void vtkXMLWriterC_SetPointData(vtkXMLWriterC *self, const char *name, int dataType, void *data, vtkIdType numTuples, int numComponents, const char *role)
Set a point or cell data array by name.
struct vtkXMLWriterC_s vtkXMLWriterC
vtkXMLWriterC is an opaque structure holding the state of an individual writer object.
Definition: vtkXMLWriterC.h:18
VTKIOXML_EXPORT void vtkXMLWriterC_SetPoints(vtkXMLWriterC *self, int dataType, void *data, vtkIdType numPoints)
Set the points of a point data set.
VTKIOXML_EXPORT void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC *self, double timeValue)
Write one time step of a time-series to the output file.
VTKIOXML_EXPORT vtkXMLWriterC * vtkXMLWriterC_New()
Create a new instance of vtkXMLWriterC.
VTKIOXML_EXPORT void vtkXMLWriterC_Delete(vtkXMLWriterC *self)
Delete the writer object.