vtkImageMapper3D.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 vtkImageMapper3D_h
#define vtkImageMapper3D_h

#include "vtkAbstractMapper3D.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkThreads.h"             // for VTK_MAX_THREADS
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkProp3D;
class vtkPoints;
class vtkMatrix4x4;
class vtkLookupTable;
class vtkScalarsToColors;
class vtkImageSlice;
class vtkImageProperty;
class vtkImageData;
class vtkMultiThreader;
class vtkImageToImageMapper3DFriendship;

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

  virtual void Render(vtkRenderer* renderer, vtkImageSlice* prop) = 0;

  void ReleaseGraphicsResources(vtkWindow*) override = 0;


  void SetInputData(vtkImageData* input);
  vtkImageData* GetInput();
  vtkDataSet* GetDataSetInput();
  vtkDataObject* GetDataObjectInput();


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


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


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


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


  vtkGetObjectMacro(SlicePlane, vtkPlane);

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


  vtkSetClampMacro(NumberOfThreads, int, 1, VTK_MAX_THREADS);
  vtkGetMacro(NumberOfThreads, int);


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

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

protected:
  vtkImageMapper3D();
  ~vtkImageMapper3D() override;


  int FillInputPortInformation(int port, vtkInformation* info) override;
  int FillOutputPortInformation(int port, vtkInformation* info) override;

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

  static void CheckerboardRGBA(unsigned char* data, int xsize, int ysize, double originx,
    double originy, double spacingx, double spacingy);

  unsigned char* MakeTextureData(vtkImageProperty* property, vtkImageData* input, int extent[6],
    int& xsize, int& ysize, int& bytesPerPixel, bool& reuseTexture, bool& reuseData);

  void MakeTextureGeometry(const int extent[6], double coords[12], double tcoords[8]);

  virtual void ComputeTextureSize(
    const int extent[6], int& xdim, int& ydim, int imageSize[2], int textureSize[2]);

  vtkRenderer* GetCurrentRenderer();

  vtkImageSlice* GetCurrentProp() { return this->CurrentProp; }

  vtkMatrix4x4* GetDataToWorldMatrix();

  void GetBackgroundColor(vtkImageProperty* property, double color[4]);

  vtkTypeBool Border;
  vtkTypeBool Background;
  vtkScalarsToColors* DefaultLookupTable;
  vtkMultiThreader* Threader;
  int NumberOfThreads;
  vtkTypeBool Streaming;

  // The slice.
  vtkPlane* SlicePlane;
  vtkTypeBool SliceAtFocalPoint;
  vtkTypeBool SliceFacesCamera;

  // Information about the image, updated by UpdateInformation
  double DataSpacing[3];
  double DataOrigin[3];
  double DataDirection[9];
  int DataWholeExtent[6];

  // Set by vtkImageStack when doing multi-pass rendering
  bool MatteEnable;
  bool ColorEnable;
  bool DepthEnable;

private:
  // The prop this mapper is attached to, or zero if none.
  vtkImageSlice* CurrentProp;
  vtkRenderer* CurrentRenderer;

  // The cached data-to-world matrix
  vtkMatrix4x4* DataToWorldMatrix;

  vtkImageMapper3D(const vtkImageMapper3D&) = delete;
  void operator=(const vtkImageMapper3D&) = delete;

  friend class vtkImageToImageMapper3DFriendship;
};

VTK_ABI_NAMESPACE_END
#endif