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

#include <vtkAbstractPointLocator.h>

Inheritance diagram for vtkAbstractPointLocator:

Collaboration diagram for vtkAbstractPointLocator:

Public Member Functions
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.


virtual vtkIdType	FindClosestPoint (const double x[3])=0
	Given a position x, return the id of the point closest to it.

vtkIdType	FindClosestPoint (double x, double y, double z)
	Given a position x, return the id of the point closest to it.


virtual void	FindClosestNPoints (int N, const double x[3], vtkIdList *result)=0
	Find the closest N points to a position.

void	FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
	Find the closest N points to a position.


virtual void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)=0
	Find all points within a specified radius R of position x.

void	FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
	Find all points within a specified radius R of position x.


virtual double *	GetBounds ()
	Provide an accessor to the bounds.

virtual void	GetBounds (double *)
	Provide an accessor to the bounds.


virtual vtkIdType	GetNumberOfBuckets ()
	Return the total number of buckets in the locator.

Public Member Functions inherited from vtkLocator
virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed.

virtual void	Initialize ()
	Initialize locator.

virtual void	BuildLocator ()=0
	Build the locator from the input dataset.

virtual void	ForceBuildLocator ()
	Build the locator from the input dataset (even if UseExistingSearchStructure is on).

virtual void	FreeSearchStructure ()=0
	Free the memory required for the spatial data structure.

virtual void	GenerateRepresentation (int level, vtkPolyData *pd)=0
	Method to build a representation at a particular level.

virtual void	SetDataSet (vtkDataSet *)
	Build the locator from the points/cells defining this dataset.

virtual vtkDataSet *	GetDataSet ()
	Build the locator from the points/cells defining this dataset.

virtual void	SetMaxLevel (int)
	Set the maximum allowable level for the tree.

virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree.

virtual int	GetLevel ()
	Get the level of the locator (determined automatically if Automatic is true).

virtual void	SetAutomatic (vtkTypeBool)
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual vtkTypeBool	GetAutomatic ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOn ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOff ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	SetTolerance (double)
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual void	SetUseExistingSearchStructure (vtkTypeBool)
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkTypeBool	GetUseExistingSearchStructure ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOn ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOff ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkMTimeType	GetBuildTime ()
	Return the time of the last data structure build.

bool	UsesGarbageCollector () const override
	Handle the PointSet <-> Locator loop.

vtkLocator *	NewInstance () const
	Standard type and print methods.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Protected Member Functions
	vtkAbstractPointLocator ()

	~vtkAbstractPointLocator () override

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

virtual void	BuildLocatorInternal ()
	This function is not pure virtual to maintain backwards compatibility.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Bounds [6]

vtkIdType	NumberOfBuckets

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	UseExistingSearchStructure

vtkTypeBool	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkLocator	Superclass
	Standard type and print methods.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.

vtkAbstractPointLocator *	NewInstance () const
	Standard type and print methods.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

Additional Inherited Members
Public Types inherited from vtkLocator
typedef vtkObject	Superclass
	Standard type and print methods.

Static Public Member Functions inherited from vtkLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 30 of file vtkAbstractPointLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkLocator vtkAbstractPointLocator::Superclass

Standard type and print methods.

Definition at line 37 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

Standard type and print methods.

◆ IsA()

virtual vtkTypeBool vtkAbstractPointLocator::IsA ( const char * type )

virtual

Standard type and print methods.

Reimplemented from vtkLocator.

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

◆ SafeDownCast()

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

static

Standard type and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractPointLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkLocator.

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

◆ NewInstance()

vtkAbstractPointLocator * vtkAbstractPointLocator::NewInstance ( ) const

Standard type and print methods.

◆ PrintSelf()

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

overridevirtual

Standard type and print methods.

Reimplemented from vtkObjectBase.

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

◆ 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, vtkKdTreePointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkPointLocator, vtkStaticPointLocator, and vtkStaticPointLocator2D.

◆ FindClosestPoint() [2/2]

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.

◆ 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, vtkKdTreePointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticPointLocator, and vtkStaticPointLocator2D.

◆ 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, vtkKdTreePointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, and vtkStaticPointLocator2D.

◆ FindClosestNPoints() [2/2]

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.

◆ 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 vtkIncrementalOctreePointLocator, vtkKdTreePointLocator, vtkPointLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticPointLocator2D, and vtkOctreePointLocator.

◆ FindPointsWithinRadius() [2/2]

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.

◆ GetBounds() [1/2]

virtual double * vtkAbstractPointLocator::GetBounds ( )

inlinevirtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented in vtkStaticPointLocator, vtkStaticPointLocator2D, vtkIncrementalOctreePointLocator, and vtkOctreePointLocator.

Definition at line 88 of file vtkAbstractPointLocator.h.

◆ GetBounds() [2/2]

virtual void vtkAbstractPointLocator::GetBounds ( double * )

virtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented in vtkStaticPointLocator, vtkStaticPointLocator2D, vtkIncrementalOctreePointLocator, vtkOctreePointLocator, and vtkStaticPointLocator2D.

◆ 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 104 of file vtkAbstractPointLocator.h.

◆ NumberOfBuckets

vtkIdType vtkAbstractPointLocator::NumberOfBuckets

protected

Definition at line 105 of file vtkAbstractPointLocator.h.

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

Common/DataModel/vtkAbstractPointLocator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractPointLocator()

◆ ~vtkAbstractPointLocator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ FindClosestPoint() [1/2]

◆ FindClosestPoint() [2/2]

◆ FindClosestPointWithinRadius()

◆ FindClosestNPoints() [1/2]

◆ FindClosestNPoints() [2/2]

◆ FindPointsWithinRadius() [1/2]

◆ FindPointsWithinRadius() [2/2]

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetNumberOfBuckets()

Member Data Documentation

◆ Bounds

◆ NumberOfBuckets