VTK
vtkPLYWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPLYWriter.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 =========================================================================*/
37 #ifndef vtkPLYWriter_h
38 #define vtkPLYWriter_h
39 
40 #include "vtkIOPLYModule.h" // For export macro
41 #include "vtkWriter.h"
42 
43 class vtkScalarsToColors;
45 
46 #define VTK_LITTLE_ENDIAN 0
47 #define VTK_BIG_ENDIAN 1
48 
49 #define VTK_COLOR_MODE_DEFAULT 0
50 #define VTK_COLOR_MODE_UNIFORM_CELL_COLOR 1
51 #define VTK_COLOR_MODE_UNIFORM_POINT_COLOR 2
52 #define VTK_COLOR_MODE_UNIFORM_COLOR 3
53 #define VTK_COLOR_MODE_OFF 4
54 
55 class vtkPolyData;
56 
58 {
59 public:
60  static vtkPLYWriter *New();
62  void PrintSelf(ostream& os, vtkIndent indent);
63 
65 
68  vtkGetMacro(DataByteOrder,int);
70  {this->SetDataByteOrder(VTK_BIG_ENDIAN);}
72  {this->SetDataByteOrder(VTK_LITTLE_ENDIAN);}
74 
76 
89  vtkSetMacro(ColorMode,int);
90  vtkGetMacro(ColorMode,int);
92  {this->SetColorMode(VTK_COLOR_MODE_DEFAULT);}
94  {this->SetColorMode(VTK_COLOR_MODE_UNIFORM_CELL_COLOR);}
96  {this->SetColorMode(VTK_COLOR_MODE_UNIFORM_POINT_COLOR);}
97  void SetColorModeToUniformColor() //both cells and points are colored
98  {this->SetColorMode(VTK_COLOR_MODE_UNIFORM_COLOR);}
99  void SetColorModeToOff() //No color information is written
100  {this->SetColorMode(VTK_COLOR_MODE_OFF);}
102 
104 
105  vtkSetStringMacro(ArrayName);
106  vtkGetStringMacro(ArrayName);
108 
110 
111  vtkSetClampMacro(Component,int,0,VTK_INT_MAX);
112  vtkGetMacro(Component,int);
114 
116 
121 
123 
127  vtkSetVector3Macro(Color,unsigned char);
128  vtkGetVector3Macro(Color,unsigned char);
130 
132 
136 
138 
139  vtkSetStringMacro(FileName);
140  vtkGetStringMacro(FileName);
142 
144 
146  vtkGetMacro(FileType,int);
147  void SetFileTypeToASCII() {this->SetFileType(VTK_ASCII);};
148  void SetFileTypeToBinary() {this->SetFileType(VTK_BINARY);};
150 
151 protected:
154 
155  void WriteData();
157 
159  char *ArrayName;
163  unsigned char Color[3];
164 
165  char* FileName;
166 
167  int FileType;
168 
170 
171 private:
172  vtkPLYWriter(const vtkPLYWriter&); // Not implemented.
173  void operator=(const vtkPLYWriter&); // Not implemented.
174 };
175 
176 #endif
177 
vtkPLYWriter::SetDataByteOrderToBigEndian
void SetDataByteOrderToBigEndian()
Definition: vtkPLYWriter.h:69
vtkPLYWriter::SetColorModeToUniformColor
void SetColorModeToUniformColor()
Definition: vtkPLYWriter.h:97
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:132
vtkGetObjectMacro
#define vtkGetObjectMacro(name, type)
Definition: vtkSetGet.h:232
vtkPLYWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
VTK_BIG_ENDIAN
#define VTK_BIG_ENDIAN
Definition: vtkPLYWriter.h:47
vtkPLYWriter::SetColorModeToDefault
void SetColorModeToDefault()
Definition: vtkPLYWriter.h:91
vtkPLYWriter::Component
int Component
Definition: vtkPLYWriter.h:160
vtkSetVector3Macro
#define vtkSetVector3Macro(name, type)
Definition: vtkSetGet.h:287
vtkIdType
int vtkIdType
Definition: vtkType.h:275
vtkPLYWriter::WriteData
void WriteData()
vtkDataSetAttributes
represent and manipulate attribute data in a dataset
Definition: vtkDataSetAttributes.h:58
vtkPLYWriter::GetInput
vtkPolyData * GetInput()
vtkX3D::Color
@ Color
Definition: vtkX3D.h:46
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkPLYWriter::LookupTable
vtkScalarsToColors * LookupTable
Definition: vtkPLYWriter.h:162
vtkPLYWriter::vtkPLYWriter
vtkPLYWriter()
VTK_COLOR_MODE_UNIFORM_POINT_COLOR
#define VTK_COLOR_MODE_UNIFORM_POINT_COLOR
Definition: vtkPLYWriter.h:51
vtkPLYWriter
write Stanford PLY file format
Definition: vtkPLYWriter.h:58
vtkPLYWriter::DataByteOrder
int DataByteOrder
Definition: vtkPLYWriter.h:158
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkSetClampMacro
#define vtkSetClampMacro(name, type, min, max)
Definition: vtkSetGet.h:143
vtkGetVector3Macro
#define vtkGetVector3Macro(name, type)
Definition: vtkSetGet.h:304
vtkIOPLYModule.h
VTK_COLOR_MODE_OFF
#define VTK_COLOR_MODE_OFF
Definition: vtkPLYWriter.h:53
vtkPLYWriter::SetColorModeToUniformCellColor
void SetColorModeToUniformCellColor()
Definition: vtkPLYWriter.h:93
vtkPLYWriter::SetColorModeToUniformPointColor
void SetColorModeToUniformPointColor()
Definition: vtkPLYWriter.h:95
VTK_COLOR_MODE_UNIFORM_CELL_COLOR
#define VTK_COLOR_MODE_UNIFORM_CELL_COLOR
Definition: vtkPLYWriter.h:50
vtkgl::num
GLuint GLuint num
Definition: vtkgl.h:16907
vtkPLYWriter::New
static vtkPLYWriter * New()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkSetStringMacro
#define vtkSetStringMacro(name)
Definition: vtkSetGet.h:104
vtkWriter
abstract class to write data to file(s)
Definition: vtkWriter.h:45
VTK_COLOR_MODE_DEFAULT
#define VTK_COLOR_MODE_DEFAULT
Definition: vtkPLYWriter.h:49
VTK_ASCII
#define VTK_ASCII
Definition: vtkWriter.h:41
VTK_COLOR_MODE_UNIFORM_COLOR
#define VTK_COLOR_MODE_UNIFORM_COLOR
Definition: vtkPLYWriter.h:52
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:63
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
vtkPLYWriter::SetLookupTable
virtual void SetLookupTable(vtkScalarsToColors *)
vtkPLYWriter::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
vtkPLYWriter::~vtkPLYWriter
~vtkPLYWriter()
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkWriter.h
VTKIOPLY_EXPORT
#define VTKIOPLY_EXPORT
Definition: vtkIOPLYModule.h:15
vtkPLYWriter::SetColorModeToOff
void SetColorModeToOff()
Definition: vtkPLYWriter.h:99
vtkPLYWriter::ArrayName
char * ArrayName
Definition: vtkPLYWriter.h:159
vtkPLYWriter::GetInput
vtkPolyData * GetInput(int port)
vtkPLYWriter::SetFileTypeToASCII
void SetFileTypeToASCII()
Definition: vtkPLYWriter.h:147
vtkPLYWriter::ColorMode
int ColorMode
Definition: vtkPLYWriter.h:161
VTK_LITTLE_ENDIAN
#define VTK_LITTLE_ENDIAN
Definition: vtkPLYWriter.h:46
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkPLYWriter::FileName
char * FileName
Definition: vtkPLYWriter.h:165
vtkPLYWriter::FileType
int FileType
Definition: vtkPLYWriter.h:167
VTK_BINARY
#define VTK_BINARY
Definition: vtkWriter.h:42
vtkPLYWriter::GetColors
unsigned char * GetColors(vtkIdType num, vtkDataSetAttributes *dsa)
vtkPLYWriter::SetDataByteOrderToLittleEndian
void SetDataByteOrderToLittleEndian()
Definition: vtkPLYWriter.h:71
vtkPLYWriter::SetFileTypeToBinary
void SetFileTypeToBinary()
Definition: vtkPLYWriter.h:148