vtkClosestPointStrategy.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 vtkClosestPointStrategy_h
#define vtkClosestPointStrategy_h

#include "vtkCell.h"                  //inline SelectCell
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // For VTK_DEPRECATED_IN_9_7_0
#include "vtkFindCellStrategy.h"
#include "vtkGenericCell.h" //inline SelectCell
#include "vtkPointSet.h"    //inline SelectCell

#include <vector> // For tracking visited cells

VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;
class vtkAbstractPointLocator;

class VTK_DEPRECATED_IN_9_7_0(
  "Use vtkJumpAndWalkCellLocator instead") VTKCOMMONDATAMODEL_EXPORT vtkClosestPointStrategy
  : public vtkFindCellStrategy
{
public:
  static vtkClosestPointStrategy* New();


  vtkTypeMacro(vtkClosestPointStrategy, vtkFindCellStrategy);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkSmartPointer<vtkAbstractCellLocator> ConvertToCellLocator() override;

  int Initialize(vtkPointSet* ps) override;

  vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
    double tol2, int& subId, double pcoords[3], double* weights) override;

  vtkIdType FindClosestPointWithinRadius(double x[3], double radius, double closestPoint[3],
    vtkGenericCell* cell, vtkIdType& cellId, int& subId, double& dist2, int& inside) override;

  bool InsideCellBounds(double x[3], vtkIdType cellId) override;


  virtual void SetPointLocator(vtkAbstractPointLocator*);
  vtkGetObjectMacro(PointLocator, vtkAbstractPointLocator);

  vtkCell* SelectCell(vtkPointSet* self, vtkIdType cellId, vtkCell* cell, vtkGenericCell* gencell);

  void CopyParameters(vtkFindCellStrategy* from) override;

protected:
  vtkClosestPointStrategy();
  ~vtkClosestPointStrategy() override;

  std::vector<unsigned char> VisitedCells; // boolean array to track visited cells
  vtkNew<vtkIdList> VisitedCellIds;        // list of visited cell ids to reset boolean array
  vtkNew<vtkIdList> PointIds;
  vtkNew<vtkIdList> Neighbors;
  vtkNew<vtkIdList> CellIds;
  vtkNew<vtkIdList> NearPointIds;
  std::vector<double> Weights;

  vtkAbstractPointLocator* PointLocator;

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

// Handle cases where starting cell is provided or not
inline vtkCell* vtkClosestPointStrategy::SelectCell(
  vtkPointSet* self, vtkIdType cellId, vtkCell* cell, vtkGenericCell* gencell)
{
  if (!cell)
  {
    if (gencell)
    {
      self->GetCell(cellId, gencell);
      cell = gencell;
    }
    else
    {
      cell = self->GetCell(cellId);
    }
  }
  return cell;
}

VTK_ABI_NAMESPACE_END
#endif