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 "vtkType.h" /* For scalar and vtkDataObject type enumerations. */
19 
20 /* Define the export macro. */
21 #if defined(_WIN32) && defined(VTK_BUILD_SHARED_LIBS)
22 # if defined(vtkIO_EXPORTS)
23 # define VTK_XML_EXPORT __declspec(dllexport)
24 # else
25 # define VTK_XML_EXPORT __declspec(dllimport)
26 # endif
27 #else
28 # define VTK_XML_EXPORT
29 #endif
30 
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #endif /*cplusplus*/
35 
40 typedef struct vtkXMLWriterC_s vtkXMLWriterC;
41 
48 
56 
65 void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC* self, int objType);
66 
76 void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC* self, int datamodetype);
77 
85 void vtkXMLWriterC_SetExtent(vtkXMLWriterC* self, int extent[6]);
86 
100 void vtkXMLWriterC_SetPoints(vtkXMLWriterC* self, int dataType,
101  void* data, vtkIdType numPoints);
102 
110 void vtkXMLWriterC_SetOrigin(vtkXMLWriterC* self, double origin[3]);
111 
119 void vtkXMLWriterC_SetSpacing(vtkXMLWriterC* self, double spacing[3]);
120 
134 void vtkXMLWriterC_SetCoordinates(vtkXMLWriterC* self, int axis,
135  int dataType, void* data,
136  vtkIdType numCoordinates);
137 
159  int cellType, vtkIdType ncells,
160  vtkIdType* cells, vtkIdType cellsSize);
161 
178  int* cellTypes, vtkIdType ncells,
179  vtkIdType* cells, vtkIdType cellsSize);
180 
205 void vtkXMLWriterC_SetPointData(vtkXMLWriterC* self, const char* name,
206  int dataType, void* data,
207  vtkIdType numTuples, int numComponents,
208  const char* role);
210 void vtkXMLWriterC_SetCellData(vtkXMLWriterC* self, const char* name,
211  int dataType, void* data,
212  vtkIdType numTuples, int numComponents,
213  const char* role);
214 
222 void vtkXMLWriterC_SetFileName(vtkXMLWriterC* self, const char* fileName);
223 
232 
241 void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC* self, int numTimeSteps);
242 
252 
264 void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC* self, double timeValue);
265 
274 
275 #ifdef __cplusplus
276 } /* extern "C" */
277 #endif /*cplusplus*/
278 
279 /* Done with export macro. */
280 #undef VTK_XML_EXPORT
281 
282 #endif
struct vtkXMLWriterC_s vtkXMLWriterC
vtkXMLWriterC is an opaque structure holding the state of an individual writer object.
Definition: vtkXMLWriterC.h:40
VTK_XML_EXPORT int vtkXMLWriterC_Write(vtkXMLWriterC *self)
Write the data to a file immediately.
VTK_XML_EXPORT void vtkXMLWriterC_SetFileName(vtkXMLWriterC *self, const char *fileName)
Set the name of the file into which the data are to be written.
VTK_XML_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.
VTK_XML_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:255
VTK_XML_EXPORT void vtkXMLWriterC_Start(vtkXMLWriterC *self)
Start writing a time-series to the output file.
VTK_XML_EXPORT void vtkXMLWriterC_SetExtent(vtkXMLWriterC *self, int extent[6])
Set the extent of a structured data set.
VTK_XML_EXPORT void vtkXMLWriterC_Stop(vtkXMLWriterC *self)
Stop writing a time-series to the output file.
VTK_XML_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.
VTK_XML_EXPORT vtkXMLWriterC * vtkXMLWriterC_New()
Create a new instance of vtkXMLWriterC.
VTK_XML_EXPORT void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC *self, double timeValue)
Write one time step of a time-series to the output file.
VTK_XML_EXPORT void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC *self, int objType)
Set the VTK data object type that will be written.
VTK_XML_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.
VTK_XML_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.
VTK_XML_EXPORT void vtkXMLWriterC_SetCellData(vtkXMLWriterC *self, const char *name, int dataType, void *data, vtkIdType numTuples, int numComponents, const char *role)
VTK_XML_EXPORT void vtkXMLWriterC_SetSpacing(vtkXMLWriterC *self, double spacing[3])
Set the spacing of an image data set.
VTK_XML_EXPORT void vtkXMLWriterC_Delete(vtkXMLWriterC *self)
Delete the writer object.
#define VTK_XML_EXPORT
Definition: vtkXMLWriterC.h:28
VTK_XML_EXPORT void vtkXMLWriterC_SetOrigin(vtkXMLWriterC *self, double origin[3])
Set the origin of an image data set.
VTK_XML_EXPORT void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC *self, int datamodetype)
Set the VTK writer data mode to either:
VTK_XML_EXPORT void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC *self, int numTimeSteps)
Set the number of time steps that will be written between upcoming Start and Stop calls...