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 "vtkNew.h" // For ivars
#include "vtkScivisDataRepresentation.h"
#include "vtkViewsScivisModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkBlockProperties;
class vtkCompositePolyDataMapper;
class vtkDataArray;
class vtkExtractSelection;
class vtkGeometryFilterDispatcher;
class vtkProperty;
class vtkScalarsToColors;
class vtkScivisView;
class vtkSelection;
 
class VTKVIEWSSCIVIS_EXPORT vtkSurfaceRepresentation : public vtkScivisDataRepresentation
{
public:
  static vtkSurfaceRepresentation* New();
  vtkTypeMacro(vtkSurfaceRepresentation, vtkScivisDataRepresentation);
  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 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 ResetColorArray();


  enum ColorModeType
  {
    MAP_SCALARS = 0,
    DIRECT_SCALARS = 1
  };
  void SetColorMode(int mode);
  int GetColorMode();
  void SetColorModeToMapScalars() { this->SetColorMode(MAP_SCALARS); }
  void SetColorModeToDirectScalars() { this->SetColorMode(DIRECT_SCALARS); }


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


  void SetInterpolateScalarsBeforeMapping(bool val);
  bool GetInterpolateScalarsBeforeMapping();

  vtkBlockProperties* GetBlocks();


  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;
  void SetColorMap(vtkScalarsToColors* map) override;
  vtkScalarsToColors* GetColorMap() override;


  void SetSelectionRepresentation(int type);
  int GetSelectionRepresentation();


  vtkActor* GetActor();
  vtkProperty* GetProperty();
  vtkGeometryFilterDispatcher* GetGeometryFilter();
  vtkActor* GetSelectionActor();
 
protected:
  vtkSurfaceRepresentation();
  ~vtkSurfaceRepresentation() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  bool AddToView(vtkScivisView* view) override;
  bool RemoveFromView(vtkScivisView* view) override;
 
  vtkSelection* ConvertSelection(vtkScivisView* 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);

  vtkDataArray* GetRenderedScalars(int& fieldAssoc);
 
  vtkNew<vtkGeometryFilterDispatcher> GeometryFilter;
  vtkNew<vtkCompositePolyDataMapper> Mapper;
  vtkNew<vtkActor> Actor;
  vtkNew<vtkBlockProperties> Blocks;
  int RepresentationValue;
 
  vtkNew<vtkExtractSelection> SelectionExtractor;
  vtkNew<vtkGeometryFilterDispatcher> SelectionGeometryFilter;
  vtkNew<vtkCompositePolyDataMapper> SelectionMapper;
  vtkNew<vtkActor> SelectionActor;
  int SelectionRepresentationValue;
  bool UserSetSelectionRepresentation;
};
 
VTK_ABI_NAMESPACE_END
#endif