vtkContourFilter.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 vtkContourFilter_h
#define vtkContourFilter_h

#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include "vtkContourValues.h" // Needed for inline methods

VTK_ABI_NAMESPACE_BEGIN

class vtkCallbackCommand;
class vtkContour3DLinearGrid;
class vtkContourGrid;
class vtkFlyingEdges2D;
class vtkFlyingEdges3D;
class vtkGridSynchronizedTemplates3D;
class vtkIncrementalPointLocator;
class vtkRectilinearSynchronizedTemplates;
class vtkScalarTree;
class vtkSynchronizedTemplates2D;
class vtkSynchronizedTemplates3D;

class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkContourFilter : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkContourFilter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkContourFilter* New();


  void SetValue(int i, double value);
  double GetValue(int i);
  double* GetValues();
  void GetValues(double* contourValues);
  void SetNumberOfContours(int number);
  int GetNumberOfContours();
  void GenerateValues(int numContours, double range[2]);
  void GenerateValues(int numContours, double rangeStart, double rangeEnd);
  void SetContourValues(const std::vector<double>& values);
  std::vector<double> GetContourValues();

  vtkMTimeType GetMTime() override;


  vtkSetMacro(ComputeNormals, int);
  vtkGetMacro(ComputeNormals, int);
  vtkBooleanMacro(ComputeNormals, int);


  vtkSetMacro(ComputeGradients, vtkTypeBool);
  vtkGetMacro(ComputeGradients, vtkTypeBool);
  vtkBooleanMacro(ComputeGradients, vtkTypeBool);


  vtkSetMacro(ComputeScalars, vtkTypeBool);
  vtkGetMacro(ComputeScalars, vtkTypeBool);
  vtkBooleanMacro(ComputeScalars, vtkTypeBool);


  vtkSetMacro(UseScalarTree, vtkTypeBool);
  vtkGetMacro(UseScalarTree, vtkTypeBool);
  vtkBooleanMacro(UseScalarTree, vtkTypeBool);


  virtual void SetScalarTree(vtkScalarTree*);
  vtkGetObjectMacro(ScalarTree, vtkScalarTree);


  void SetLocator(vtkIncrementalPointLocator* locator);
  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);

  void CreateDefaultLocator();


  vtkSetMacro(ArrayComponent, int);
  vtkGetMacro(ArrayComponent, int);


  vtkSetMacro(GenerateTriangles, vtkTypeBool);
  vtkGetMacro(GenerateTriangles, vtkTypeBool);
  vtkBooleanMacro(GenerateTriangles, vtkTypeBool);


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);


  vtkSetMacro(FastMode, bool);
  vtkGetMacro(FastMode, bool);
  vtkBooleanMacro(FastMode, bool);

  void SetInputArray(const std::string& name)
  {
    this->SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name.c_str());
  }

protected:
  vtkContourFilter();
  ~vtkContourFilter() override;

  void ReportReferences(vtkGarbageCollector*) override;

  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;

  vtkNew<vtkContourValues> ContourValues;
  int ComputeNormals;
  vtkTypeBool ComputeGradients;
  vtkTypeBool ComputeScalars;
  vtkIncrementalPointLocator* Locator;
  vtkTypeBool UseScalarTree;
  vtkScalarTree* ScalarTree;
  int OutputPointsPrecision;
  int ArrayComponent;
  vtkTypeBool GenerateTriangles;
  bool FastMode;

  vtkNew<vtkContourGrid> ContourGrid;
  vtkNew<vtkContour3DLinearGrid> Contour3DLinearGrid;
  vtkNew<vtkFlyingEdges2D> FlyingEdges2D;
  vtkNew<vtkFlyingEdges3D> FlyingEdges3D;
  vtkNew<vtkGridSynchronizedTemplates3D> GridSynchronizedTemplates;
  vtkNew<vtkRectilinearSynchronizedTemplates> RectilinearSynchronizedTemplates;
  vtkNew<vtkSynchronizedTemplates2D> SynchronizedTemplates2D;
  vtkNew<vtkSynchronizedTemplates3D> SynchronizedTemplates3D;
  vtkNew<vtkCallbackCommand> InternalProgressCallbackCommand;

  static void InternalProgressCallbackFunction(
    vtkObject* caller, unsigned long eid, void* clientData, void* callData);

private:
  vtkContourFilter(const vtkContourFilter&) = delete;
  void operator=(const vtkContourFilter&) = delete;
};

inline void vtkContourFilter::SetValue(int i, double value)
{
  this->ContourValues->SetValue(i, value);
}

inline double vtkContourFilter::GetValue(int i)
{
  return this->ContourValues->GetValue(i);
}

inline double* vtkContourFilter::GetValues()
{
  return this->ContourValues->GetValues();
}

inline void vtkContourFilter::GetValues(double* contourValues)
{
  this->ContourValues->GetValues(contourValues);
}

inline void vtkContourFilter::SetNumberOfContours(int number)
{
  this->ContourValues->SetNumberOfContours(number);
}

inline int vtkContourFilter::GetNumberOfContours()
{
  return this->ContourValues->GetNumberOfContours();
}

inline void vtkContourFilter::GenerateValues(int numContours, double range[2])
{
  this->ContourValues->GenerateValues(numContours, range);
}

inline void vtkContourFilter::GenerateValues(int numContours, double rangeStart, double rangeEnd)
{
  this->ContourValues->GenerateValues(numContours, rangeStart, rangeEnd);
}

inline void vtkContourFilter::SetContourValues(const std::vector<double>& values)
{
  int numContours = static_cast<int>(values.size());
  this->SetNumberOfContours(numContours);
  for (int i = 0; i < numContours; i++)
  {
    this->SetValue(i, values[i]);
  }
}

inline std::vector<double> vtkContourFilter::GetContourValues()
{
  std::vector<double> contours;
  int numContours = this->GetNumberOfContours();
  contours.reserve(numContours);
  for (int i = 0; i < numContours; i++)
  {
    contours.push_back(this->GetValue(i));
  }
  return contours;
}

VTK_ABI_NAMESPACE_END
#endif