abstract base class for objects that accelerate spatial searches More...

#include <vtkLocator.h>

Inheritance diagram for vtkLocator:

Collaboration diagram for vtkLocator:

Public Member Functions
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 void	SetDataSet (vtkDataSet *)
	Build the locator from the points/cells defining this dataset. More...

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


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

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


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 ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...

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

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


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

virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations. 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
	Handle the PointSet <-> Locator loop. 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...

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

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

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

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

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

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

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). 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	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

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

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

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

Protected Member Functions
	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 ()
	These methods allow a command to exclusively grab all events. More...

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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDataSet *	DataSet

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkObject	Superclass
	Standard type and print methods. More...

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

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

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

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

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

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

Additional Inherited Members
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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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

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 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). More...

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

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

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

abstract base class for objects that accelerate spatial searches

vtkLocator is an abstract base class for spatial search objects, or locators. The principle behind locators is that they divide 3-space into small regions (or "buckets") that can be quickly found in response to queries about point location, line intersection, or object-object intersection.

The purpose of this base class is to provide data members and methods shared by all locators. The GenerateRepresentation() is one such interesting method. This method works in conjunction with vtkLocatorFilter to create polygonal representations for the locator. For example, if the locator is an OBB tree (i.e., vtkOBBTree.h), then the representation is a set of one or more oriented bounding boxes, depending upon the specified level.

Locators typically work as follows. One or more "entities", such as points or cells, are inserted into the locator structure. These entities are associated with one or more buckets. Then, when performing geometric operations, the operations are performed first on the buckets, and then if the operation tests positive, then on the entities in the bucket. For example, during collision tests, the locators are collided first to identify intersecting buckets. If an intersection is found, more expensive operations are then carried out on the entities in the bucket.

To obtain good performance, locators are often organized in a tree structure. In such a structure, there are frequently multiple "levels" corresponding to different nodes in the tree. So the word level (in the context of the locator) can be used to specify a particular representation in the tree. For example, in an octree (which is a tree with 8 children), level 0 is the bounding box, or root octant, and level 1 consists of its eight children.

Warning: There is a concept of static and incremental locators. Static locators are constructed one time, and then support appropriate queries. Incremental locators may have data inserted into them over time (e.g., adding new points during the process of isocontouring).

See also: vtkPointLocator vtkCellLocator vtkOBBTree vtkMergePoints

Online Examples:

DataStructureComparison

Definition at line 88 of file vtkLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkLocator::Superclass

Standard type and print methods.

Definition at line 95 of file vtkLocator.h.

Constructor & Destructor Documentation

◆ vtkLocator()

vtkLocator::vtkLocator ( )

protected

◆ ~vtkLocator()

vtkLocator::~vtkLocator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard type and print methods.

◆ IsA()

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

virtual

Standard type and print methods.

Reimplemented from vtkObjectBase.

Reimplemented in vtkAbstractCellLocator, vtkAbstractPointLocator, vtkCellLocator, vtkIncrementalOctreePointLocator, vtkIncrementalPointLocator, vtkKdTree, vtkKdTreePointLocator, vtkMergePoints, vtkNonMergingPointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticCellLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkModifiedBSPTree, vtkCellTreeLocator, vtkOBBTree, vtkPKdTree, and vtkSMPMergePoints.

◆ SafeDownCast()

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

static

Standard type and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented in vtkAbstractCellLocator, vtkAbstractPointLocator, vtkCellLocator, vtkIncrementalOctreePointLocator, vtkIncrementalPointLocator, vtkKdTree, vtkKdTreePointLocator, vtkMergePoints, vtkNonMergingPointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticCellLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkModifiedBSPTree, vtkCellTreeLocator, vtkOBBTree, vtkPKdTree, and vtkSMPMergePoints.

◆ NewInstance()

vtkLocator * vtkLocator::NewInstance ( ) const

Standard type and print methods.

◆ PrintSelf()

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

overridevirtual

Standard type and print methods.

Reimplemented from vtkObject.

Reimplemented in vtkMergePoints, vtkNonMergingPointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticCellLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkModifiedBSPTree, vtkCellTreeLocator, vtkOBBTree, vtkPKdTree, and vtkSMPMergePoints.

◆ SetDataSet()

virtual void vtkLocator::SetDataSet ( vtkDataSet * )

virtual

Build the locator from the points/cells defining this dataset.

Reimplemented in vtkKdTree.

◆ GetDataSet()

virtual vtkDataSet * vtkLocator::GetDataSet ( )

virtual

Build the locator from the points/cells defining this dataset.

Reimplemented in vtkKdTree.

◆ SetMaxLevel()

virtual void vtkLocator::SetMaxLevel ( int )

virtual

Set the maximum allowable level for the tree.

If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.

◆ GetMaxLevel()

virtual int vtkLocator::GetMaxLevel ( )

virtual

Set the maximum allowable level for the tree.

If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.

◆ GetLevel()

virtual int vtkLocator::GetLevel ( )

virtual

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

The value of this ivar may change each time the locator is built. Initial value is 8.

◆ SetAutomatic()

virtual void vtkLocator::SetAutomatic ( vtkTypeBool )

virtual

Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

If not set, there will be an explicit method to control the construction of the locator (found in the subclass).

◆ GetAutomatic()

virtual vtkTypeBool vtkLocator::GetAutomatic ( )

virtual

Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

If not set, there will be an explicit method to control the construction of the locator (found in the subclass).

◆ AutomaticOn()

virtual void vtkLocator::AutomaticOn ( )

virtual

Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

If not set, there will be an explicit method to control the construction of the locator (found in the subclass).

◆ AutomaticOff()

virtual void vtkLocator::AutomaticOff ( )

virtual

Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

If not set, there will be an explicit method to control the construction of the locator (found in the subclass).

◆ SetTolerance()

virtual void vtkLocator::SetTolerance ( double )

virtual

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

◆ GetTolerance()

virtual double vtkLocator::GetTolerance ( )

virtual

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

◆ Update()

virtual void vtkLocator::Update ( )

virtual

Cause the locator to rebuild itself if it or its input dataset has changed.

◆ Initialize()

virtual void vtkLocator::Initialize ( )

virtual

Initialize locator.

Frees memory and resets object as appropriate.

Reimplemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkStaticPointLocator, and vtkStaticPointLocator2D.

◆ BuildLocator()

virtual void vtkLocator::BuildLocator ( )

pure virtual

Build the locator from the input dataset.

Implemented in vtkCellLocator, vtkIncrementalOctreePointLocator, vtkKdTree, vtkKdTreePointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticCellLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkModifiedBSPTree, vtkCellTreeLocator, vtkOBBTree, and vtkPKdTree.

◆ FreeSearchStructure()

virtual void vtkLocator::FreeSearchStructure ( )

pure virtual

Free the memory required for the spatial data structure.

Implemented in vtkCellLocator, vtkIncrementalOctreePointLocator, vtkKdTree, vtkKdTreePointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticCellLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkModifiedBSPTree, vtkCellTreeLocator, and vtkOBBTree.

◆ GenerateRepresentation()

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

pure virtual

Method to build a representation at a particular level.

Note that the method GetLevel() returns the maximum number of levels available for the tree. You must provide a vtkPolyData object into which to place the data.

Implemented in vtkCellLocator, vtkKdTree, vtkKdTreePointLocator, vtkOctreePointLocator, vtkPointLocator, vtkStaticCellLocator, vtkStaticPointLocator, vtkStaticPointLocator2D, vtkModifiedBSPTree, vtkCellTreeLocator, vtkOBBTree, and vtkIncrementalOctreePointLocator.

◆ GetBuildTime()

virtual vtkMTimeType vtkLocator::GetBuildTime ( )

virtual

Return the time of the last data structure build.

◆ Register()

void vtkLocator::Register ( vtkObjectBase * o )

overridevirtual

Handle the PointSet <-> Locator loop.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkLocator::UnRegister ( vtkObjectBase * o )

overridevirtual

Handle the PointSet <-> Locator loop.

Reimplemented from vtkObjectBase.

◆ ReportReferences()

void vtkLocator::ReportReferences ( vtkGarbageCollector * )

overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

◆ DataSet

vtkDataSet* vtkLocator::DataSet

protected

Definition at line 195 of file vtkLocator.h.

◆ Automatic

vtkTypeBool vtkLocator::Automatic

protected

Definition at line 196 of file vtkLocator.h.

◆ Tolerance

double vtkLocator::Tolerance

protected

Definition at line 197 of file vtkLocator.h.

◆ MaxLevel

int vtkLocator::MaxLevel

protected

Definition at line 198 of file vtkLocator.h.

◆ Level

int vtkLocator::Level

protected

Definition at line 199 of file vtkLocator.h.

◆ BuildTime

vtkTimeStamp vtkLocator::BuildTime

protected

Definition at line 201 of file vtkLocator.h.

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

Common/DataModel/vtkLocator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkLocator()

◆ ~vtkLocator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetDataSet()

◆ GetDataSet()

◆ SetMaxLevel()

◆ GetMaxLevel()

◆ GetLevel()

◆ SetAutomatic()

◆ GetAutomatic()

◆ AutomaticOn()

◆ AutomaticOff()

◆ SetTolerance()

◆ GetTolerance()

◆ Update()

◆ Initialize()

◆ BuildLocator()

◆ FreeSearchStructure()

◆ GenerateRepresentation()

◆ GetBuildTime()

◆ Register()

◆ UnRegister()

◆ ReportReferences()

Member Data Documentation

◆ DataSet

◆ Automatic

◆ Tolerance

◆ MaxLevel

◆ Level

◆ BuildTime