9.1/html/vtkXMLWriterC_8h_source.html

/*=========================================================================


  Program:   Visualization Toolkit

  Module:    vtkXMLWriterC.h


  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen

  All rights reserved.

  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.


     This software is distributed WITHOUT ANY WARRANTY; without even

     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

     PURPOSE.  See the above copyright notice for more information.


=========================================================================*/

#ifndef vtkXMLWriterC_h

#define vtkXMLWriterC_h


#include "vtkIOXMLModule.h" // For export macro

#include "vtkType.h"        /* For scalar and vtkDataObject type enumerations.  */


#ifdef __cplusplus

extern "C"

{

#endif /*cplusplus*/


  typedef struct vtkXMLWriterC_s vtkXMLWriterC;


  VTKIOXML_EXPORT

  vtkXMLWriterC* vtkXMLWriterC_New(void);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_Delete(vtkXMLWriterC* self);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetDataObjectType(vtkXMLWriterC* self, int objType);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC* self, int datamodetype);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetExtent(vtkXMLWriterC* self, int extent[6]);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetPoints(vtkXMLWriterC* self, int dataType, void* data, vtkIdType numPoints);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetOrigin(vtkXMLWriterC* self, double origin[3]);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetSpacing(vtkXMLWriterC* self, double spacing[3]);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetCoordinates(

    vtkXMLWriterC* self, int axis, int dataType, void* data, vtkIdType numCoordinates);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetCellsWithType(

    vtkXMLWriterC* self, int cellType, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetCellsWithTypes(

    vtkXMLWriterC* self, int* cellTypes, vtkIdType ncells, vtkIdType* cells, vtkIdType cellsSize);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetPointData(vtkXMLWriterC* self, const char* name, int dataType, void* data,

    vtkIdType numTuples, int numComponents, const char* role);

  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_SetFileName(vtkXMLWriterC* self, const char* fileName);


  VTKIOXML_EXPORT

  int vtkXMLWriterC_Write(vtkXMLWriterC* self);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_SetNumberOfTimeSteps(vtkXMLWriterC* self, int numTimeSteps);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_Start(vtkXMLWriterC* self);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_WriteNextTimeStep(vtkXMLWriterC* self, double timeValue);


  VTKIOXML_EXPORT

  void vtkXMLWriterC_Stop(vtkXMLWriterC* self);


#ifdef __cplusplus

} /* extern "C" */

#endif /*cplusplus*/


#endif

// VTK-HeaderTest-Exclude: vtkXMLWriterC.h

vtkType.h

vtkIdType
int vtkIdType
Definition: vtkType.h:332

vtkXMLWriterC_SetDataModeType
VTKIOXML_EXPORT void vtkXMLWriterC_SetDataModeType(vtkXMLWriterC *self, int datamodetype)
Set the VTK writer data mode to either:

vtkXMLWriterC_New
VTKIOXML_EXPORT vtkXMLWriterC * vtkXMLWriterC_New(void)
Create a new instance of vtkXMLWriterC.

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:30

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_Delete
VTKIOXML_EXPORT void vtkXMLWriterC_Delete(vtkXMLWriterC *self)
Delete the writer object.