VTK
vtkXMLWriterC.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLWriterC.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 =========================================================================*/
15 #ifndef vtkXMLWriterC_h
16 #define vtkXMLWriterC_h
17 
18 #include "vtkIOXMLModule.h" // For export macro
19 #include "vtkType.h" /* For scalar and vtkDataObject type enumerations. */
20 
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif /*cplusplus*/
25 
30 typedef struct vtkXMLWriterC_s vtkXMLWriterC;
31 
36 VTKIOXML_EXPORT
38 
44 VTKIOXML_EXPORT
46 
54 VTKIOXML_EXPORT
55 void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC* self, int objType);
56 
65 VTKIOXML_EXPORT
66 void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC* self, int datamodetype);
67 
74 VTKIOXML_EXPORT
75 void vtkXMLWriterC_SetExtent(vtkXMLWriterC* self, int extent[6]);
76 
89 VTKIOXML_EXPORT
90 void vtkXMLWriterC_SetPoints(vtkXMLWriterC* self, int dataType,
91  void* data, vtkIdType numPoints);
92 
99 VTKIOXML_EXPORT
100 void vtkXMLWriterC_SetOrigin(vtkXMLWriterC* self, double origin[3]);
101 
108 VTKIOXML_EXPORT
109 void vtkXMLWriterC_SetSpacing(vtkXMLWriterC* self, double spacing[3]);
110 
123 VTKIOXML_EXPORT
124 void vtkXMLWriterC_SetCoordinates(vtkXMLWriterC* self, int axis,
125  int dataType, void* data,
126  vtkIdType numCoordinates);
127 
147 VTKIOXML_EXPORT
149  int cellType, vtkIdType ncells,
150  vtkIdType* cells, vtkIdType cellsSize);
151 
166 VTKIOXML_EXPORT
168  int* cellTypes, vtkIdType ncells,
169  vtkIdType* cells, vtkIdType cellsSize);
170 
194 VTKIOXML_EXPORT
195 void vtkXMLWriterC_SetPointData(vtkXMLWriterC* self, const char* name,
196  int dataType, void* data,
197  vtkIdType numTuples, int numComponents,
198  const char* role);
199 VTKIOXML_EXPORT
200 void vtkXMLWriterC_SetCellData(vtkXMLWriterC* self, const char* name,
201  int dataType, void* data,
202  vtkIdType numTuples, int numComponents,
203  const char* role);
204 
211 VTKIOXML_EXPORT
212 void vtkXMLWriterC_SetFileName(vtkXMLWriterC* self, const char* fileName);
213 
220 VTKIOXML_EXPORT
222 
230 VTKIOXML_EXPORT
231 void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC* self, int numTimeSteps);
232 
240 VTKIOXML_EXPORT
242 
253 VTKIOXML_EXPORT
254 void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC* self, double timeValue);
255 
262 VTKIOXML_EXPORT
264 
265 #ifdef __cplusplus
266 } /* extern "C" */
267 #endif /*cplusplus*/
268 
269 #endif
270 // VTK-HeaderTest-Exclude: vtkXMLWriterC.h
struct vtkXMLWriterC_s vtkXMLWriterC
vtkXMLWriterC is an opaque structure holding the state of an individual writer object.
Definition: vtkXMLWriterC.h:30
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_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.
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_Delete(vtkXMLWriterC *self)
Delete the writer object.
VTKIOXML_EXPORT void vtkXMLWriterC_SetPoints(vtkXMLWriterC *self, int dataType, void *data, vtkIdType numPoints)
Set the points of a point data set.
int vtkIdType
Definition: vtkType.h:287
VTKIOXML_EXPORT void vtkXMLWriterC_Start(vtkXMLWriterC *self)
Start writing a time-series to the output file.
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_SetOrigin(vtkXMLWriterC *self, double origin[3])
Set the origin of an image data set.
VTKIOXML_EXPORT void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC *self, int objType)
Set the VTK data object type that will be written.
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_SetDataModeType(vtkXMLWriterC *self, int datamodetype)
Set the VTK writer data mode to either:
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 vtkXMLWriterC * vtkXMLWriterC_New()
Create a new instance of vtkXMLWriterC.
CellTypeInDataSet cellType(vtkDataSet *input)
VTKIOXML_EXPORT void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC *self, double timeValue)
Write one time step of a time-series to the output file.
VTKIOXML_EXPORT void vtkXMLWriterC_SetExtent(vtkXMLWriterC *self, int extent[6])
Set the extent of a structured data set.
VTKIOXML_EXPORT void vtkXMLWriterC_SetCellData(vtkXMLWriterC *self, const char *name, int dataType, void *data, vtkIdType numTuples, int numComponents, const char *role)
VTKIOXML_EXPORT void vtkXMLWriterC_Stop(vtkXMLWriterC *self)
Stop writing a time-series to the output file.