vtkIncrementalPointLocator Class Reference

Abstract class in support of both point location and point insertion. More...

#include <vtkIncrementalPointLocator.h>

Inheritance diagram for vtkIncrementalPointLocator:

Collaboration diagram for vtkIncrementalPointLocator:

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

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.
vtkIncrementalPointLocator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.
virtual vtkIdType	FindClosestInsertedPoint (const double x[3])=0
	Given a point x assumed to be covered by the search structure, return the index of the closest point (already inserted to the search structure) regardless of the associated minimum squared distance relative to the squared insertion-tolerance distance.
virtual int	InitPointInsertion (vtkPoints *newPts, const double bounds[6])=0
	Initialize the point insertion process.
virtual int	InitPointInsertion (vtkPoints *newPts, const double bounds[6], vtkIdType estSize)=0
	Initialize the point insertion process.
virtual vtkIdType	IsInsertedPoint (double x, double y, double z)=0
	Determine whether or not a given point has been inserted.
virtual vtkIdType	IsInsertedPoint (const double x[3])=0
	Determine whether or not a given point has been inserted.
virtual int	InsertUniquePoint (const double x[3], vtkIdType &ptId)=0
	Insert a point unless there has been a duplicate in the search structure.
virtual void	InsertPoint (vtkIdType ptId, const double x[3])=0
	Insert a given point with a specified point index ptId.
virtual vtkIdType	InsertNextPoint (const double x[3])=0
	Insert a given point and return the point index.
Public Member Functions inherited from vtkAbstractPointLocator
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.
vtkAbstractPointLocator *	NewInstance () const
	Standard type and print methods.
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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkIncrementalPointLocator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractPointLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.
static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)
	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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.
	vtkIncrementalPointLocator ()
	~vtkIncrementalPointLocator () override
Protected Member Functions inherited from vtkAbstractPointLocator
	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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkAbstractPointLocator
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

Detailed Description

Abstract class in support of both point location and point insertion.

Compared to a static point locator for pure location functionalities through some search structure established from a fixed set of points, an incremental point locator allows for, in addition, point insertion capabilities, with the search structure maintaining a dynamically increasing number of points. There are two incremental point locators, i.e., vtkPointLocator and vtkIncrementalOctreePointLocator. As opposed to the uniform bin-based search structure (adopted in vtkPointLocator) with a fixed spatial resolution, an octree mechanism (employed in vtkIncrementalOctreePointlocator) resorts to a hierarchy of tree-like sub-division of the 3D data domain. Thus it enables data-aware multi- resolution and accordingly accelerated point location as well as point insertion, particularly when handling a radically imbalanced layout of points as not uncommon in datasets defined on adaptive meshes. In other words, vtkIncrementalOctreePointLocator is an octree-based accelerated implementation of all functionalities of vtkPointLocator.

See also

vtkLocator, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkMergePoints vtkStaticPointLocator

Definition at line 40 of file vtkIncrementalPointLocator.h.

Member Typedef Documentation

Superclass

typedef vtkAbstractPointLocator vtkIncrementalPointLocator::Superclass

Definition at line 43 of file vtkIncrementalPointLocator.h.

Constructor & Destructor Documentation

vtkIncrementalPointLocator()

vtkIncrementalPointLocator::vtkIncrementalPointLocator ( )

protected

~vtkIncrementalPointLocator()

vtkIncrementalPointLocator::~vtkIncrementalPointLocator ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

virtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

Reimplemented in vtkIncrementalOctreePointLocator, vtkMergePoints, vtkNonMergingPointLocator, vtkPointLocator, and vtkSMPMergePoints.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkIncrementalPointLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

Reimplemented in vtkIncrementalOctreePointLocator, vtkMergePoints, vtkNonMergingPointLocator, vtkPointLocator, and vtkSMPMergePoints.

NewInstance()

vtkIncrementalPointLocator * vtkIncrementalPointLocator::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

Reimplemented in vtkMergePoints, vtkNonMergingPointLocator, vtkPointLocator, and vtkSMPMergePoints.

FindClosestInsertedPoint()

virtual vtkIdType vtkIncrementalPointLocator::FindClosestInsertedPoint ( const double  x[3] )

pure virtual

Given a point x assumed to be covered by the search structure, return the index of the closest point (already inserted to the search structure) regardless of the associated minimum squared distance relative to the squared insertion-tolerance distance.

This method is used when performing incremental point insertion. Note -1 indicates that no point is found. InitPointInsertion() should have been called in advance.

Implemented in vtkIncrementalOctreePointLocator, and vtkPointLocator.

InitPointInsertion() [1/2]

virtual int vtkIncrementalPointLocator::InitPointInsertion ( vtkPoints *  newPts, const double  bounds[6]  )

pure virtual

Initialize the point insertion process.

newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall.

Implemented in vtkPointLocator, and vtkIncrementalOctreePointLocator.

InitPointInsertion() [2/2]

virtual int vtkIncrementalPointLocator::InitPointInsertion ( vtkPoints *  newPts, const double  bounds[6], vtkIdType  estSize  )

pure virtual

Initialize the point insertion process.

newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall.

Implemented in vtkPointLocator, and vtkIncrementalOctreePointLocator.

IsInsertedPoint() [1/2]

virtual vtkIdType vtkIncrementalPointLocator::IsInsertedPoint ( double  x, double  y, double  z  )

pure virtual

Determine whether or not a given point has been inserted.

Return the id of the already inserted point if true, else return -1. InitPointInsertion() should have been called in advance.

Implemented in vtkIncrementalOctreePointLocator, vtkMergePoints, vtkPointLocator, and vtkNonMergingPointLocator.

IsInsertedPoint() [2/2]

virtual vtkIdType vtkIncrementalPointLocator::IsInsertedPoint ( const double  x[3] )

pure virtual

Determine whether or not a given point has been inserted.

Return the id of the already inserted point if true, else return -1. InitPointInsertion() should have been called in advance.

Implemented in vtkIncrementalOctreePointLocator, vtkMergePoints, vtkPointLocator, and vtkNonMergingPointLocator.

InsertUniquePoint()

virtual int vtkIncrementalPointLocator::InsertUniquePoint ( const double  x[3], vtkIdType &  ptId  )

pure virtual

Insert a point unless there has been a duplicate in the search structure.

Return 0 if the point was already in the list, otherwise return 1. If the point was not in the list, it will be ADDED. In either case, the id of the point (newly inserted or not) is returned in the ptId argument. This method is not thread safe.

Implemented in vtkIncrementalOctreePointLocator, vtkMergePoints, vtkNonMergingPointLocator, and vtkPointLocator.

InsertPoint()

virtual void vtkIncrementalPointLocator::InsertPoint ( vtkIdType  ptId, const double  x[3]  )

pure virtual

Insert a given point with a specified point index ptId.

InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.

Implemented in vtkIncrementalOctreePointLocator, and vtkPointLocator.

InsertNextPoint()

virtual vtkIdType vtkIncrementalPointLocator::InsertNextPoint ( const double  x[3] )

pure virtual

Insert a given point and return the point index.

InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.

Implemented in vtkIncrementalOctreePointLocator, and vtkPointLocator.

---

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

• Common/DataModel/vtkIncrementalPointLocator.h