vtkOctreePointLocator.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkOctreePointLocator.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.

=========================================================================*/
/*----------------------------------------------------------------------------
 Copyright (c) Sandia Corporation
 See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/

#ifndef vtkOctreePointLocator_h
#define vtkOctreePointLocator_h

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

class vtkCellArray;
class vtkIdTypeArray;
class vtkOctreePointLocatorNode;
class vtkPoints;
class vtkPolyData;

class VTKCOMMONDATAMODEL_EXPORT vtkOctreePointLocator : public vtkAbstractPointLocator
{
public:
  vtkTypeMacro(vtkOctreePointLocator, vtkAbstractPointLocator);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  static vtkOctreePointLocator *New();


  vtkSetMacro(MaximumPointsPerRegion, int);
  vtkGetMacro(MaximumPointsPerRegion, int);


  vtkSetMacro(CreateCubicOctants, int);
  vtkGetMacro(CreateCubicOctants, int);


  vtkGetMacro(FudgeFactor, double);
  vtkSetMacro(FudgeFactor, double);


  double *GetBounds() VTK_OVERRIDE;
  void GetBounds(double *bounds) VTK_OVERRIDE;


  vtkGetMacro(NumberOfLeafNodes, int);

  void GetRegionBounds(int regionID, double bounds[6]);

  void GetRegionDataBounds(int leafNodeID, double bounds[6]);

  int GetRegionContainingPoint(double x, double y, double z);

  void BuildLocator() VTK_OVERRIDE;


  vtkIdType FindClosestPoint(const double x[3]) VTK_OVERRIDE;
  vtkIdType FindClosestPoint(double x, double y, double z, double &dist2);

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


  vtkIdType FindClosestPointInRegion(int regionId, double *x, double &dist2);
  vtkIdType FindClosestPointInRegion(int regionId, double x, double y,
                                     double z, double &dist2);

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

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

  vtkIdTypeArray *GetPointsInRegion(int leafNodeId);

  void FreeSearchStructure() VTK_OVERRIDE;

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

  void FindPointsInArea(double* area, vtkIdTypeArray* ids, bool clearArray = true);

protected:

  vtkOctreePointLocator();
  ~vtkOctreePointLocator() VTK_OVERRIDE;

  vtkOctreePointLocatorNode *Top;
  vtkOctreePointLocatorNode **LeafNodeList;      // indexed by region/node ID

  void BuildLeafNodeList(vtkOctreePointLocatorNode* node, int & index);


  int FindRegion(vtkOctreePointLocatorNode* node, float x, float y, float z);
  int FindRegion(vtkOctreePointLocatorNode* node, double x, double y, double z);

  static void SetDataBoundsToSpatialBounds(vtkOctreePointLocatorNode *node);

  static void DeleteAllDescendants(vtkOctreePointLocatorNode* octant);

  void FindPointsWithinRadius(vtkOctreePointLocatorNode* node, double radiusSquared,
                              const double x[3], vtkIdList* ids);

  // Recursive helper for public FindPointsWithinRadius
  void AddAllPointsInRegion(vtkOctreePointLocatorNode* node, vtkIdList* ids);

  // Recursive helper for public FindPointsInArea
  void FindPointsInArea(vtkOctreePointLocatorNode* node, double* area, vtkIdTypeArray* ids);

  // Recursive helper for public FindPointsInArea
  void AddAllPointsInRegion(vtkOctreePointLocatorNode* node, vtkIdTypeArray* ids);

  void DivideRegion(vtkOctreePointLocatorNode *node, int* ordering, int level);

  int DivideTest(int size, int level);

  void AddPolys(vtkOctreePointLocatorNode *node, vtkPoints *pts, vtkCellArray *polys);

  int _FindClosestPointInRegion(int leafNodeId, double x, double y,
                                double z, double &dist2);

  int FindClosestPointInSphere(double x, double y, double z, double radius,
                               int skipRegion, double &dist2);


  int MaximumPointsPerRegion;
  int NumberOfLeafNodes;

  double FudgeFactor;   // a very small distance, relative to the dataset's size
  int NumberOfLocatorPoints;
  float *LocatorPoints;
  int *LocatorIds;

  float MaxWidth;

  int CreateCubicOctants;

  vtkOctreePointLocator(const vtkOctreePointLocator&) VTK_DELETE_FUNCTION;
  void operator=(const vtkOctreePointLocator&) VTK_DELETE_FUNCTION;
};
#endif