vtkAbstractVolumeMapper.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 vtkAbstractVolumeMapper_h
#define vtkAbstractVolumeMapper_h
 
#include "vtkAbstractMapper3D.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkVolume;
class vtkWindow;
class vtkDataSet;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkAbstractVolumeMapper : public vtkAbstractMapper3D
{
public:
  vtkTypeMacro(vtkAbstractVolumeMapper, vtkAbstractMapper3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual vtkDataSet* GetDataSetInput();
  virtual vtkDataObject* GetDataObjectInput();
 
 
  double* GetBounds() VTK_SIZEHINT(6) override;
  void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }
 
 
  vtkSetMacro(ScalarMode, int);
  vtkGetMacro(ScalarMode, int);
  vtkSetMacro(ArrayAccessMode, int);
  void SetScalarModeToDefault() { this->SetScalarMode(VTK_SCALAR_MODE_DEFAULT); }
  void SetScalarModeToUsePointData() { this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_DATA); }
  void SetScalarModeToUseCellData() { this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_DATA); }
  void SetScalarModeToUsePointFieldData()
  {
    this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_FIELD_DATA);
  }
  void SetScalarModeToUseCellFieldData()
  {
    this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_FIELD_DATA);
  }
 
 
  virtual void SelectScalarArray(int arrayNum);
  virtual void SelectScalarArray(const char* arrayName);
 
  virtual char* GetArrayName() { return this->ArrayName; }
  virtual int GetArrayId() { return this->ArrayId; }
  virtual int GetArrayAccessMode() { return this->ArrayAccessMode; }
 
  const char* GetScalarModeAsString();
 
 
  virtual float GetGradientMagnitudeScale() { return 1.0f; }
  virtual float GetGradientMagnitudeBias() { return 0.0f; }
  virtual float GetGradientMagnitudeScale(int) { return 1.0f; }
  virtual float GetGradientMagnitudeBias(int) { return 0.0f; }
 
  virtual void Render(vtkRenderer* ren, vtkVolume* vol) = 0;
 
  void ReleaseGraphicsResources(vtkWindow*) override {}
 
protected:
  vtkAbstractVolumeMapper();
  ~vtkAbstractVolumeMapper() override;
 
  // see algorithm for more info
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int ScalarMode;
  char* ArrayName;
  int ArrayId;
  int ArrayAccessMode;
 
private:
  vtkAbstractVolumeMapper(const vtkAbstractVolumeMapper&) = delete;
  void operator=(const vtkAbstractVolumeMapper&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif