vtkKdTreePointLocator Class Reference

#include <vtkKdTreePointLocator.h>

Inheritance diagram for vtkKdTreePointLocator:

[legend]

Collaboration diagram for vtkKdTreePointLocator:

[legend]

List of all members.

Detailed Description

class to quickly locate points in 3-space

vtkKdTreePointLocator is a wrapper class that derives from vtkAbstractPointLocator and calls the search functions in vtkKdTree.

See also:: vtkKdTree

Tests:: vtkKdTreePointLocator (Tests)

Definition at line 36 of file vtkKdTreePointLocator.h.


Public Types
typedef vtkAbstractPointLocator	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType	FindClosestPoint (const double x[3])

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

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

virtual void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)

virtual void	FreeSearchStructure ()
virtual void	BuildLocator ()
virtual void	GenerateRepresentation (int level, vtkPolyData *pd)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkKdTreePointLocator *	SafeDownCast (vtkObject *o)
static vtkKdTreePointLocator *	New ()
Protected Member Functions
	vtkKdTreePointLocator ()
virtual	~vtkKdTreePointLocator ()
Protected Attributes
vtkKdTree *	KdTree

Member Typedef Documentation

typedef vtkAbstractPointLocator vtkKdTreePointLocator::Superclass

Reimplemented from vtkAbstractPointLocator.

Definition at line 39 of file vtkKdTreePointLocator.h.

Constructor & Destructor Documentation

vtkKdTreePointLocator::vtkKdTreePointLocator ( ) [protected]

virtual vtkKdTreePointLocator::~vtkKdTreePointLocator ( ) [protected, virtual]

Member Function Documentation

virtual const char* vtkKdTreePointLocator::GetClassName ( ) [virtual]

Reimplemented from vtkAbstractPointLocator.

static int vtkKdTreePointLocator::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkAbstractPointLocator.

virtual int vtkKdTreePointLocator::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 vtkAbstractPointLocator.

static vtkKdTreePointLocator* vtkKdTreePointLocator::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkAbstractPointLocator.

static vtkKdTreePointLocator* vtkKdTreePointLocator::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

void vtkKdTreePointLocator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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 vtkAbstractPointLocator.

virtual vtkIdType vtkKdTreePointLocator::FindClosestPoint ( const double x[3] ) [virtual]

Given a position x, return the id of the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual vtkIdType vtkKdTreePointLocator::FindClosestPointWithinRadius	(	double	radius,
		const double	x[3],
		double &	dist2
	)			`[virtual]`

Given a position x and a radius r, return the id of the point closest to the point in that radius. dist2 returns the squared distance to the point.

Implements vtkAbstractPointLocator.

virtual void vtkKdTreePointLocator::FindClosestNPoints	(	int	N,
		const double	x[3],
		vtkIdList *	result
	)			`[virtual]`

Find the closest N points to a position. This returns the closest N points to a position. A faster method could be created that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual void vtkKdTreePointLocator::FindPointsWithinRadius	(	double	R,
		const double	x[3],
		vtkIdList *	result
	)			`[virtual]`

Find all points within a specified radius R of position x. The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual void vtkKdTreePointLocator::FreeSearchStructure ( ) [virtual]

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkAbstractPointLocator.

virtual void vtkKdTreePointLocator::BuildLocator ( ) [virtual]

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkAbstractPointLocator.