vtkPointSmoothingFilter.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 vtkPointSmoothingFilter_h
#define vtkPointSmoothingFilter_h

#include "vtkFiltersPointsModule.h" // For export macro
#include "vtkPointSetAlgorithm.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractPointLocator;
class vtkDataArray;
class vtkPlane;

class VTKFILTERSPOINTS_EXPORT vtkPointSmoothingFilter : public vtkPointSetAlgorithm
{
public:

  static vtkPointSmoothingFilter* New();
  vtkTypeMacro(vtkPointSmoothingFilter, vtkPointSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(NeighborhoodSize, int, 4, 128);
  vtkGetMacro(NeighborhoodSize, int);

  enum
  {
    DEFAULT_SMOOTHING = 0,
    GEOMETRIC_SMOOTHING,
    UNIFORM_SMOOTHING,
    SCALAR_SMOOTHING,
    TENSOR_SMOOTHING,
    FRAME_FIELD_SMOOTHING
  };


  vtkSetClampMacro(SmoothingMode, int, DEFAULT_SMOOTHING, FRAME_FIELD_SMOOTHING);
  vtkGetMacro(SmoothingMode, int);
  void SetSmoothingModeToDefault() { this->SetSmoothingMode(DEFAULT_SMOOTHING); }
  void SetSmoothingModeToGeometric() { this->SetSmoothingMode(GEOMETRIC_SMOOTHING); }
  void SetSmoothingModeToUniform() { this->SetSmoothingMode(UNIFORM_SMOOTHING); }
  void SetSmoothingModeToScalars() { this->SetSmoothingMode(SCALAR_SMOOTHING); }
  void SetSmoothingModeToTensors() { this->SetSmoothingMode(TENSOR_SMOOTHING); }
  void SetSmoothingModeToFrameField() { this->SetSmoothingMode(FRAME_FIELD_SMOOTHING); }


  virtual void SetFrameFieldArray(vtkDataArray*);
  vtkGetObjectMacro(FrameFieldArray, vtkDataArray);


  vtkSetClampMacro(NumberOfIterations, int, 0, VTK_INT_MAX);
  vtkGetMacro(NumberOfIterations, int);


  vtkSetClampMacro(NumberOfSubIterations, int, 1, VTK_INT_MAX);
  vtkGetMacro(NumberOfSubIterations, int);


  vtkSetClampMacro(MaximumStepSize, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(MaximumStepSize, double);


  vtkSetClampMacro(Convergence, double, 0.0, 1.0);
  vtkGetMacro(Convergence, double);


  vtkSetMacro(EnableConstraints, bool);
  vtkGetMacro(EnableConstraints, bool);
  vtkBooleanMacro(EnableConstraints, bool);
  vtkSetClampMacro(FixedAngle, double, 0, 90);
  vtkGetMacro(FixedAngle, double);
  vtkSetClampMacro(BoundaryAngle, double, 0, 120);
  vtkGetMacro(BoundaryAngle, double);


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


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


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


  vtkSetClampMacro(PackingRadius, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(PackingRadius, double);


  vtkSetClampMacro(PackingFactor, double, 0.1, 10.0);
  vtkGetMacro(PackingFactor, double);


  vtkSetClampMacro(AttractionFactor, double, 0.1, 10.0);
  vtkGetMacro(AttractionFactor, double);

  enum
  {
    UNCONSTRAINED_MOTION = 0,
    PLANE_MOTION
  };


  vtkSetMacro(MotionConstraint, int);
  vtkGetMacro(MotionConstraint, int);
  void SetMotionConstraintToUnconstrained() { this->SetMotionConstraint(UNCONSTRAINED_MOTION); }
  void SetMotionConstraintToPlane() { this->SetMotionConstraint(PLANE_MOTION); }


  void SetPlane(vtkPlane*);
  vtkGetObjectMacro(Plane, vtkPlane);


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

protected:
  vtkPointSmoothingFilter();
  ~vtkPointSmoothingFilter() override;

  // Control the smoothing
  int NeighborhoodSize;
  int SmoothingMode;
  int NumberOfIterations;
  int NumberOfSubIterations;
  double MaximumStepSize;
  double Convergence;
  vtkDataArray* FrameFieldArray;

  // Support the algorithm
  vtkAbstractPointLocator* Locator;

  // Constraints
  bool EnableConstraints;
  double FixedAngle;
  double BoundaryAngle;
  bool GenerateConstraintScalars;
  bool GenerateConstraintNormals;

  // Packing radius and related
  bool ComputePackingRadius;
  double PackingRadius;
  double PackingFactor;
  double AttractionFactor;

  // Motion constraints
  int MotionConstraint;
  vtkPlane* Plane;

  // Pipeline support
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;

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

VTK_ABI_NAMESPACE_END
#endif