VTK
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>

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

Public Types

typedef vtkLocator Superclass
 Standard type and print methods. More...
 
- Public Types inherited from vtkLocator
typedef vtkObject Superclass
 Standard type and print methods. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAbstractPointLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkIdType FindClosestPoint (const double x[3])=0
 Given a position x, return the id of the point closest to it. More...
 
vtkIdType FindClosestPoint (double x, double y, double z)
 
virtual vtkIdType FindClosestPointWithinRadius (double radius, const double x[3], double &dist2)=0
 Given a position x and a radius r, return the id of the point closest to the point in that radius. More...
 
virtual void FindClosestNPoints (int N, const double x[3], vtkIdList *result)=0
 Find the closest N points to a position. More...
 
void FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
 
virtual void FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)=0
 Find all points within a specified radius R of position x. More...
 
void FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
 
virtual doubleGetBounds ()
 Provide an accessor to the bounds. More...
 
virtual void GetBounds (double *)
 
virtual vtkIdType GetNumberOfBuckets ()
 Return the total number of buckets in the locator. More...
 
- Public Member Functions inherited from vtkLocator
vtkLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetDataSet (vtkDataSet *)
 Build the locator from the points/cells defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 
virtual void SetMaxLevel (int)
 Set the maximum allowable level for the tree. More...
 
virtual int GetMaxLevel ()
 
virtual int GetLevel ()
 Get the level of the locator (determined automatically if Automatic is true). More...
 
virtual void SetAutomatic (vtkTypeBool)
 Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...
 
virtual vtkTypeBool GetAutomatic ()
 
virtual void AutomaticOn ()
 
virtual void AutomaticOff ()
 
virtual void SetTolerance (double)
 Specify absolute tolerance (in world coordinates) for performing geometric operations. More...
 
virtual double GetTolerance ()
 
virtual void Update ()
 Cause the locator to rebuild itself if it or its input dataset has changed. More...
 
virtual void Initialize ()
 Initialize locator. More...
 
virtual void BuildLocator ()=0
 Build the locator from the input dataset. More...
 
virtual void FreeSearchStructure ()=0
 Free the memory required for the spatial data structure. More...
 
virtual void GenerateRepresentation (int level, vtkPolyData *pd)=0
 Method to build a representation at a particular level. More...
 
virtual vtkMTimeType GetBuildTime ()
 Return the time of the last data structure build. More...
 
void Register (vtkObjectBase *o) override
 Handle the PointSet <-> Locator loop. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractPointLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLocator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPointLocator ()
 
 ~vtkAbstractPointLocator () override
 
- Protected Member Functions inherited from vtkLocator
 vtkLocator ()
 
 ~vtkLocator () override
 
void ReportReferences (vtkGarbageCollector *) override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Bounds [6]
 
vtkIdType NumberOfBuckets
 
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
 
vtkTypeBool Automatic
 
double Tolerance
 
int MaxLevel
 
int Level
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.

See also
vtkPointLocator vtkStaticPointLocator vtkMergePoints
Tests:
vtkAbstractPointLocator (Tests)

Definition at line 41 of file vtkAbstractPointLocator.h.

Member Typedef Documentation

◆ Superclass

Standard type and print methods.

Definition at line 48 of file vtkAbstractPointLocator.h.

Constructor & Destructor Documentation

◆ vtkAbstractPointLocator()

vtkAbstractPointLocator::vtkAbstractPointLocator ( )
protected

◆ ~vtkAbstractPointLocator()

vtkAbstractPointLocator::~vtkAbstractPointLocator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkAbstractPointLocator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkAbstractPointLocator::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 vtkLocator.

Reimplemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.

◆ SafeDownCast()

static vtkAbstractPointLocator* vtkAbstractPointLocator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractPointLocator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractPointLocator* vtkAbstractPointLocator::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractPointLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

Reimplemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.

◆ FindClosestPoint() [1/2]

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.

Implemented in vtkIncrementalOctreePointLocator, vtkOctreePointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, and vtkKdTreePointLocator.

◆ FindClosestPoint() [2/2]

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

◆ FindClosestPointWithinRadius()

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.

Implemented in vtkIncrementalOctreePointLocator, vtkOctreePointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, and vtkKdTreePointLocator.

◆ FindClosestNPoints() [1/2]

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.

Implemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkOctreePointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, and vtkKdTreePointLocator.

◆ FindClosestNPoints() [2/2]

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

◆ FindPointsWithinRadius() [1/2]

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.

Implemented in vtkOctreePointLocator, vtkPointLocator, vtkIncrementalOctreePointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, and vtkKdTreePointLocator.

◆ FindPointsWithinRadius() [2/2]

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

◆ GetBounds() [1/2]

virtual double* vtkAbstractPointLocator::GetBounds ( )
inlinevirtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented in vtkIncrementalOctreePointLocator, and vtkOctreePointLocator.

Definition at line 103 of file vtkAbstractPointLocator.h.

◆ GetBounds() [2/2]

virtual void vtkAbstractPointLocator::GetBounds ( double )
virtual

◆ GetNumberOfBuckets()

virtual vtkIdType vtkAbstractPointLocator::GetNumberOfBuckets ( )
virtual

Return the total number of buckets in the locator.

This has meaning only after the locator is constructed.

Reimplemented in vtkSMPMergePoints.

Member Data Documentation

◆ Bounds

double vtkAbstractPointLocator::Bounds[6]
protected

Definition at line 119 of file vtkAbstractPointLocator.h.

◆ NumberOfBuckets

vtkIdType vtkAbstractPointLocator::NumberOfBuckets
protected

Definition at line 120 of file vtkAbstractPointLocator.h.


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