vtkSTLWriter.h 3.25 KB
Newer Older
Will Schroeder's avatar
Will Schroeder committed
1 2
/*=========================================================================

Ken Martin's avatar
Ken Martin committed
3
  Program:   Visualization Toolkit
Ken Martin's avatar
Ken Martin committed
4
  Module:    vtkSTLWriter.h
Will Schroeder's avatar
Will Schroeder committed
5

6
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 8
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Ken Martin's avatar
Ken Martin committed
9

10 11
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12
     PURPOSE.  See the above copyright notice for more information.
Will Schroeder's avatar
Will Schroeder committed
13 14

=========================================================================*/
15 16 17 18 19
/**
 * @class   vtkSTLWriter
 * @brief   write stereo lithography files
 *
 * vtkSTLWriter writes stereo lithography (.stl) files in either ASCII or
20 21 22 23
 * binary form. Stereo lithography files contain only triangles. Since VTK 8.1,
 * this writer converts non-triangle polygons into triangles, so there is no
 * longer a need to use vtkTriangleFilter prior to using this writer if the
 * input contains polygons with more than three vertices.
24 25 26 27 28
 *
 * @warning
 * Binary files written on one system may not be readable on other systems.
 * vtkSTLWriter uses VAX or PC byte ordering and swaps bytes on other systems.
*/
Will Schroeder's avatar
Will Schroeder committed
29

30 31
#ifndef vtkSTLWriter_h
#define vtkSTLWriter_h
Will Schroeder's avatar
Will Schroeder committed
32

33
#include "vtkIOGeometryModule.h" // For export macro
34
#include "vtkWriter.h"
Will Schroeder's avatar
Will Schroeder committed
35

36 37 38
class vtkCellArray;
class vtkPoints;
class vtkPolyData;
39
class vtkUnsignedCharArray;
40 41

class VTKIOGEOMETRY_EXPORT vtkSTLWriter : public vtkWriter
Will Schroeder's avatar
Will Schroeder committed
42 43
{
public:
44
  static vtkSTLWriter *New();
45
  vtkTypeMacro(vtkSTLWriter,vtkWriter);
46
  void PrintSelf(ostream& os, vtkIndent indent) override;
Will Schroeder's avatar
Will Schroeder committed
47

48 49 50 51
  //@{
  /**
   * Get the input to this writer.
   */
52 53
  vtkPolyData* GetInput();
  vtkPolyData* GetInput(int port);
54
  //@}
55

56 57 58 59
  //@{
  /**
   * Specify file name of vtk polygon data file to write.
   */
60 61
  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);
62
  //@}
63

64 65
  //@{
  /**
66 67
   * Set the header for the file as text. The header cannot contain 0x00 characters.
   * \sa SetBinaryHeader()
68
   */
69 70
  vtkSetStringMacro(Header);
  vtkGetStringMacro(Header);
71
  //@}
72

73 74 75 76 77 78 79 80 81 82 83
  //@{
  /**
  * Set binary header for the file.
  * Binary header is only used when writing binary type files.
  * If both Header and BinaryHeader are specified then BinaryHeader is used.
  * Maximum length of binary header is 80 bytes, any content over this limit is ignored.
  */
  virtual void SetBinaryHeader(vtkUnsignedCharArray* binaryHeader);
  vtkGetObjectMacro(BinaryHeader, vtkUnsignedCharArray);
  //@}

84 85 86 87
  //@{
  /**
   * Specify file type (ASCII or BINARY) for vtk data file.
   */
88 89 90 91
  vtkSetClampMacro(FileType,int,VTK_ASCII,VTK_BINARY);
  vtkGetMacro(FileType,int);
  void SetFileTypeToASCII() {this->SetFileType(VTK_ASCII);};
  void SetFileTypeToBinary() {this->SetFileType(VTK_BINARY);};
92
  //@}
93

Will Schroeder's avatar
Will Schroeder committed
94
protected:
95
  vtkSTLWriter();
96
  ~vtkSTLWriter() override;
97

98
  void WriteData() override;
Will Schroeder's avatar
Will Schroeder committed
99

100 101 102 103
  void WriteBinarySTL(
    vtkPoints *pts, vtkCellArray *polys, vtkCellArray *strips);
  void WriteAsciiSTL(
    vtkPoints *pts, vtkCellArray *polys, vtkCellArray *strips);
104

105
  char *FileName;
106
  char *Header;
107
  vtkUnsignedCharArray *BinaryHeader;
108
  int   FileType;
109

110
  int FillInputPortInformation(int port, vtkInformation *info) override;
111

112
private:
113 114
  vtkSTLWriter(const vtkSTLWriter&) = delete;
  void operator=(const vtkSTLWriter&) = delete;
Will Schroeder's avatar
Will Schroeder committed
115 116 117 118
};

#endif