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 "vtkNew.h" // For ivars
#include "vtkScivisDataRepresentation.h"
#include "vtkViewsScivisModule.h" // For export macro
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkColorTransferFunction;
class vtkDataArray;
class vtkDataSet;
class vtkPiecewiseFunction;
class vtkScalarsToColors;
class vtkSmartVolumeMapper;
class vtkVolume;
class vtkVolumeProperty;
 
class VTKVIEWSSCIVIS_EXPORT VTK_MARSHALAUTO vtkVolumeRepresentation
  : public vtkScivisDataRepresentation
{
public:
  static vtkVolumeRepresentation* New();
  vtkTypeMacro(vtkVolumeRepresentation, vtkScivisDataRepresentation);
  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 ColorByPointArray(const char* arrayName);
  void ColorByCellArray(const char* arrayName);
  void ResetColorArray();


  void SetColorMap(vtkScalarsToColors* map) override;
  void SetVisibility(bool val) override;
  bool GetVisibility() override;
  bool GetBounds(double bounds[6]) override;
  const char* GetRenderedArrayName() override;
  int GetRenderedFieldAssociation() override;
  bool GetDataRange(
    const char* arrayName, int fieldAssoc, double range[2], int component = -1) override;
  vtkScalarsToColors* GetColorMap() override;


  vtkVolume* GetVolume();
  vtkVolumeProperty* GetVolumeProperty();
  vtkSmartVolumeMapper* GetVolumeMapper();
 
protected:
  vtkVolumeRepresentation();
  ~vtkVolumeRepresentation() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  bool AddToView(vtkScivisView* view) override;
  bool RemoveFromView(vtkScivisView* view) override;
 
private:
  vtkVolumeRepresentation(const vtkVolumeRepresentation&) = delete;
  void operator=(const vtkVolumeRepresentation&) = delete;

  void CreateDefaultTransferFunctions();

  vtkDataSet* GetInputDataSet();

  vtkDataArray* GetRenderedScalars(int& fieldAssoc);

  bool IsColoringBy(const char* arrayName, int scalarMode);
 
  vtkNew<vtkSmartVolumeMapper> VolumeMapper;
  vtkNew<vtkVolume> Volume;
  vtkNew<vtkVolumeProperty> VolumeProperty;
  bool DefaultTransferFunctionsCreated;
  bool UserSetColorTransferFunction;
  bool UserSetScalarOpacity;
};
 
VTK_ABI_NAMESPACE_END
#endif