vtkPLYWriter.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 vtkPLYWriter_h
#define vtkPLYWriter_h

#include "vtkIOPLYModule.h"  // For export macro
#include "vtkSmartPointer.h" // For protected ivars
#include "vtkWriter.h"

#include <string> // For string parameter

VTK_ABI_NAMESPACE_BEGIN
class vtkDataSetAttributes;
class vtkPolyData;
class vtkScalarsToColors;
class vtkStringArray;
class vtkUnsignedCharArray;

#define VTK_LITTLE_ENDIAN 0
#define VTK_BIG_ENDIAN 1

#define VTK_COLOR_MODE_DEFAULT 0
#define VTK_COLOR_MODE_UNIFORM_CELL_COLOR 1
#define VTK_COLOR_MODE_UNIFORM_POINT_COLOR 2
#define VTK_COLOR_MODE_UNIFORM_COLOR 3
#define VTK_COLOR_MODE_OFF 4

#define VTK_TEXTURECOORDS_UV 0
#define VTK_TEXTURECOORDS_TEXTUREUV 1
#define VTK_TEXTURECOORDS_ST 2

class VTKIOPLY_EXPORT vtkPLYWriter : public vtkWriter
{
public:
  static vtkPLYWriter* New();
  vtkTypeMacro(vtkPLYWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(DataByteOrder, int, VTK_LITTLE_ENDIAN, VTK_BIG_ENDIAN);
  vtkGetMacro(DataByteOrder, int);
  void SetDataByteOrderToBigEndian() { this->SetDataByteOrder(VTK_BIG_ENDIAN); }
  void SetDataByteOrderToLittleEndian() { this->SetDataByteOrder(VTK_LITTLE_ENDIAN); }


  vtkSetMacro(WriteToOutputString, bool);
  vtkGetMacro(WriteToOutputString, bool);
  vtkBooleanMacro(WriteToOutputString, bool);
  const std::string& GetOutputString() const { return this->OutputString; }


  vtkSetMacro(WriteObjectInformation, bool);
  vtkGetMacro(WriteObjectInformation, bool);
  vtkBooleanMacro(WriteObjectInformation, bool);


  vtkSetMacro(ColorMode, int);
  vtkGetMacro(ColorMode, int);
  void SetColorModeToDefault() { this->SetColorMode(VTK_COLOR_MODE_DEFAULT); }
  void SetColorModeToUniformCellColor() { this->SetColorMode(VTK_COLOR_MODE_UNIFORM_CELL_COLOR); }
  void SetColorModeToUniformPointColor() { this->SetColorMode(VTK_COLOR_MODE_UNIFORM_POINT_COLOR); }
  void SetColorModeToUniformColor() // both cells and points are colored
  {
    this->SetColorMode(VTK_COLOR_MODE_UNIFORM_COLOR);
  }
  void SetColorModeToOff() // No color information is written
  {
    this->SetColorMode(VTK_COLOR_MODE_OFF);
  }


  vtkSetMacro(EnableAlpha, bool);
  vtkGetMacro(EnableAlpha, bool);
  vtkBooleanMacro(EnableAlpha, bool);


  vtkSetStringMacro(ArrayName);
  vtkGetStringMacro(ArrayName);


  vtkSetClampMacro(Component, int, 0, VTK_INT_MAX);
  vtkGetMacro(Component, int);


  virtual void SetLookupTable(vtkScalarsToColors*);
  vtkGetObjectMacro(LookupTable, vtkScalarsToColors);


  vtkSetVector3Macro(Color, unsigned char);
  vtkGetVector3Macro(Color, unsigned char);


  vtkSetMacro(Alpha, unsigned char);
  vtkGetMacro(Alpha, unsigned char);


  vtkPolyData* GetInput();
  vtkPolyData* GetInput(int port);


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);


  vtkSetClampMacro(FileType, int, VTK_ASCII, VTK_BINARY);
  vtkGetMacro(FileType, int);
  void SetFileTypeToASCII() { this->SetFileType(VTK_ASCII); }
  void SetFileTypeToBinary() { this->SetFileType(VTK_BINARY); }


  vtkSetClampMacro(TextureCoordinatesName, int, VTK_TEXTURECOORDS_UV, VTK_TEXTURECOORDS_ST);
  vtkGetMacro(TextureCoordinatesName, int);
  void SetTextureCoordinatesNameToUV() { this->SetTextureCoordinatesName(VTK_TEXTURECOORDS_UV); }
  void SetTextureCoordinatesNameToTextureUV()
  {
    this->SetTextureCoordinatesName(VTK_TEXTURECOORDS_TEXTUREUV);
  }
  void SetTextureCoordinatesNameToST() { this->SetTextureCoordinatesName(VTK_TEXTURECOORDS_ST); }

  void AddComment(const std::string& comment);

protected:
  vtkPLYWriter();
  ~vtkPLYWriter() override;

  bool WriteDataAndReturn() override;
  vtkSmartPointer<vtkUnsignedCharArray> GetColors(vtkIdType num, vtkDataSetAttributes* dsa);
  const float* GetTextureCoordinates(vtkIdType num, vtkDataSetAttributes* dsa);
  const float* GetNormals(vtkIdType num, vtkDataSetAttributes* dsa);

  int DataByteOrder;
  char* ArrayName;
  int Component;
  int ColorMode;
  vtkScalarsToColors* LookupTable;
  unsigned char Color[3];

  bool EnableAlpha;
  unsigned char Alpha;

  char* FileName;

  int FileType;
  int TextureCoordinatesName;

  vtkSmartPointer<vtkStringArray> HeaderComments;

  // Whether this object is writing to a string or a file.
  // Default is 0: write to file.
  bool WriteToOutputString;

  bool WriteObjectInformation;

  // The output string.
  std::string OutputString;

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

private:
  vtkPLYWriter(const vtkPLYWriter&) = delete;
  void operator=(const vtkPLYWriter&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif