vtkImageSliceMapper.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 vtkImageSliceMapper_h
#define vtkImageSliceMapper_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkCamera;
class vtkPoints;

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


  virtual void SetSliceNumber(int slice);
  virtual int GetSliceNumber();


  virtual int GetSliceNumberMinValue();
  virtual int GetSliceNumberMaxValue();


  vtkSetClampMacro(Orientation, int, 0, 2);
  vtkGetMacro(Orientation, int);
  void SetOrientationToI() { this->SetOrientation(0); }
  void SetOrientationToJ() { this->SetOrientation(1); }
  void SetOrientationToK() { this->SetOrientation(2); }
  // old methods
  void SetOrientationToX() { this->SetOrientation(0); }
  void SetOrientationToY() { this->SetOrientation(1); }
  void SetOrientationToZ() { this->SetOrientation(2); }


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


  vtkSetVector6Macro(CroppingRegion, int);
  vtkGetVector6Macro(CroppingRegion, int);

  void Render(vtkRenderer* renderer, vtkImageSlice* prop) override;

  void ReleaseGraphicsResources(vtkWindow*) override;

  vtkMTimeType GetMTime() override;


  double* GetBounds() override;
  void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }

  // return the bounds in index space
  void GetIndexBounds(double extent[6]) override;

  void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]) override;

  vtkTypeBool ProcessRequest(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;


  void SetDisplayExtent(const int extent[6])
  {
    this->DisplayExtent[0] = extent[0];
    this->DisplayExtent[1] = extent[1];
    this->DisplayExtent[2] = extent[2];
    this->DisplayExtent[3] = extent[3];
    this->DisplayExtent[4] = extent[4];
    this->DisplayExtent[5] = extent[5];
  }


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);

protected:
  vtkImageSliceMapper();
  ~vtkImageSliceMapper() override;

  void SetPoints(vtkPoints* points);
  vtkPoints* GetPoints() { return this->Points; }

  void SetExactPixelMatch(int v) { this->ExactPixelMatch = (v != 0); }

  void SetPassColorData(int v) { this->PassColorData = (v != 0); }

  int GetOrientationFromCamera(double const* propMatrix, vtkCamera* camera);

  int GetSliceFromCamera(double const* propMatrix, vtkCamera* camera);

  static void GetDimensionIndices(int orientation, int& xdim, int& ydim);

  int SliceNumber;
  int SliceNumberMinValue;
  int SliceNumberMaxValue;
  int Orientation;
  vtkTypeBool Cropping;
  int CroppingRegion[6];
  int DisplayExtent[6];
  int ExactPixelMatch;
  int PassColorData;
  vtkPoints* Points;

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

  int OutputPointsPrecision{ vtkAlgorithm::DesiredOutputPrecision::DEFAULT_PRECISION };

  friend class vtkImageResliceMapper;
};

VTK_ABI_NAMESPACE_END
#endif