vtkVolumeRepresentation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkVolumeRepresentation_h
#define vtkVolumeRepresentation_h
 
#include "vtkPVDataRepresentation.h"
 
#include "vtkNew.h"                 // for vtkNew
#include "vtkPVLODVolume.h"         // for ivars
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSmartPointer.h"        //needed for vtkSmartPointer
 
class vtkColorTransferFunction;
class vtkDataSet;
class vtkOutlineSource;
class vtkPiecewiseFunction;
class vtkVolumeProperty;
 
class VTKREMOTINGVIEWS_EXPORT vtkVolumeRepresentation : public vtkPVDataRepresentation
{
public:
  vtkTypeMacro(vtkVolumeRepresentation, vtkPVDataRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetVisibility(bool val) override;
 
  //***************************************************************************
  // Forwarded to Actor.
  void SetOrientation(double, double, double);
  void SetOrigin(double, double, double);
  void SetPickable(int val);
  void SetPosition(double, double, double);
  void SetScale(double, double, double);
 
  //***************************************************************************
  // Forwarded to vtkVolumeProperty and vtkProperty (when applicable).
  void SetInterpolationType(int val);
  void SetColor(vtkColorTransferFunction* lut);
  void SetScalarOpacity(vtkPiecewiseFunction* pwf);
  void SetScalarOpacityUnitDistance(double val);
  void SetMapScalars(bool);
  void SetMultiComponentsMapping(bool);
 
  //***************************************************************************
  // For separate opacity array support
  void SetUseSeparateOpacityArray(bool);
  void SelectOpacityArray(int, int, int, int, const char* name);
  void SelectOpacityArrayComponent(int component);
 
  vtkPVLODVolume* GetActor() { return this->Actor; }
 
protected:
  vtkVolumeRepresentation();
  ~vtkVolumeRepresentation() override;
 
  vtkNew<vtkVolumeProperty> Property;
  vtkSmartPointer<vtkPVLODVolume> Actor;
  vtkNew<vtkOutlineSource> OutlineSource;
 
  unsigned long DataSize = 0;
  double DataBounds[6];
 
  bool MapScalars = true;
  bool MultiComponentsMapping = false;
 
  bool UseSeparateOpacityArray = false;
  std::string OpacityArrayName;
  int OpacityArrayFieldAssociation = -1;
  int OpacityArrayComponent = -1;
 
  bool AppendOpacityComponent(vtkDataSet* dataset);
 
private:
  vtkVolumeRepresentation(const vtkVolumeRepresentation&) = delete;
  void operator=(const vtkVolumeRepresentation&) = delete;
};
 
#endif // vtkVolumeRepresentation_h