vtkStaticPointLocator.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 vtkStaticPointLocator_h
#define vtkStaticPointLocator_h
 
#include "vtkAbstractPointLocator.h"
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // For VTK_DEPRECATED_IN_9_7_0
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkIdList;
struct vtkBucketList;
class vtkDataArray;
struct vtkDist2TupleArray;
 
class VTKCOMMONDATAMODEL_EXPORT vtkStaticPointLocator : public vtkAbstractPointLocator
{
public:
  static vtkStaticPointLocator* New();


  vtkTypeMacro(vtkStaticPointLocator, vtkAbstractPointLocator);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


  vtkSetVector3Macro(Divisions, int);
  vtkGetVectorMacro(Divisions, int, 3);
 
  // Reuse any superclass signatures that we don't override.
  using vtkAbstractPointLocator::FindClosestNPoints;
  using vtkAbstractPointLocator::FindClosestPoint;
  using vtkAbstractPointLocator::FindPointsWithinRadius;
  using vtkAbstractPointLocator::GetBounds;

  vtkIdType FindClosestPoint(const double x[3]) override;


  vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
  virtual vtkIdType FindClosestPointWithinRadius(
    double radius, const double x[3], double inputDataLength, double& dist2);

  void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;

  double FindNPointsInShell(int N, const double x[3], vtkDist2TupleArray& results,
    double minDist2 = (-0.1), bool sort = true, vtkDoubleArray* petals = nullptr);

  void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;

  int IntersectWithLine(double a0[3], double a1[3], double tol, double& t, double lineX[3],
    double ptX[3], vtkIdType& ptId);

  void MergePoints(double tol, vtkIdType* mergeMap);

  void MergePointsWithData(vtkDataArray* data, vtkIdType* mergeMap);


  void Initialize() override;
  void FreeSearchStructure() override;
  void BuildLocator() override;
  void ForceBuildLocator() override;
  void BuildLocator(const double* inBounds);

  void GenerateRepresentation(int level, vtkPolyData* pd) override;

  vtkIdType GetNumberOfPointsInBucket(vtkIdType bNum);

  void GetBucketIds(vtkIdType bNum, vtkIdList* bList);

  void GetBucketCenter(int i, int j, int k, double center[3]);


  vtkSetClampMacro(MaxNumberOfBuckets, vtkIdType, 1000, VTK_ID_MAX);
  vtkGetMacro(MaxNumberOfBuckets, vtkIdType);

  bool GetLargeIds() { return this->LargeIds; }


  virtual double* GetSpacing() { return this->H; }
  virtual void GetSpacing(double spacing[3])
  {
    spacing[0] = this->H[0];
    spacing[1] = this->H[1];
    spacing[2] = this->H[2];
  }


  enum TraversalOrderType
  {
    POINT_ORDER = 0,
    BIN_ORDER = 1
  };


  vtkSetClampMacro(
    TraversalOrder, int, vtkStaticPointLocator::POINT_ORDER, vtkStaticPointLocator::BIN_ORDER);
  vtkGetMacro(TraversalOrder, int);
  void SetTraversalOrderToPointOrder()
  {
    this->SetTraversalOrder(vtkStaticPointLocator::POINT_ORDER);
  }
  void SetTraversalOrderToBinOrder() { this->SetTraversalOrder(vtkStaticPointLocator::BIN_ORDER); }


  vtkSetMacro(Padding, double);
  vtkGetMacro(Padding, double);


  VTK_DEPRECATED_IN_9_7_0("Use UseExistingSearchStructureOn instead.")
  void StaticOn() { this->Static = true; }
  VTK_DEPRECATED_IN_9_7_0("Use UseExistingSearchStructureOff instead.")
  void StaticOff() { this->Static = false; }
  VTK_DEPRECATED_IN_9_7_0("Use GetUseExistingSearchStructure instead.")
  vtkGetMacro(Static, vtkTypeBool);

  vtkBucketList* GetBuckets() { return this->Buckets; }
 
protected:
  vtkStaticPointLocator();
  ~vtkStaticPointLocator() override;
 
  void BuildLocatorInternal() override;
 
  int NumberOfPointsPerBucket;  // Used with AutomaticOn to control subdivide
  int Divisions[3];             // Number of sub-divisions in x-y-z directions
  double H[3];                  // Width of each bucket in x-y-z directions
  vtkBucketList* Buckets;       // Lists of point ids in each bucket
  vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
  bool LargeIds;                // Integer point ids are small (32-bit) or large (64-bit)
  int TraversalOrder;           // Control traversal order when threading
  double Padding;               // Pad out the bounding box of the locator
  vtkTypeBool Static;           // Control whether to repeatedly check modified time
 
private:
  vtkStaticPointLocator(const vtkStaticPointLocator&) = delete;
  void operator=(const vtkStaticPointLocator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif