vtkPointLocator.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkPointLocator.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 vtkPointLocator_h
#define vtkPointLocator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkIncrementalPointLocator.h"

class vtkCellArray;
class vtkIdList;
class vtkNeighborPoints;
class vtkPoints;

class VTKCOMMONDATAMODEL_EXPORT vtkPointLocator : public vtkIncrementalPointLocator
{
public:
  static vtkPointLocator *New();


  vtkTypeMacro(vtkPointLocator,vtkIncrementalPointLocator);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;


  vtkSetVector3Macro(Divisions,int);
  vtkGetVectorMacro(Divisions,int,3);


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

  // Re-use any superclass signatures that we don't override.
  using vtkAbstractPointLocator::FindClosestPoint;

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


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

  int InitPointInsertion(vtkPoints *newPts,
                         const double bounds[6]) VTK_OVERRIDE;

  int InitPointInsertion(vtkPoints *newPts, const double bounds[6],
                         vtkIdType estSize) VTK_OVERRIDE;

  void InsertPoint(vtkIdType ptId, const double x[3]) VTK_OVERRIDE;

  vtkIdType InsertNextPoint(const double x[3]) VTK_OVERRIDE;


  vtkIdType IsInsertedPoint(double x, double  y, double z) VTK_OVERRIDE
  {
    double xyz[3];
    xyz[0] = x; xyz[1] = y; xyz[2] = z;
    return this->IsInsertedPoint (xyz);
  };
  vtkIdType IsInsertedPoint(const double x[3]) VTK_OVERRIDE;

  int InsertUniquePoint(const double x[3], vtkIdType &ptId) VTK_OVERRIDE;

  vtkIdType FindClosestInsertedPoint(const double x[3]) VTK_OVERRIDE;

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


  virtual void FindDistributedPoints(int N, const double x[3],
                                     vtkIdList *result, int M);
  virtual void FindDistributedPoints(int N, double x, double y,
                                     double z, vtkIdList *result, int M);

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

  virtual vtkIdList *GetPointsInBucket(const double x[3], int ijk[3]);


  vtkGetObjectMacro(Points, vtkPoints);


  void Initialize() VTK_OVERRIDE;
  void FreeSearchStructure() VTK_OVERRIDE;
  void BuildLocator() VTK_OVERRIDE;
  void GenerateRepresentation(int level, vtkPolyData *pd) VTK_OVERRIDE;

protected:
  vtkPointLocator();
  ~vtkPointLocator() VTK_OVERRIDE;

  // place points in appropriate buckets
  void GetBucketNeighbors(vtkNeighborPoints* buckets,
                          const int ijk[3], const int ndivs[3], int level);
  void GetOverlappingBuckets(vtkNeighborPoints* buckets,
                             const double x[3], const int ijk[3], double dist,
                             int level);
  void GetOverlappingBuckets(vtkNeighborPoints* buckets,
                             const double x[3], double dist,
                             int prevMinLevel[3],
                             int prevMaxLevel[3]);
  void GenerateFace(int face, int i, int j, int k,
                    vtkPoints *pts, vtkCellArray *polys);
  double Distance2ToBucket(const double x[3], const int nei[3]);
  double Distance2ToBounds(const double x[3], const double bounds[6]);

  vtkPoints *Points; // Used for merging points
  int Divisions[3]; // Number of sub-divisions in x-y-z directions
  int NumberOfPointsPerBucket; //Used with previous boolean to control subdivide
  vtkIdList **HashTable; // lists of point ids in buckets
  double H[3]; // width of each bucket in x-y-z directions

  double InsertionTol2;
  vtkIdType InsertionPointId;
  double InsertionLevel;

  // These are inlined methods and data members for performance reasons
  double HX, HY, HZ;
  double FX, FY, FZ, BX, BY, BZ;
  vtkIdType XD, YD, ZD, SliceSize;

  void GetBucketIndices(const double *x, int ijk[3]) const
  {
    // Compute point index. Make sure it lies within range of locator.
    ijk[0] = static_cast<int>(((x[0] - this->BX) * this->FX));
    ijk[1] = static_cast<int>(((x[1] - this->BY) * this->FY));
    ijk[2] = static_cast<int>(((x[2] - this->BZ) * this->FZ));

    ijk[0] = (ijk[0] < 0 ? 0 : (ijk[0] >= XD ? XD-1 : ijk[0]));
    ijk[1] = (ijk[1] < 0 ? 0 : (ijk[1] >= YD ? YD-1 : ijk[1]));
    ijk[2] = (ijk[2] < 0 ? 0 : (ijk[2] >= ZD ? ZD-1 : ijk[2]));
  }

  vtkIdType GetBucketIndex(const double *x) const
  {
    int ijk[3];
    this->GetBucketIndices(x, ijk);
    return ijk[0] + ijk[1]*this->XD + ijk[2]*this->SliceSize;
  }

  void ComputePerformanceFactors();

private:
  vtkPointLocator(const vtkPointLocator&) VTK_DELETE_FUNCTION;
  void operator=(const vtkPointLocator&) VTK_DELETE_FUNCTION;
};

#endif