vtkDataEncoder.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkDataEncoder.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkDataEncoder_h
#define vtkDataEncoder_h
 
#include "vtkDeprecation.h" // needed for exports
#include "vtkObject.h"
#include "vtkSmartPointer.h"  // needed for vtkSmartPointer
#include "vtkWebCoreModule.h" // needed for exports
#include <memory>             // for std::unique_ptr
 
class vtkUnsignedCharArray;
class vtkImageData;
 
class VTKWEBCORE_EXPORT vtkDataEncoder : public vtkObject
{
public:
  static vtkDataEncoder* New();
  vtkTypeMacro(vtkDataEncoder, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetMaxThreads(vtkTypeUInt32);
  vtkGetMacro(MaxThreads, vtkTypeUInt32);
 
  void Initialize();
 
  VTK_DEPRECATED_IN_9_1_0("replaced by Push")
  void PushAndTakeReference(vtkTypeUInt32 key, vtkImageData*& data, int quality, int encoding = 1);
 
  void Push(vtkTypeUInt32 key, vtkImageData* data, int quality, int encoding = 1);
 
  bool GetLatestOutput(vtkTypeUInt32 key, vtkSmartPointer<vtkUnsignedCharArray>& data);
 
  void Flush(vtkTypeUInt32 key);
 
  const char* EncodeAsBase64Png(vtkImageData* img, int compressionLevel = 5);
 
  const char* EncodeAsBase64Jpg(vtkImageData* img, int quality = 50);
 
  void Finalize();
 
protected:
  vtkDataEncoder();
  ~vtkDataEncoder() override;
 
  vtkTypeUInt32 MaxThreads;
 
private:
  vtkDataEncoder(const vtkDataEncoder&) = delete;
  void operator=(const vtkDataEncoder&) = delete;
 
  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
};
 
#endif