vtkImplicitProjectOnPlaneDistance.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkImplicitProjectOnPlaneDistance.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkImplicitProjectOnPlaneDistance_h
#define vtkImplicitProjectOnPlaneDistance_h

#include "vtkImplicitFunction.h"

#include "vtkAbstractCellLocator.h" // User defined cellLocator
#include "vtkFiltersCoreModule.h"   // For export macro
#include "vtkSmartPointer.h"        // It has vtkSmartPointer fields

class vtkGenericCell;
class vtkPolyData;
class vtkPlane;

class VTKFILTERSCORE_EXPORT vtkImplicitProjectOnPlaneDistance : public vtkImplicitFunction
{
public:
  enum class NormType
  {
    L0 = 0,
    L2 = 2
  };

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

  vtkMTimeType GetMTime() override;

  using vtkImplicitFunction::EvaluateFunction;
  double EvaluateFunction(double x[3]) override;

  void EvaluateGradient(double x[3], double g[3]) override;

  void SetInput(vtkPolyData* input);


  vtkGetMacro(Tolerance, double);
  vtkSetMacro(Tolerance, double);


  NormType GetNorm() const { return Norm; }
  void SetNorm(NormType n)
  {
    Norm = n;
    Modified();
  }
#ifndef __VTK_WRAP_JAVA__
  // The Java wrappers cannot resolve this signature from the one above,
  // see https://gitlab.kitware.com/vtk/vtk/issues/17744
  void SetNorm(int n)
  {
    Norm = static_cast<NormType>(n);
    Modified();
  }
#endif



  vtkGetSmartPointerMacro(Locator, vtkAbstractCellLocator);
  vtkSetSmartPointerMacro(Locator, vtkAbstractCellLocator);

protected:
  vtkImplicitProjectOnPlaneDistance();
  ~vtkImplicitProjectOnPlaneDistance() override = default;

  void CreateDefaultLocator(void);

  double Tolerance;
  NormType Norm;

  vtkSmartPointer<vtkPolyData> Input;
  vtkSmartPointer<vtkAbstractCellLocator> Locator;
  vtkSmartPointer<vtkPlane> ProjectionPlane;

  // Stored here to avoid multiple allocation / dealloction
  vtkSmartPointer<vtkGenericCell> UnusedCell;
  double Bounds[6];

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

#endif