VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractCellLocator Class Reference

an abstract base class for locators which find cells More...

#include <vtkAbstractCellLocator.h>

Inheritance diagram for vtkAbstractCellLocator:
[legend]
Collaboration diagram for vtkAbstractCellLocator:
[legend]

Public Types

typedef vtkLocator Superclass
 
- Public Types inherited from vtkLocator
typedef vtkObject Superclass
 Standard type and print methods. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAbstractCellLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetNumberOfCellsPerNode (int)
 Specify the preferred/maximum number of cells in each node/bucket. More...
 
virtual int GetNumberOfCellsPerNode ()
 
virtual void SetCacheCellBounds (vtkTypeBool)
 Boolean controls whether the bounds of each cell are computed only once and then saved. More...
 
virtual vtkTypeBool GetCacheCellBounds ()
 
virtual void CacheCellBoundsOn ()
 
virtual void CacheCellBoundsOff ()
 
virtual void SetRetainCellLists (vtkTypeBool)
 Boolean controls whether to maintain list of cells in each node. More...
 
virtual vtkTypeBool GetRetainCellLists ()
 
virtual void RetainCellListsOn ()
 
virtual void RetainCellListsOff ()
 
virtual void SetLazyEvaluation (vtkTypeBool)
 Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...
 
virtual vtkTypeBool GetLazyEvaluation ()
 
virtual void LazyEvaluationOn ()
 
virtual void LazyEvaluationOff ()
 
virtual void SetUseExistingSearchStructure (vtkTypeBool)
 Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase. More...
 
virtual vtkTypeBool GetUseExistingSearchStructure ()
 
virtual void UseExistingSearchStructureOn ()
 
virtual void UseExistingSearchStructureOff ()
 
virtual int IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
 Return intersection point (if any) of finite line with cells contained in cell locator. More...
 
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)
 Return intersection point (if any) AND the cell which was intersected by the finite line. More...
 
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)
 Return intersection point (if any) AND the cell which was intersected by the finite line. More...
 
virtual int IntersectWithLine (const double p1[3], const double p2[3], vtkPoints *points, vtkIdList *cellIds)
 Take the passed line segment and intersect it with the data set. More...
 
virtual void FindClosestPoint (const double x[3], double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
 Return the closest point and the cell which is closest to the point x. More...
 
virtual void FindClosestPoint (const double x[3], double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)
 Return the closest point and the cell which is closest to the point x. More...
 
virtual vtkIdType FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
 Return the closest point within a specified radius and the cell which is closest to the point x. More...
 
virtual vtkIdType FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)
 Return the closest point within a specified radius and the cell which is closest to the point x. More...
 
virtual vtkIdType FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside)
 Return the closest point within a specified radius and the cell which is closest to the point x. More...
 
virtual void FindCellsWithinBounds (double *bbox, vtkIdList *cells)
 Return a list of unique cell ids inside of a given bounding box. More...
 
virtual void FindCellsAlongLine (const double p1[3], const double p2[3], double tolerance, vtkIdList *cells)
 Given a finite line defined by the two points (p1,p2), return the list of unique cell ids in the buckets containing the line. More...
 
virtual vtkIdType FindCell (double x[3])
 Returns the Id of the cell containing the point, returns -1 if no cell found. More...
 
virtual vtkIdType FindCell (double x[3], double tol2, vtkGenericCell *GenCell, double pcoords[3], double *weights)
 Find the cell containing a given point. More...
 
virtual bool InsideCellBounds (double x[3], vtkIdType cell_ID)
 Quickly test if a point is inside the bounds of a particular cell. More...
 
- Public Member Functions inherited from vtkLocator
vtkLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetDataSet (vtkDataSet *)
 Build the locator from the points/cells defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 
virtual void SetMaxLevel (int)
 Set the maximum allowable level for the tree. More...
 
virtual int GetMaxLevel ()
 
virtual int GetLevel ()
 Get the level of the locator (determined automatically if Automatic is true). More...
 
virtual void SetAutomatic (vtkTypeBool)
 Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...
 
virtual vtkTypeBool GetAutomatic ()
 
virtual void AutomaticOn ()
 
virtual void AutomaticOff ()
 
virtual void SetTolerance (double)
 Specify absolute tolerance (in world coordinates) for performing geometric operations. More...
 
virtual double GetTolerance ()
 
virtual void Update ()
 Cause the locator to rebuild itself if it or its input dataset has changed. More...
 
virtual void Initialize ()
 Initialize locator. More...
 
virtual void BuildLocator ()=0
 Build the locator from the input dataset. More...
 
virtual void FreeSearchStructure ()=0
 Free the memory required for the spatial data structure. More...
 
virtual void GenerateRepresentation (int level, vtkPolyData *pd)=0
 Method to build a representation at a particular level. More...
 
virtual vtkMTimeType GetBuildTime ()
 Return the time of the last data structure build. More...
 
void Register (vtkObjectBase *o) override
 Handle the PointSet <-> Locator loop. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractCellLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLocator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractCellLocator ()
 
 ~vtkAbstractCellLocator () override
 
virtual bool StoreCellBounds ()
 This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array. More...
 
virtual void FreeCellBounds ()
 
- Protected Member Functions inherited from vtkLocator
 vtkLocator ()
 
 ~vtkLocator () override
 
void ReportReferences (vtkGarbageCollector *) override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfCellsPerNode
 
vtkTypeBool RetainCellLists
 
vtkTypeBool CacheCellBounds
 
vtkTypeBool LazyEvaluation
 
vtkTypeBool UseExistingSearchStructure
 
vtkGenericCellGenericCell
 
double(* CellBounds )[6]
 
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
 
vtkTypeBool Automatic
 
double Tolerance
 
int MaxLevel
 
int Level
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

an abstract base class for locators which find cells

vtkAbstractCellLocator is a spatial search object to quickly locate cells in 3D. vtkAbstractCellLocator supplies a basic interface which concrete subclasses should implement.

Warning
When deriving a class from vtkAbstractCellLocator, one should include the 'hidden' member functions by the following construct in the derived class
*  using vtkAbstractCellLocator::IntersectWithLine;
*  using vtkAbstractCellLocator::FindClosestPoint;
*  using vtkAbstractCellLocator::FindClosestPointWithinRadius;
* 
See also
vtkLocator vtkPointLocator vtkOBBTree vtkCellLocator

Definition at line 48 of file vtkAbstractCellLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkAbstractCellLocator.h.

Constructor & Destructor Documentation

◆ vtkAbstractCellLocator()

vtkAbstractCellLocator::vtkAbstractCellLocator ( )
protected

◆ ~vtkAbstractCellLocator()

vtkAbstractCellLocator::~vtkAbstractCellLocator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkAbstractCellLocator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkAbstractCellLocator::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkLocator.

Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkStaticCellLocator, vtkCellLocator, and vtkCellTreeLocator.

◆ SafeDownCast()

static vtkAbstractCellLocator* vtkAbstractCellLocator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractCellLocator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractCellLocator* vtkAbstractCellLocator::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractCellLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkStaticCellLocator, vtkCellLocator, and vtkCellTreeLocator.

◆ SetNumberOfCellsPerNode()

virtual void vtkAbstractCellLocator::SetNumberOfCellsPerNode ( int  )
virtual

Specify the preferred/maximum number of cells in each node/bucket.

Default 32. Locators generally operate by subdividing space into smaller regions until the number of cells in each region (or node) reaches the desired level.

◆ GetNumberOfCellsPerNode()

virtual int vtkAbstractCellLocator::GetNumberOfCellsPerNode ( )
virtual

◆ SetCacheCellBounds()

virtual void vtkAbstractCellLocator::SetCacheCellBounds ( vtkTypeBool  )
virtual

Boolean controls whether the bounds of each cell are computed only once and then saved.

Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and the extra memory won't cause disk caching (24 extra bytes per cell are required to save the bounds).

◆ GetCacheCellBounds()

virtual vtkTypeBool vtkAbstractCellLocator::GetCacheCellBounds ( )
virtual

◆ CacheCellBoundsOn()

virtual void vtkAbstractCellLocator::CacheCellBoundsOn ( )
virtual

◆ CacheCellBoundsOff()

virtual void vtkAbstractCellLocator::CacheCellBoundsOff ( )
virtual

◆ SetRetainCellLists()

virtual void vtkAbstractCellLocator::SetRetainCellLists ( vtkTypeBool  )
virtual

Boolean controls whether to maintain list of cells in each node.

not applicable to all implementations, but if the locator is being used as a geometry simplification technique, there is no need to keep them.

◆ GetRetainCellLists()

virtual vtkTypeBool vtkAbstractCellLocator::GetRetainCellLists ( )
virtual

◆ RetainCellListsOn()

virtual void vtkAbstractCellLocator::RetainCellListsOn ( )
virtual

◆ RetainCellListsOff()

virtual void vtkAbstractCellLocator::RetainCellListsOff ( )
virtual

◆ SetLazyEvaluation()

virtual void vtkAbstractCellLocator::SetLazyEvaluation ( vtkTypeBool  )
virtual

Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

If LazyEvaluation is supported, this turns on/off the feature. if not supported, it is ignored.

◆ GetLazyEvaluation()

virtual vtkTypeBool vtkAbstractCellLocator::GetLazyEvaluation ( )
virtual

◆ LazyEvaluationOn()

virtual void vtkAbstractCellLocator::LazyEvaluationOn ( )
virtual

◆ LazyEvaluationOff()

virtual void vtkAbstractCellLocator::LazyEvaluationOff ( )
virtual

◆ SetUseExistingSearchStructure()

virtual void vtkAbstractCellLocator::SetUseExistingSearchStructure ( vtkTypeBool  )
virtual

Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

◆ GetUseExistingSearchStructure()

virtual vtkTypeBool vtkAbstractCellLocator::GetUseExistingSearchStructure ( )
virtual

◆ UseExistingSearchStructureOn()

virtual void vtkAbstractCellLocator::UseExistingSearchStructureOn ( )
virtual

◆ UseExistingSearchStructureOff()

virtual void vtkAbstractCellLocator::UseExistingSearchStructureOff ( )
virtual

◆ IntersectWithLine() [1/4]

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

Return intersection point (if any) of finite line with cells contained in cell locator.

See vtkCell.h parameters documentation.

Reimplemented in vtkStaticCellLocator, and vtkCellTreeLocator.

◆ IntersectWithLine() [2/4]

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

Return intersection point (if any) AND the cell which was intersected by the finite line.

Reimplemented in vtkModifiedBSPTree, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ IntersectWithLine() [3/4]

virtual int vtkAbstractCellLocator::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

Return intersection point (if any) AND the cell which was intersected by the finite line.

The cell is returned as a cell id and as a generic cell.

Reimplemented in vtkModifiedBSPTree, vtkStaticCellLocator, vtkOBBTree, vtkCellLocator, and vtkCellTreeLocator.

◆ IntersectWithLine() [4/4]

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

Take the passed line segment and intersect it with the data set.

This method assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that are returned in 'points' alternate between entrance points and exit points. The return value of the function is 0 if no intersections were found, -1 if point 'a0' lies inside the closed surface, or +1 if point 'a0' lies outside the closed surface. Either 'points' or 'cellIds' can be set to nullptr if you don't want to receive that information. This method is currently only implemented in vtkOBBTree.

Reimplemented in vtkStaticCellLocator, vtkCellTreeLocator, and vtkOBBTree.

◆ FindClosestPoint() [1/2]

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

Return the closest point and the cell which is closest to the point x.

The closest point is somewhere on a cell, it need not be one of the vertices of the cell.

◆ FindClosestPoint() [2/2]

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

Return the closest point and the cell which is closest to the point x.

The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This version takes in a vtkGenericCell to avoid allocating and deallocating the cell. This is much faster than the version which does not take a *cell, especially when this function is called many times in a row such as by a for loop, where the allocation and deallocation can be done only once outside the for loop. If a cell is found, "cell" contains the points and ptIds for the cell "cellId" upon exit.

Reimplemented in vtkStaticCellLocator, and vtkCellLocator.

◆ FindClosestPointWithinRadius() [1/3]

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

Return the closest point within a specified radius and the cell which is closest to the point x.

The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This method returns 1 if a point is found within the specified radius. If there are no cells within the specified radius, the method returns 0 and the values of closestPoint, cellId, subId, and dist2 are undefined.

◆ FindClosestPointWithinRadius() [2/3]

virtual vtkIdType vtkAbstractCellLocator::FindClosestPointWithinRadius ( double  x[3],
double  radius,
double  closestPoint[3],
vtkGenericCell cell,
vtkIdType cellId,
int subId,
double dist2 
)
virtual

Return the closest point within a specified radius and the cell which is closest to the point x.

The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This method returns 1 if a point is found within the specified radius. If there are no cells within the specified radius, the method returns 0 and the values of closestPoint, cellId, subId, and dist2 are undefined. This version takes in a vtkGenericCell to avoid allocating and deallocating the cell. This is much faster than the version which does not take a *cell, especially when this function is called many times in a row such as by a for loop, where the allocation and deallocation can be done only once outside the for loop. If a closest point is found, "cell" contains the points and ptIds for the cell "cellId" upon exit.

◆ FindClosestPointWithinRadius() [3/3]

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

Return the closest point within a specified radius and the cell which is closest to the point x.

The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This method returns 1 if a point is found within the specified radius. If there are no cells within the specified radius, the method returns 0 and the values of closestPoint, cellId, subId, and dist2 are undefined. This version takes in a vtkGenericCell to avoid allocating and deallocating the cell. This is much faster than the version which does not take a *cell, especially when this function is called many times in a row such as by a for loop, where the allocation and dealloction can be done only once outside the for loop. If a closest point is found, "cell" contains the points and ptIds for the cell "cellId" upon exit. If a closest point is found, inside returns the return value of the EvaluatePosition call to the closest cell; inside(=1) or outside(=0).

Reimplemented in vtkStaticCellLocator, and vtkCellLocator.

◆ FindCellsWithinBounds()

virtual void vtkAbstractCellLocator::FindCellsWithinBounds ( double bbox,
vtkIdList cells 
)
virtual

Return a list of unique cell ids inside of a given bounding box.

The user must provide the vtkIdList to populate. This method returns data only after the locator has been built.

Reimplemented in vtkCellLocator, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ FindCellsAlongLine()

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

Given a finite line defined by the two points (p1,p2), return the list of unique cell ids in the buckets containing the line.

It is possible that an empty cell list is returned. The user must provide the vtkIdList to populate. This method returns data only after the locator has been built.

Reimplemented in vtkCellLocator, and vtkStaticCellLocator.

◆ FindCell() [1/2]

virtual vtkIdType vtkAbstractCellLocator::FindCell ( double  x[3])
virtual

Returns the Id of the cell containing the point, returns -1 if no cell found.

This interface uses a tolerance of zero

Reimplemented in vtkCellTreeLocator, and vtkStaticCellLocator.

◆ FindCell() [2/2]

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

Find the cell containing a given point.

returns -1 if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store the information.

Reimplemented in vtkModifiedBSPTree, vtkCellLocator, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ InsideCellBounds()

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

Quickly test if a point is inside the bounds of a particular cell.

Some locators cache cell bounds and this function can make use of fast access to the data.

Reimplemented in vtkModifiedBSPTree.

◆ StoreCellBounds()

virtual bool vtkAbstractCellLocator::StoreCellBounds ( )
protectedvirtual

This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array.

Subsequent calls to InsideCellBounds(...) can make use of the data A valid dataset must be present for this to work. Returns true if bounds wre copied, false otherwise.

◆ FreeCellBounds()

virtual void vtkAbstractCellLocator::FreeCellBounds ( )
protectedvirtual

Member Data Documentation

◆ NumberOfCellsPerNode

int vtkAbstractCellLocator::NumberOfCellsPerNode
protected

Definition at line 286 of file vtkAbstractCellLocator.h.

◆ RetainCellLists

vtkTypeBool vtkAbstractCellLocator::RetainCellLists
protected

Definition at line 287 of file vtkAbstractCellLocator.h.

◆ CacheCellBounds

vtkTypeBool vtkAbstractCellLocator::CacheCellBounds
protected

Definition at line 288 of file vtkAbstractCellLocator.h.

◆ LazyEvaluation

vtkTypeBool vtkAbstractCellLocator::LazyEvaluation
protected

Definition at line 289 of file vtkAbstractCellLocator.h.

◆ UseExistingSearchStructure

vtkTypeBool vtkAbstractCellLocator::UseExistingSearchStructure
protected

Definition at line 290 of file vtkAbstractCellLocator.h.

◆ GenericCell

vtkGenericCell* vtkAbstractCellLocator::GenericCell
protected

Definition at line 291 of file vtkAbstractCellLocator.h.

◆ CellBounds

double(* vtkAbstractCellLocator::CellBounds)[6]
protected

Definition at line 292 of file vtkAbstractCellLocator.h.


The documentation for this class was generated from the following file: