vtkSurfaceRepresentation.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 vtkSurfaceRepresentation_h
#define vtkSurfaceRepresentation_h
 
#include "vtkDataRepresentation.h"
#include "vtkNew.h"                  // For ivars
#include "vtkViewsRenderingModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkCompositePolyDataMapper;
class vtkExtractSelection;
class vtkGeometryFilterDispatcher;
class vtkProperty;
class vtkScalarBarActor;
class vtkScalarsToColors;
class vtkSelection;
 
class VTKVIEWSRENDERING_EXPORT vtkSurfaceRepresentation : public vtkDataRepresentation
{
public:
  static vtkSurfaceRepresentation* New();
  vtkTypeMacro(vtkSurfaceRepresentation, vtkDataRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;

  enum RepresentationType
  {
    POINTS = 0,
    WIREFRAME = 1,
    SURFACE = 2,
    SURFACE_WITH_EDGES = 3,
    OUTLINE = 4,
    FEATURE_EDGES = 5
  };


  void SetRepresentation(int type);
  int GetRepresentation();
  void SetRepresentationToPoints() { this->SetRepresentation(POINTS); }
  void SetRepresentationToWireframe() { this->SetRepresentation(WIREFRAME); }
  void SetRepresentationToSurface() { this->SetRepresentation(SURFACE); }
  void SetRepresentationToSurfaceWithEdges() { this->SetRepresentation(SURFACE_WITH_EDGES); }
  void SetRepresentationToOutline() { this->SetRepresentation(OUTLINE); }
  void SetRepresentationToFeatureEdges() { this->SetRepresentation(FEATURE_EDGES); }
  const char* GetRepresentationAsString();


  void SetColor(double r, double g, double b);
  double* GetColor() VTK_SIZEHINT(3);
  void SetOpacity(double val);
  double GetOpacity();
  void SetEdgeColor(double r, double g, double b);
  double* GetEdgeColor() VTK_SIZEHINT(3);
  void SetEdgeOpacity(double val);
  double GetEdgeOpacity();
  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 SetLineWidth(double val);
  double GetLineWidth();
  void SetPointSize(double val);
  double GetPointSize();
  void SetLighting(bool val);
  bool GetLighting();
  void SetInterpolation(int val);
  int GetInterpolation();
  void SetRenderPointsAsSpheres(bool val);
  bool GetRenderPointsAsSpheres();
  void SetRenderLinesAsTubes(bool val);
  bool GetRenderLinesAsTubes();
  void SetRoughness(double val);
  double GetRoughness();
  void SetMetallic(double val);
  double GetMetallic();


  void SetScalarVisibility(bool val);
  bool GetScalarVisibility();
  void ColorByPointArray(const char* arrayName);
  void ColorByPointArray(const char* arrayName, int component);
  void ColorByCellArray(const char* arrayName);
  void ColorByCellArray(const char* arrayName, int component);
  void ColorByFieldArray(const char* arrayName);
  void ColorByFieldArray(const char* arrayName, int component);
  void SetLookupTable(vtkScalarsToColors* lut);
  vtkScalarsToColors* GetLookupTable();
  void SetInterpolateScalarsBeforeMapping(bool val);
  bool GetInterpolateScalarsBeforeMapping();


  void SetFieldDataTupleId(vtkIdType id);
  vtkIdType GetFieldDataTupleId();


  void SetGeneratePointNormals(bool val);
  bool GetGeneratePointNormals();
  void SetGenerateCellNormals(bool val);
  bool GetGenerateCellNormals();
  void SetFeatureAngle(double val);
  double GetFeatureAngle();
  void SetSplitting(bool val);
  bool GetSplitting();


  void SetTriangulate(bool val);
  bool GetTriangulate();
  void SetNonlinearSubdivisionLevel(int val);
  int GetNonlinearSubdivisionLevel();
  void SetMatchBoundariesIgnoringCellOrder(bool val);
  bool GetMatchBoundariesIgnoringCellOrder();


  void SetPassThroughCellIds(bool val);
  bool GetPassThroughCellIds();
  void SetPassThroughPointIds(bool val);
  bool GetPassThroughPointIds();


  void SetBlockColorsDistinctValues(int val);
  int GetBlockColorsDistinctValues();
  void SetHideInternalAMRFaces(bool val);
  bool GetHideInternalAMRFaces();
  void SetUseNonOverlappingAMRMetaDataForOutlines(bool val);
  bool GetUseNonOverlappingAMRMetaDataForOutlines();


  void SetGenerateProcessIds(bool val);
  bool GetGenerateProcessIds();


  void SetVisibility(bool val);
  bool GetVisibility();
  void SetPickable(bool val);
  bool GetPickable();
  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();


  void SetSelectionColor(double r, double g, double b);
  double* GetSelectionColor() VTK_SIZEHINT(3);
  void SetSelectionOpacity(double val);
  double GetSelectionOpacity();
  void SetSelectionLineWidth(double val);
  double GetSelectionLineWidth();
  void SetSelectionPointSize(double val);
  double GetSelectionPointSize();
  void SetSelectionRepresentation(int type);
  int GetSelectionRepresentation();

  vtkActor* GetSelectionActor();

  vtkActor* GetActor();
 
protected:
  vtkSurfaceRepresentation();
  ~vtkSurfaceRepresentation() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  bool AddToView(vtkView* view) override;
  bool RemoveFromView(vtkView* view) override;
 
  vtkSelection* ConvertSelection(vtkView* view, vtkSelection* selection) override;
 
private:
  vtkSurfaceRepresentation(const vtkSurfaceRepresentation&) = delete;
  void operator=(const vtkSurfaceRepresentation&) = delete;

  bool IsColoringBy(const char* arrayName, int scalarMode);

  void ColorByComponent(int component);
 
  vtkNew<vtkGeometryFilterDispatcher> GeometryFilter;
  vtkNew<vtkCompositePolyDataMapper> Mapper;
  vtkNew<vtkActor> Actor;
  vtkNew<vtkScalarBarActor> ScalarBar;
  bool ScalarBarVisible;
  int RepresentationValue;
 
  vtkNew<vtkExtractSelection> SelectionExtractor;
  vtkNew<vtkGeometryFilterDispatcher> SelectionGeometryFilter;
  vtkNew<vtkCompositePolyDataMapper> SelectionMapper;
  vtkNew<vtkActor> SelectionActor;
  int SelectionRepresentationValue;
  bool UserSetSelectionRepresentation;
};
 
VTK_ABI_NAMESPACE_END
#endif