vtkVolumeRepresentation.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 vtkVolumeRepresentation_h
#define vtkVolumeRepresentation_h
 
#include "vtkDataRepresentation.h"
#include "vtkNew.h"                  // For ivars
#include "vtkViewsRenderingModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkColorTransferFunction;
class vtkPiecewiseFunction;
class vtkScalarBarActor;
class vtkSmartVolumeMapper;
class vtkVolume;
class vtkVolumeProperty;
 
class VTKVIEWSRENDERING_EXPORT vtkVolumeRepresentation : public vtkDataRepresentation
{
public:
  static vtkVolumeRepresentation* New();
  vtkTypeMacro(vtkVolumeRepresentation, vtkDataRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;


  void SetColorTransferFunction(vtkColorTransferFunction* ctf);
  vtkColorTransferFunction* GetColorTransferFunction();
  void SetScalarOpacity(vtkPiecewiseFunction* pf);
  vtkPiecewiseFunction* GetScalarOpacity();
  void SetScalarOpacityUnitDistance(double distance);
  double GetScalarOpacityUnitDistance();


  void ResetColorTransferFunction();
  void ResetScalarOpacity();
  void ResetTransferFunctions();


  void SetShade(bool val);
  bool GetShade();
  void SetAmbient(double val);
  double GetAmbient();
  void SetDiffuse(double val);
  double GetDiffuse();
  void SetSpecular(double val);
  double GetSpecular();
  void SetSpecularPower(double val);
  double GetSpecularPower();
  void SetInterpolationType(int val);
  int GetInterpolationType();


  void SetBlendMode(int mode);
  int GetBlendMode();
  void SetRequestedRenderMode(int mode);
  int GetRequestedRenderMode();


  void SetVisibility(bool val);
  bool GetVisibility();
  void SetPosition(double x, double y, double z);
  double* GetPosition() VTK_SIZEHINT(3);
  void SetOrientation(double x, double y, double z);
  double* GetOrientation() VTK_SIZEHINT(3);
  void SetScale(double x, double y, double z);
  double* GetScale() VTK_SIZEHINT(3);


  void SetScalarBarVisibility(bool val);
  bool GetScalarBarVisibility();
  vtkScalarBarActor* GetScalarBarActor();

  vtkVolume* GetVolume();
 
protected:
  vtkVolumeRepresentation();
  ~vtkVolumeRepresentation() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  bool AddToView(vtkView* view) override;
  bool RemoveFromView(vtkView* view) override;
 
private:
  vtkVolumeRepresentation(const vtkVolumeRepresentation&) = delete;
  void operator=(const vtkVolumeRepresentation&) = delete;
 
  void CreateDefaultTransferFunctions();
 
  vtkNew<vtkSmartVolumeMapper> VolumeMapper;
  vtkNew<vtkVolume> VolumeActor;
  vtkNew<vtkVolumeProperty> VolumeProperty;
  vtkNew<vtkScalarBarActor> ScalarBar;
  bool ScalarBarVisible;
  bool DefaultTransferFunctionsCreated;
  bool UserSetColorTransferFunction;
  bool UserSetScalarOpacity;
};
 
VTK_ABI_NAMESPACE_END
#endif