vtkImageMapper.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 vtkImageMapper_h
#define vtkImageMapper_h

#include "vtkMapper2D.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkWindow;
class vtkViewport;
class vtkActor2D;
class vtkImageData;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkImageMapper : public vtkMapper2D
{
public:
  vtkTypeMacro(vtkImageMapper, vtkMapper2D);
  static vtkImageMapper* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;


  vtkSetMacro(ColorWindow, double);
  vtkGetMacro(ColorWindow, double);


  vtkSetMacro(ColorLevel, double);
  vtkGetMacro(ColorLevel, double);


  vtkSetMacro(ZSlice, int);
  vtkGetMacro(ZSlice, int);
  int GetWholeZMin();
  int GetWholeZMax();

  void RenderStart(vtkViewport* viewport, vtkActor2D* actor);

  virtual void RenderData(vtkViewport*, vtkImageData*, vtkActor2D*) {}


  double GetColorShift();
  double GetColorScale();

  // Public for templated functions. * *  Should remove this * *
  int DisplayExtent[6];


  virtual void SetInputData(vtkImageData* input);
  vtkImageData* GetInput();


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


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


  vtkSetVectorMacro(CustomDisplayExtents, int, 4);
  vtkGetVectorMacro(CustomDisplayExtents, int, 4);

protected:
  vtkImageMapper();
  ~vtkImageMapper() override;

  double ColorWindow;
  double ColorLevel;

  int PositionAdjustment[2];
  int ZSlice;
  vtkTypeBool UseCustomExtents;
  int CustomDisplayExtents[4];
  vtkTypeBool RenderToRectangle;

  int FillInputPortInformation(int, vtkInformation*) override;

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

VTK_ABI_NAMESPACE_END
#endif