ImageWriterBase.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt 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 viskores_io_ImageWriterBase_h
#define viskores_io_ImageWriterBase_h
 
#include <viskores/cont/DataSet.h>
 
#include <viskores/io/viskores_io_export.h>
 
namespace viskores
{
namespace io
{
 
class VISKORES_IO_EXPORT ImageWriterBase
{
public:
  using ColorArrayType = viskores::cont::ArrayHandle<viskores::Vec4f_32>;
 
  VISKORES_CONT ImageWriterBase(const char* filename);
  VISKORES_CONT ImageWriterBase(const std::string& filename);
  VISKORES_CONT virtual ~ImageWriterBase() noexcept;
  ImageWriterBase(const ImageWriterBase&) = delete;
  ImageWriterBase& operator=(const ImageWriterBase&) = delete;
 
  VISKORES_CONT virtual void WriteDataSet(const viskores::cont::DataSet& dataSet,
                                          const std::string& colorField = {});
 
  enum class PixelDepth
  {
    PIXEL_8,
    PIXEL_16
  };
 
  VISKORES_CONT PixelDepth GetPixelDepth() const { return this->Depth; }
  VISKORES_CONT void SetPixelDepth(PixelDepth depth) { this->Depth = depth; }
 
  VISKORES_CONT const std::string& GetFileName() const { return this->FileName; }
  VISKORES_CONT void SetFileName(const std::string& filename) { this->FileName = filename; }
 
protected:
  std::string FileName;
  PixelDepth Depth = PixelDepth::PIXEL_8;
 
  VISKORES_CONT virtual void Write(viskores::Id width,
                                   viskores::Id height,
                                   const ColorArrayType& pixels) = 0;
};
}
}
 
#endif //viskores_io_ImageWriterBase_h