vtkBMPReader.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 vtkBMPReader_h
#define vtkBMPReader_h

#include "vtkIOImageModule.h" // For export macro
#include "vtkImageReader.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkLookupTable;

class VTKIOIMAGE_EXPORT vtkBMPReader : public vtkImageReader
{
public:
  static vtkBMPReader* New();
  vtkTypeMacro(vtkBMPReader, vtkImageReader);

  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetMacro(Depth, int);


  int CanReadFile(VTK_FILEPATH const char* fname) override;
  int CanReadFile(vtkResourceStream* stream) override;

  const char* GetFileExtensions() override { return ".bmp"; }

  const char* GetDescriptiveName() override { return "Windows BMP"; }


  vtkSetMacro(Allow8BitBMP, vtkTypeBool);
  vtkGetMacro(Allow8BitBMP, vtkTypeBool);
  vtkBooleanMacro(Allow8BitBMP, vtkTypeBool);

  vtkGetObjectMacro(LookupTable, vtkLookupTable);


  vtkGetMacro(Colors, unsigned char*);

protected:
  vtkBMPReader();
  ~vtkBMPReader() override;

  unsigned char* Colors = nullptr;
  short Depth = 0;
  bool Validated = false;
  vtkTypeBool Allow8BitBMP = false;
  vtkLookupTable* LookupTable;

  void ComputeDataIncrements() override;
  void ExecuteInformation() override;
  void ExecuteDataWithInformation(vtkDataObject* out, vtkInformation* outInfo) override;

private:
  vtkBMPReader(const vtkBMPReader&) = delete;
  void operator=(const vtkBMPReader&) = delete;

  bool ReadAndCheckHeader(
    vtkResourceStream* stream, bool quiet, vtkTypeInt32& offset, vtkTypeInt32& infoSize) const;
};
VTK_ABI_NAMESPACE_END
#endif