Documentation for vtkCellLocator

vtkCellLocator - octree-based spatial search object to quickly locate cells

Description:

vtkCellLocator is a spatial search object to quickly locate cells in 3D. vtkCellLocator uses a uniform-level octree subdivision, where each octant (an octant is also referred to as a bucket) carries an indication of whether it is empty or not, and each leaf octant carries a list of the cells inside of it. (An octant is not empty if it has one or more cells inside of it.) Typical operations are intersection with a line to return candidate cells, or intersection with another vtkCellLocator to return candidate cells.

Caveats:

Many other types of spatial locators have been developed, such as variable depth octrees and kd-trees. These are often more efficient for the operations described here. vtkCellLocator has been designed for subclassing; so these locators can be derived if necessary.

See Also:

vtkLocator vtkPointLocator vtkOBBTree

Methods:

	void vtkCellLocator ()
	void vtkCellLocator ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	static vtkCellLocator *New ()
	void SetNumberOfCellsPerBucket (int )
	int GetNumberOfCellsPerBucket ()
	int IntersectWithLine (float ,float ,float ,float & ,float ,float ,int &)
	int IntersectWithLine (float ,float ,float ,float & ,float ,float ,int & ,int &)
	vtkIdList *GetCells (int )
	void FreeSearchStructure ()
	void BuildLocator ()
	void GenerateRepresentation (int ,vtkPolyData *)
	void MarkParents (void * ,int ,int ,int ,int ,int )
	void GetChildren (int ,int ,int )
	int GenerateIndex (int ,int ,int ,int ,int ,int &)
	void GenerateFace (int ,int ,int ,int ,int ,vtkPoints * ,vtkCellArray *)

Detailed Method Descriptions:

Construct with automatic computation of divisions, averaging 25 cells per bucket.

static vtkCellLocator *New ()

Specify the average number of cells in each octant.

	void SetNumberOfCellsPerBucket (int )
	int GetNumberOfCellsPerBucket ()

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

int IntersectWithLine (float ,float ,float ,float & ,float ,float ,int &)

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

int IntersectWithLine (float ,float ,float ,float & ,float ,float ,int & ,int &)

Get the cells in a particular bucket.

vtkIdList *GetCells (int )

Satisfy vtkLocator abstract interface

	void FreeSearchStructure ()
	void BuildLocator ()
	void GenerateRepresentation (int ,vtkPolyData *)