VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkKdTreePointLocator Class Reference

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

#include <vtkKdTreePointLocator.h>

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

List of all members.

Public Types

typedef vtkAbstractPointLocator Superclass
- Public Types inherited from vtkAbstractPointLocator
- Public Types inherited from vtkLocator
- Public Types inherited from vtkObject

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)
- Public Member Functions inherited from vtkAbstractPointLocator
vtkIdType FindClosestPoint (double x, double y, double z)
void FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
void FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
virtual double * GetBounds ()
virtual void GetBounds (double *)
- Public Member Functions inherited from vtkLocator
virtual void Update ()
virtual void Initialize ()
virtual void SetDataSet (vtkDataSet *)
virtual vtkDataSetGetDataSet ()
virtual void SetMaxLevel (int)
virtual int GetMaxLevel ()
virtual int GetLevel ()
virtual void SetAutomatic (int)
virtual int GetAutomatic ()
virtual void AutomaticOn ()
virtual void AutomaticOff ()
virtual void SetTolerance (double)
virtual double GetTolerance ()
virtual unsigned long GetBuildTime ()
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkKdTreePointLocatorSafeDownCast (vtkObject *o)
static vtkKdTreePointLocatorNew ()

Protected Member Functions

 vtkKdTreePointLocator ()
virtual ~vtkKdTreePointLocator ()
- Protected Member Functions inherited from vtkAbstractPointLocator
 vtkAbstractPointLocator ()
virtual ~vtkAbstractPointLocator ()
- Protected Member Functions inherited from vtkLocator
virtual void ReportReferences (vtkGarbageCollector *)
 vtkLocator ()
 ~vtkLocator ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkKdTreeKdTree
- Protected Attributes inherited from vtkAbstractPointLocator
double Bounds [6]
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
int Automatic
double Tolerance
int MaxLevel
int Level
vtkTimeStamp BuildTime
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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

Reimplemented from vtkAbstractPointLocator.

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

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.

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

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

Implements vtkAbstractPointLocator.


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: