VTK
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 =========================================================================*/
32 #ifndef vtkPNGWriter_h
33 #define vtkPNGWriter_h
34 
35 #include "vtkIOImageModule.h" // For export macro
36 #include "vtkImageWriter.h"
37 
38 class vtkImageData;
40 
41 class VTKIOIMAGE_EXPORT vtkPNGWriter : public vtkImageWriter
42 {
43 public:
44  static vtkPNGWriter *New();
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
51  void Write() override;
52 
54 
61  vtkSetClampMacro(CompressionLevel, int, 0, 9);
62  vtkGetMacro(CompressionLevel, int);
64 
66 
69  vtkSetMacro(WriteToMemory, vtkTypeUBool);
70  vtkGetMacro(WriteToMemory, vtkTypeUBool);
71  vtkBooleanMacro(WriteToMemory, vtkTypeUBool);
73 
75 
80  vtkGetObjectMacro(Result, vtkUnsignedCharArray);
82 
90  void AddText(const char* key, const char* value);
92 
95  static const char* TITLE;
96  static const char* AUTHOR;
97  static const char* DESCRIPTION;
98  static const char* COPYRIGHT;
99  static const char* CREATION_TIME;
100  static const char* SOFTWARE;
101  static const char* DISCLAIMER;
102  static const char* WARNING;
103  static const char* SOURCE;
104  static const char* COMMENT;
106 
107 protected:
109  ~vtkPNGWriter() override;
110 
111  void WriteSlice(vtkImageData *data, int* uExtent);
114  FILE *TempFP;
115  class vtkInternals;
116  vtkInternals* Internals;
117 
118 
119 private:
120  vtkPNGWriter(const vtkPNGWriter&) = delete;
121  void operator=(const vtkPNGWriter&) = delete;
122 };
123 
124 #endif
vtkPNGWriter::WriteSlice
void WriteSlice(vtkImageData *data, int *uExtent)
vtkPNGWriter::DISCLAIMER
static const char * DISCLAIMER
Definition: vtkPNGWriter.h:101
vtkPNGWriter::Write
void Write() override
The main interface which triggers the writer to start.
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkImageWriter
Writes images to files.
Definition: vtkImageWriter.h:36
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkPNGWriter::vtkPNGWriter
vtkPNGWriter()
vtkX3D::key
@ key
Definition: vtkX3D.h:257
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:42
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:42
vtkPNGWriter::Result
vtkUnsignedCharArray * Result
Definition: vtkPNGWriter.h:113
vtkPNGWriter::COMMENT
static const char * COMMENT
Definition: vtkPNGWriter.h:104
vtkImageWriter.h
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPNGWriter::Internals
vtkInternals * Internals
Definition: vtkPNGWriter.h:115
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:98
vtkPNGWriter::~vtkPNGWriter
~vtkPNGWriter() override
vtkPNGWriter::WARNING
static const char * WARNING
Definition: vtkPNGWriter.h:102
vtkPNGWriter::AUTHOR
static const char * AUTHOR
Definition: vtkPNGWriter.h:96
vtkPNGWriter::DESCRIPTION
static const char * DESCRIPTION
Definition: vtkPNGWriter.h:97
vtkTypeUBool
unsigned int vtkTypeUBool
Definition: vtkABI.h:70
vtkPNGWriter::CREATION_TIME
static const char * CREATION_TIME
Definition: vtkPNGWriter.h:99
vtkPNGWriter::SOURCE
static const char * SOURCE
Definition: vtkPNGWriter.h:103
vtkPNGWriter::CompressionLevel
int CompressionLevel
Definition: vtkPNGWriter.h:112
vtkPNGWriter::TITLE
static const char * TITLE
Standard keys.
Definition: vtkPNGWriter.h:95
vtkPNGWriter::SOFTWARE
static const char * SOFTWARE
Definition: vtkPNGWriter.h:100
vtkPNGWriter::TempFP
FILE * TempFP
Definition: vtkPNGWriter.h:114
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.