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

class to quickly locate points in 3-space More...

#include <vtkKdTreePointLocator.h>

Inherits vtkAbstractPointLocator.

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 vtkKdTreePointLocatorSafeDownCast (vtkObject *o)
 
static vtkKdTreePointLocatorNew ()
 

Protected Member Functions

 vtkKdTreePointLocator ()
 
virtual ~vtkKdTreePointLocator ()
 

Protected Attributes

vtkKdTree * KdTree
 

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.

Member Typedef Documentation

typedef vtkAbstractPointLocator vtkKdTreePointLocator::Superclass

Definition at line 39 of file vtkKdTreePointLocator.h.

Constructor & Destructor Documentation

vtkKdTreePointLocator::vtkKdTreePointLocator ( )
protected
virtual vtkKdTreePointLocator::~vtkKdTreePointLocator ( )
protectedvirtual

Member Function Documentation

virtual const char* vtkKdTreePointLocator::GetClassName ( )
virtual
static int vtkKdTreePointLocator::IsTypeOf ( const char *  type)
static
virtual int vtkKdTreePointLocator::IsA ( const char *  type)
virtual
static vtkKdTreePointLocator* vtkKdTreePointLocator::SafeDownCast ( vtkObject o)
static
static vtkKdTreePointLocator* vtkKdTreePointLocator::New ( )
static
void vtkKdTreePointLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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.

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.

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.

virtual void vtkKdTreePointLocator::FreeSearchStructure ( )
virtual

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

virtual void vtkKdTreePointLocator::BuildLocator ( )
virtual

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

virtual void vtkKdTreePointLocator::GenerateRepresentation ( int  level,
vtkPolyData pd 
)
virtual

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

Member Data Documentation

vtkKdTree* vtkKdTreePointLocator::KdTree
protected

Definition at line 89 of file vtkKdTreePointLocator.h.


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