vtkImageActor.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 vtkImageActor_h
#define vtkImageActor_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkAlgorithm;
class vtkPropCollection;
class vtkRenderer;
class vtkImageData;

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

  static vtkImageActor* New();


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


  virtual void SetInterpolate(vtkTypeBool);
  virtual vtkTypeBool GetInterpolate();
  vtkBooleanMacro(Interpolate, vtkTypeBool);


  virtual void SetOpacity(double);
  virtual double GetOpacity();
  double GetOpacityMinValue() { return 0.0; }
  double GetOpacityMaxValue() { return 1.0; }


  void SetDisplayExtent(const int extent[6]);
  void SetDisplayExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ);
  void GetDisplayExtent(int extent[6]);
  int* GetDisplayExtent() VTK_SIZEHINT(6) { return this->DisplayExtent; }


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


  double* GetDisplayBounds() VTK_SIZEHINT(6);
  void GetDisplayBounds(double bounds[6]);


  int GetSliceNumber();
  int GetSliceNumberMax();
  int GetSliceNumberMin();


  void SetZSlice(int z)
  {
    this->SetDisplayExtent(this->DisplayExtent[0], this->DisplayExtent[1], this->DisplayExtent[2],
      this->DisplayExtent[3], z, z);
  }
  int GetZSlice() { return this->DisplayExtent[4]; }
  int GetWholeZMin();
  int GetWholeZMax();

  vtkTypeBool HasTranslucentPolygonalGeometry() override;


  vtkGetMacro(ForceOpaque, bool);
  vtkSetMacro(ForceOpaque, bool);
  vtkBooleanMacro(ForceOpaque, bool);

protected:
  vtkImageActor();
  ~vtkImageActor() override;

  static int GetOrientationFromExtent(const int extent[6]);

  int DisplayExtent[6];
  double DisplayBounds[6];

  // Convenience function that returns the input of the mapper
  vtkAlgorithm* GetInputAlgorithm();

  // the result of HasTranslucentPolygonalGeometry is cached
  vtkTimeStamp TranslucentComputationTime;
  int TranslucentCachedResult;
  bool ForceOpaque;

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

VTK_ABI_NAMESPACE_END
#endif