VTK  9.0.1
vtkPNGWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPNGWriter.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 =========================================================================*/
26 #ifndef vtkPNGWriter_h
27 #define vtkPNGWriter_h
28 
29 #include "vtkIOImageModule.h" // For export macro
30 #include "vtkImageWriter.h"
31 
32 class vtkImageData;
34 
35 class VTKIOIMAGE_EXPORT vtkPNGWriter : public vtkImageWriter
36 {
37 public:
38  static vtkPNGWriter* New();
39  vtkTypeMacro(vtkPNGWriter, vtkImageWriter);
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
45  void Write() override;
46 
48 
55  vtkSetClampMacro(CompressionLevel, int, 0, 9);
56  vtkGetMacro(CompressionLevel, int);
58 
60 
63  vtkSetMacro(WriteToMemory, vtkTypeUBool);
64  vtkGetMacro(WriteToMemory, vtkTypeUBool);
65  vtkBooleanMacro(WriteToMemory, vtkTypeUBool);
67 
69 
74  vtkGetObjectMacro(Result, vtkUnsignedCharArray);
76 
84  void AddText(const char* key, const char* value);
86 
89  static const char* TITLE;
90  static const char* AUTHOR;
91  static const char* DESCRIPTION;
92  static const char* COPYRIGHT;
93  static const char* CREATION_TIME;
94  static const char* SOFTWARE;
95  static const char* DISCLAIMER;
96  static const char* WARNING;
97  static const char* SOURCE;
98  static const char* COMMENT;
100 
101 protected:
103  ~vtkPNGWriter() override;
104 
105  void WriteSlice(vtkImageData* data, int* uExtent);
108  FILE* TempFP;
109  class vtkInternals;
110  vtkInternals* Internals;
111 
112 private:
113  vtkPNGWriter(const vtkPNGWriter&) = delete;
114  void operator=(const vtkPNGWriter&) = delete;
115 };
116 
117 #endif
vtkPNGWriter::WriteSlice
void WriteSlice(vtkImageData *data, int *uExtent)
vtkPNGWriter::DISCLAIMER
static const char * DISCLAIMER
Definition: vtkPNGWriter.h:95
vtkPNGWriter::Write
void Write() override
The main interface which triggers the writer to start.
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkImageWriter
Writes images to files.
Definition: vtkImageWriter.h:33
vtkX3D::data
@ data
Definition: vtkX3D.h:321
vtkPNGWriter::vtkPNGWriter
vtkPNGWriter()
vtkX3D::key
@ key
Definition: vtkX3D.h:263
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:36
vtkPNGWriter::SetResult
virtual void SetResult(vtkUnsignedCharArray *)
When writing to memory this is the result, it will be nullptr until the data is written the first tim...
vtkPNGWriter
Writes PNG files.
Definition: vtkPNGWriter.h:36
vtkPNGWriter::Result
vtkUnsignedCharArray * Result
Definition: vtkPNGWriter.h:107
vtkPNGWriter::COMMENT
static const char * COMMENT
Definition: vtkPNGWriter.h:98
vtkImageWriter.h
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:42
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkPNGWriter::Internals
vtkInternals * Internals
Definition: vtkPNGWriter.h:109
vtkPNGWriter::AddText
void AddText(const char *key, const char *value)
Adds a text chunk to the PNG.
vtkPNGWriter::COPYRIGHT
static const char * COPYRIGHT
Definition: vtkPNGWriter.h:92
vtkPNGWriter::~vtkPNGWriter
~vtkPNGWriter() override
vtkPNGWriter::WARNING
static const char * WARNING
Definition: vtkPNGWriter.h:96
vtkPNGWriter::AUTHOR
static const char * AUTHOR
Definition: vtkPNGWriter.h:90
vtkPNGWriter::DESCRIPTION
static const char * DESCRIPTION
Definition: vtkPNGWriter.h:91
vtkTypeUBool
unsigned int vtkTypeUBool
Definition: vtkABI.h:70
vtkPNGWriter::CREATION_TIME
static const char * CREATION_TIME
Definition: vtkPNGWriter.h:93
vtkPNGWriter::SOURCE
static const char * SOURCE
Definition: vtkPNGWriter.h:97
vtkPNGWriter::CompressionLevel
int CompressionLevel
Definition: vtkPNGWriter.h:106
vtkPNGWriter::TITLE
static const char * TITLE
Standard keys.
Definition: vtkPNGWriter.h:89
vtkPNGWriter::SOFTWARE
static const char * SOFTWARE
Definition: vtkPNGWriter.h:94
vtkPNGWriter::TempFP
FILE * TempFP
Definition: vtkPNGWriter.h:108
vtkPNGWriter::New
static vtkPNGWriter * New()
vtkPNGWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.