vtkX3DExporterWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkX3DExporterWriter_h
#define vtkX3DExporterWriter_h
 
#include "vtkIOExportModule.h" // For export macro
#include "vtkObject.h"
 
// Forward declarations
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkUnsignedCharArray;
class vtkCellArray;
 
class VTKIOEXPORT_EXPORT vtkX3DExporterWriter : public vtkObject
{
public:
  vtkTypeMacro(vtkX3DExporterWriter, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual int OpenFile(const char* file) = 0;
 
  virtual int OpenStream() = 0;
 
 
  vtkSetMacro(WriteToOutputString, vtkTypeBool);
  vtkGetMacro(WriteToOutputString, vtkTypeBool);
  vtkBooleanMacro(WriteToOutputString, vtkTypeBool);
 
 
  vtkGetMacro(OutputStringLength, vtkIdType);
  vtkGetStringMacro(OutputString);
  unsigned char* GetBinaryOutputString()
  {
    return reinterpret_cast<unsigned char*>(this->OutputString);
  }
 
  char* RegisterAndGetOutputString();
 
  // Closes the file if open
  virtual void CloseFile() = 0;
  // Flush can be called optionally after some operations to
  // flush the buffer to the filestream. A writer not necessarily
  // implements this function
  virtual void Flush() {}
 
  virtual void StartDocument() = 0;
 
  virtual void EndDocument() = 0;
 
 
  virtual void StartNode(int nodeID) = 0;
  virtual void EndNode() = 0;
 
  virtual void SetField(int attributeID, const char* value, bool mfstring = false) = 0;
 
  virtual void SetField(int attributeID, int) = 0;
 
  virtual void SetField(int attributeID, float) = 0;
 
  virtual void SetField(int attributeID, double) = 0;
 
  virtual void SetField(int attributeID, bool) = 0;
 
  virtual void SetField(int attributeID, int type, const double* a) = 0;
 
  virtual void SetField(int attributeID, int type, vtkDataArray* a) = 0;
 
  virtual void SetField(int attributeID, const double* values, size_t size) = 0;
 
  virtual void SetField(int attributeID, const int* values, size_t size, bool image = false) = 0;
 
  /*
   * Sets the field specified with attributeID
   * of the active node to the given value.
   * The type of the field is specified with type
   * Supported types: MFString
   */
  // virtual void SetField(int attributeID, int type, std::string) = 0;
 
protected:
  vtkX3DExporterWriter();
  ~vtkX3DExporterWriter() override;
 
  char* OutputString;
  vtkIdType OutputStringLength;
  vtkTypeBool WriteToOutputString;
 
private:
  vtkX3DExporterWriter(const vtkX3DExporterWriter&) = delete;
  void operator=(const vtkX3DExporterWriter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif