vtkCellLocator.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkCellLocator.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 vtkCellLocator_h
#define vtkCellLocator_h
 
#include "vtkAbstractCellLocator.h"
#include "vtkCommonDataModelModule.h" // For export macro
 
class vtkNeighborCells;
 
class VTKCOMMONDATAMODEL_EXPORT vtkCellLocator : public vtkAbstractCellLocator
{
public:
  vtkTypeMacro(vtkCellLocator, vtkAbstractCellLocator);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkCellLocator* New();
 
  void SetNumberOfCellsPerBucket(int N) { this->SetNumberOfCellsPerNode(N); }
  int GetNumberOfCellsPerBucket() { return this->NumberOfCellsPerNode; }
 
  // Re-use any superclass signatures that we don't override.
  using vtkAbstractCellLocator::FindCell;
  using vtkAbstractCellLocator::FindClosestPoint;
  using vtkAbstractCellLocator::FindClosestPointWithinRadius;
  using vtkAbstractCellLocator::IntersectWithLine;
 
  int IntersectWithLine(const double a0[3], const double a1[3], double tol, double& t, double x[3],
    double pcoords[3], int& subId, vtkIdType& cellId, vtkGenericCell* cell) override;
 
  void FindClosestPoint(const double x[3], double closestPoint[3], vtkGenericCell* cell,
    vtkIdType& cellId, int& subId, double& dist2) override;
 
  vtkIdType FindClosestPointWithinRadius(double x[3], double radius, double closestPoint[3],
    vtkGenericCell* cell, vtkIdType& cellId, int& subId, double& dist2, int& inside) override;
 
  virtual vtkIdList* GetCells(int bucket);
 
  virtual int GetNumberOfBuckets(void);
 
  vtkIdType FindCell(
    double x[3], double tol2, vtkGenericCell* GenCell, double pcoords[3], double* weights) override;
 
  void FindCellsWithinBounds(double* bbox, vtkIdList* cells) override;
 
  void FindCellsAlongLine(
    const double p1[3], const double p2[3], double tolerance, vtkIdList* cells) override;
 
 
  void FreeSearchStructure() override;
  void BuildLocator() override;
  virtual void BuildLocatorIfNeeded();
  virtual void ForceBuildLocator();
  virtual void BuildLocatorInternal();
  void GenerateRepresentation(int level, vtkPolyData* pd) override;
 
protected:
  vtkCellLocator();
  ~vtkCellLocator() override;
 
  void GetBucketNeighbors(int ijk[3], int ndivs, int level);
  void GetOverlappingBuckets(
    const double x[3], int ijk[3], double dist, int prevMinLevel[3], int prevMaxLevel[3]);
 
  void ClearCellHasBeenVisited();
  void ClearCellHasBeenVisited(vtkIdType id);
 
  double Distance2ToBucket(const double x[3], int nei[3]);
  double Distance2ToBounds(const double x[3], double bounds[6]);
 
  int NumberOfOctants;   // number of octants in tree
  double Bounds[6];      // bounding box root octant
  int NumberOfParents;   // number of parent octants
  double H[3];           // width of leaf octant in x-y-z directions
  int NumberOfDivisions; // number of "leaf" octant sub-divisions
  vtkIdList** Tree;      // octree
 
  void MarkParents(void*, int, int, int, int, int);
  void GetChildren(int idx, int level, int children[8]);
  int GenerateIndex(int offset, int numDivs, int i, int j, int k, vtkIdType& idx);
  void GenerateFace(
    int face, int numDivs, int i, int j, int k, vtkPoints* pts, vtkCellArray* polys);
 
  vtkNeighborCells* Buckets;
  unsigned char* CellHasBeenVisited;
  unsigned char QueryNumber;
 
  void ComputeOctantBounds(int i, int j, int k);
  double OctantBounds[6]; // the bounds of the current octant
  int IsInOctantBounds(const double x[3], double tol = 0.0)
  {
    if (this->OctantBounds[0] - tol <= x[0] && x[0] <= this->OctantBounds[1] + tol &&
      this->OctantBounds[2] - tol <= x[1] && x[1] <= this->OctantBounds[3] + tol &&
      this->OctantBounds[4] - tol <= x[2] && x[2] <= this->OctantBounds[5] + tol)
    {
      return 1;
    }
    else
    {
      return 0;
    }
  }
 
private:
  vtkCellLocator(const vtkCellLocator&) = delete;
  void operator=(const vtkCellLocator&) = delete;
};
 
#endif