VTK: IO/XML/vtkXMLWriterC.h Source File

| VTK 9.3.1

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
25 vtkXMLWriterC* vtkXMLWriterC_New();
26
32 VTKIOXML_EXPORT
33 void vtkXMLWriterC_Delete(vtkXMLWriterC* self);
34
42 VTKIOXML_EXPORT
43 void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC* self, int objType);
44
53 VTKIOXML_EXPORT
54 void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC* self, int datamodetype);
55
62 VTKIOXML_EXPORT
63 void vtkXMLWriterC_SetExtent(vtkXMLWriterC* self, int extent[6]);
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
96 void vtkXMLWriterC_SetSpacing(vtkXMLWriterC* self, double spacing[3]);
97
110 VTKIOXML_EXPORT
111 void vtkXMLWriterC_SetCoordinates(
112 vtkXMLWriterC* self, int axis, int dataType, void* data, vtkIdType numCoordinates);
113
133 VTKIOXML_EXPORT
134 void vtkXMLWriterC_SetCellsWithType(
135 vtkXMLWriterC* self, int cellType, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);
136
151 VTKIOXML_EXPORT
152 void vtkXMLWriterC_SetCellsWithTypes(
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
201 int vtkXMLWriterC_Write(vtkXMLWriterC* self);
202
210 VTKIOXML_EXPORT
211 void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC* self, int numTimeSteps);
212
220 VTKIOXML_EXPORT
221 void vtkXMLWriterC_Start(vtkXMLWriterC* self);
222
233 VTKIOXML_EXPORT
234 void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC* self, double timeValue);
235
242 VTKIOXML_EXPORT
243 void vtkXMLWriterC_Stop(vtkXMLWriterC* self);
244
245 #ifdef __cplusplus
246 } /* extern "C" */
247 #endif /*cplusplus*/
248
249 #endif
250 // VTK-HeaderTest-Exclude: vtkXMLWriterC.h
vtkX3D::extent
@ extent
Definition: vtkX3D.h:345
vtkX3D::spacing
@ spacing
Definition: vtkX3D.h:481
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkType.h
vtkIdType
int vtkIdType
Definition: vtkType.h:315
vtkXMLWriterC_SetDataModeType
VTKIOXML_EXPORT void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC *self, int datamodetype)
Set the VTK writer data mode to either:
vtkXMLWriterC_SetExtent
VTKIOXML_EXPORT void vtkXMLWriterC_SetExtent(vtkXMLWriterC *self, int extent[6])
Set the extent of a structured data set.
vtkXMLWriterC_SetCellsWithType
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.
vtkXMLWriterC_SetCellsWithTypes
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.
vtkXMLWriterC_SetOrigin
VTKIOXML_EXPORT void vtkXMLWriterC_SetOrigin(vtkXMLWriterC *self, double origin[3])
Set the origin of an image data set.
vtkXMLWriterC_Stop
VTKIOXML_EXPORT void vtkXMLWriterC_Stop(vtkXMLWriterC *self)
Stop writing a time-series to the output file.
vtkXMLWriterC_SetDataObjectType
VTKIOXML_EXPORT void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC *self, int objType)
Set the VTK data object type that will be written.
vtkXMLWriterC_Start
VTKIOXML_EXPORT void vtkXMLWriterC_Start(vtkXMLWriterC *self)
Start writing a time-series to the output file.
vtkXMLWriterC_SetCoordinates
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.
vtkXMLWriterC_SetNumberOfTimeSteps
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.
vtkXMLWriterC_SetCellData
VTKIOXML_EXPORT void vtkXMLWriterC_SetCellData(vtkXMLWriterC *self, const char *name, int dataType, void *data, vtkIdType numTuples, int numComponents, const char *role)
vtkXMLWriterC_Write
VTKIOXML_EXPORT int vtkXMLWriterC_Write(vtkXMLWriterC *self)
Write the data to a file immediately.
vtkXMLWriterC_SetSpacing
VTKIOXML_EXPORT void vtkXMLWriterC_SetSpacing(vtkXMLWriterC *self, double spacing[3])
Set the spacing of an image data set.
vtkXMLWriterC_SetFileName
VTKIOXML_EXPORT void vtkXMLWriterC_SetFileName(vtkXMLWriterC *self, const char *fileName)
Set the name of the file into which the data are to be written.
vtkXMLWriterC_SetPointData
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.
vtkXMLWriterC
struct vtkXMLWriterC_s vtkXMLWriterC
vtkXMLWriterC is an opaque structure holding the state of an individual writer object.
Definition: vtkXMLWriterC.h:18
vtkXMLWriterC_SetPoints
VTKIOXML_EXPORT void vtkXMLWriterC_SetPoints(vtkXMLWriterC *self, int dataType, void *data, vtkIdType numPoints)
Set the points of a point data set.
vtkXMLWriterC_WriteNextTimeStep
VTKIOXML_EXPORT void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC *self, double timeValue)
Write one time step of a time-series to the output file.
vtkXMLWriterC_New
VTKIOXML_EXPORT vtkXMLWriterC * vtkXMLWriterC_New()
Create a new instance of vtkXMLWriterC.
vtkXMLWriterC_Delete
VTKIOXML_EXPORT void vtkXMLWriterC_Delete(vtkXMLWriterC *self)
Delete the writer object.