vtkImageCompressor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkImageCompressor_h
#define vtkImageCompressor_h

#include "vtkObject.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro

class vtkUnsignedCharArray;
class vtkMultiProcessStream;

class VTKPVVTKEXTENSIONSFILTERSRENDERING_EXPORT vtkImageCompressor : public vtkObject
{
public:
  vtkTypeMacro(vtkImageCompressor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetInput(vtkUnsignedCharArray* input);
  vtkGetObjectMacro(Input, vtkUnsignedCharArray);


  vtkGetObjectMacro(Output, vtkUnsignedCharArray);
  void SetOutput(vtkUnsignedCharArray*);


  vtkSetMacro(LossLessMode, int);
  vtkGetMacro(LossLessMode, int);

  virtual int Compress() = 0;

  virtual int Decompress() = 0;

  virtual void SetImageResolution(int width, int height);

  virtual void SaveConfiguration(vtkMultiProcessStream* stream);

  virtual bool RestoreConfiguration(vtkMultiProcessStream* stream);

  virtual const char* SaveConfiguration();

  virtual const char* RestoreConfiguration(const char* stream);

protected:

  vtkImageCompressor();
  ~vtkImageCompressor() override;

  // This is the array which contains the compressed data.
  vtkUnsignedCharArray* Output;
  vtkUnsignedCharArray* Input;

  int LossLessMode;

  vtkSetStringMacro(Configuration);
  char* Configuration;

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

#endif