vtkAbstractCellLocator.h

Go to the documentation of this file.

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

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

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

class vtkCellArray;
class vtkGenericCell;
class vtkIdList;
class vtkPoints;

class VTKCOMMONDATAMODEL_EXPORT vtkAbstractCellLocator : public vtkLocator
{
public:
  vtkTypeMacro(vtkAbstractCellLocator,vtkLocator);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


  vtkSetMacro(CacheCellBounds,vtkTypeBool);
  vtkGetMacro(CacheCellBounds,vtkTypeBool);
  vtkBooleanMacro(CacheCellBounds,vtkTypeBool);


  vtkSetMacro(RetainCellLists,vtkTypeBool);
  vtkGetMacro(RetainCellLists,vtkTypeBool);
  vtkBooleanMacro(RetainCellLists,vtkTypeBool);


  vtkSetMacro(LazyEvaluation,vtkTypeBool);
  vtkGetMacro(LazyEvaluation,vtkTypeBool);
  vtkBooleanMacro(LazyEvaluation,vtkTypeBool);


  vtkSetMacro(UseExistingSearchStructure,vtkTypeBool);
  vtkGetMacro(UseExistingSearchStructure,vtkTypeBool);
  vtkBooleanMacro(UseExistingSearchStructure,vtkTypeBool);

  virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
    double pcoords[3], int &subId);

  virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
    double pcoords[3], int &subId, vtkIdType &cellId);

  virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
    double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell);

  virtual int IntersectWithLine(
    const double p1[3], const double p2[3],
    vtkPoints *points, vtkIdList *cellIds);

  virtual void FindClosestPoint(
    const double x[3], double closestPoint[3],
    vtkIdType &cellId, int &subId, double& dist2);

  virtual void FindClosestPoint(
    const double x[3], double closestPoint[3],
    vtkGenericCell *cell, vtkIdType &cellId,
    int &subId, double& dist2);

  virtual vtkIdType FindClosestPointWithinRadius(
    double x[3], double radius,
    double closestPoint[3], vtkIdType &cellId,
    int &subId, double& dist2);

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

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

  virtual void FindCellsWithinBounds(double *bbox, vtkIdList *cells);

  virtual void FindCellsAlongLine(const double p1[3], const double p2[3], double tolerance, vtkIdList *cells);

  virtual vtkIdType FindCell(double x[3]);

  virtual vtkIdType FindCell(
    double x[3], double tol2, vtkGenericCell *GenCell,
    double pcoords[3], double *weights);

  virtual bool InsideCellBounds(double x[3], vtkIdType cell_ID);

protected:
   vtkAbstractCellLocator();
  ~vtkAbstractCellLocator() override;


  virtual bool StoreCellBounds();
  virtual void FreeCellBounds();

  int NumberOfCellsPerNode;
  vtkTypeBool RetainCellLists;
  vtkTypeBool CacheCellBounds;
  vtkTypeBool LazyEvaluation;
  vtkTypeBool UseExistingSearchStructure;
  vtkGenericCell *GenericCell;
  double (*CellBounds)[6];

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

#endif