VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractPointLocator Class Referenceabstract

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

#include <vtkAbstractPointLocator.h>

Inherits vtkLocator.

Public Types

typedef vtkLocator Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAbstractPointLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkIdType FindClosestPoint (const double x[3])=0
 
vtkIdType FindClosestPoint (double x, double y, double z)
 
virtual vtkIdType FindClosestPointWithinRadius (double radius, const double x[3], double &dist2)=0
 
virtual void FindClosestNPoints (int N, const double x[3], vtkIdList *result)=0
 
void FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
 
virtual void FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)=0
 
void FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
 
virtual double * GetBounds ()
 
virtual void GetBounds (double *)
 
virtual void FreeSearchStructure ()=0
 
virtual void BuildLocator ()=0
 
virtual void GenerateRepresentation (int level, vtkPolyData *pd)=0
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAbstractPointLocatorSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPointLocator ()
 
virtual ~vtkAbstractPointLocator ()
 

Protected Attributes

double Bounds [6]
 

Detailed Description

abstract class to quickly locate points in 3-space

vtkAbstractPointLocator is an abstract spatial search object to quickly locate points in 3D. vtkAbstractPointLocator works by dividing a specified region of space into "rectangular" buckets, and then keeping a list of points that lie in each bucket. Typical operation involves giving a position in 3D and finding the closest point. The points are provided from the specified dataset input.

Tests:
vtkAbstractPointLocator (Tests)

Definition at line 37 of file vtkAbstractPointLocator.h.

Member Typedef Documentation

Definition at line 40 of file vtkAbstractPointLocator.h.

Constructor & Destructor Documentation

vtkAbstractPointLocator::vtkAbstractPointLocator ( )
protected
virtual vtkAbstractPointLocator::~vtkAbstractPointLocator ( )
protectedvirtual

Member Function Documentation

static int vtkAbstractPointLocator::IsTypeOf ( const char *  type)
static
virtual int vtkAbstractPointLocator::IsA ( const char *  type)
virtual
static vtkAbstractPointLocator* vtkAbstractPointLocator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAbstractPointLocator::NewInstanceInternal ( ) const
protectedvirtual
vtkAbstractPointLocator* vtkAbstractPointLocator::NewInstance ( ) const
void vtkAbstractPointLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual vtkIdType vtkAbstractPointLocator::FindClosestPoint ( const double  x[3])
pure 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.

vtkIdType vtkAbstractPointLocator::FindClosestPoint ( double  x,
double  y,
double  z 
)

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 vtkAbstractPointLocator::FindClosestPointWithinRadius ( double  radius,
const double  x[3],
double &  dist2 
)
pure 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 vtkAbstractPointLocator::FindClosestNPoints ( int  N,
const double  x[3],
vtkIdList result 
)
pure 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.

void vtkAbstractPointLocator::FindClosestNPoints ( int  N,
double  x,
double  y,
double  z,
vtkIdList result 
)

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 vtkAbstractPointLocator::FindPointsWithinRadius ( double  R,
const double  x[3],
vtkIdList result 
)
pure 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.

void vtkAbstractPointLocator::FindPointsWithinRadius ( double  R,
double  x,
double  y,
double  z,
vtkIdList result 
)

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 double* vtkAbstractPointLocator::GetBounds ( )
inlinevirtual

Provide an accessor to the bounds.

Definition at line 86 of file vtkAbstractPointLocator.h.

virtual void vtkAbstractPointLocator::GetBounds ( double *  )
virtual

Provide an accessor to the bounds.

virtual void vtkAbstractPointLocator::FreeSearchStructure ( )
pure virtual

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

virtual void vtkAbstractPointLocator::BuildLocator ( )
pure virtual

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

virtual void vtkAbstractPointLocator::GenerateRepresentation ( int  level,
vtkPolyData *  pd 
)
pure virtual

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

Member Data Documentation

double vtkAbstractPointLocator::Bounds[6]
protected

Definition at line 102 of file vtkAbstractPointLocator.h.


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