VTK
9.0.20210409
|
abstract base class for objects that accelerate spatial searches More...
#include <vtkLocator.h>
Public Types | |
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... | |
vtkLocator * | NewInstance () 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 vtkDataSet * | GetDataSet () |
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... | |
![]() | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. 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 | 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... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
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... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkLocator () | |
~vtkLocator () override | |
void | ReportReferences (vtkGarbageCollector *) override |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkDataSet * | DataSet |
vtkTypeBool | Automatic |
double | Tolerance |
int | MaxLevel |
int | Level |
vtkTimeStamp | BuildTime |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 69 of file vtkLocator.h.
typedef vtkObject vtkLocator::Superclass |
Standard type and print methods.
Definition at line 76 of file vtkLocator.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkObjectBase.
Reimplemented in vtkSMPMergePoints, vtkPKdTree, vtkOBBTree, vtkCellTreeLocator, vtkModifiedBSPTree, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticCellLocator, vtkPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkMergePoints, vtkKdTreePointLocator, vtkKdTree, vtkIncrementalPointLocator, vtkIncrementalOctreePointLocator, vtkCellLocator, vtkAbstractPointLocator, and vtkAbstractCellLocator.
|
static |
|
protectedvirtual |
Reimplemented in vtkSMPMergePoints, vtkPKdTree, vtkOBBTree, vtkCellTreeLocator, vtkModifiedBSPTree, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticCellLocator, vtkPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkMergePoints, vtkKdTreePointLocator, vtkKdTree, vtkIncrementalPointLocator, vtkIncrementalOctreePointLocator, vtkCellLocator, vtkAbstractPointLocator, and vtkAbstractCellLocator.
vtkLocator* vtkLocator::NewInstance | ( | ) | const |
|
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 vtkSMPMergePoints, vtkPKdTree, vtkOBBTree, vtkCellTreeLocator, vtkModifiedBSPTree, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticCellLocator, vtkPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, and vtkMergePoints.
|
virtual |
Build the locator from the points/cells defining this dataset.
Reimplemented in vtkKdTree.
|
virtual |
Reimplemented in vtkKdTree.
|
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.
|
virtual |
|
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.
|
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).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Specify absolute tolerance (in world coordinates) for performing geometric operations.
|
virtual |
|
virtual |
Cause the locator to rebuild itself if it or its input dataset has changed.
|
virtual |
Initialize locator.
Frees memory and resets object as appropriate.
Reimplemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, and vtkIncrementalOctreePointLocator.
|
pure virtual |
Build the locator from the input dataset.
Implemented in vtkPKdTree, vtkOBBTree, vtkCellTreeLocator, vtkModifiedBSPTree, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticCellLocator, vtkPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, vtkKdTree, vtkIncrementalOctreePointLocator, and vtkCellLocator.
|
pure virtual |
Free the memory required for the spatial data structure.
Implemented in vtkOBBTree, vtkCellTreeLocator, vtkModifiedBSPTree, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticCellLocator, vtkPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, vtkKdTree, vtkIncrementalOctreePointLocator, and vtkCellLocator.
|
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 vtkIncrementalOctreePointLocator, vtkOBBTree, vtkCellTreeLocator, vtkModifiedBSPTree, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkStaticCellLocator, vtkPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, vtkKdTree, and vtkCellLocator.
|
virtual |
Return the time of the last data structure build.
|
overridevirtual |
Handle the PointSet <-> Locator loop.
Reimplemented from vtkObjectBase.
|
overridevirtual |
Decrease the reference count (release by another object).
This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).
Reimplemented from vtkObjectBase.
|
overrideprotectedvirtual |
Reimplemented from vtkObjectBase.
|
protected |
Definition at line 176 of file vtkLocator.h.
|
protected |
Definition at line 177 of file vtkLocator.h.
|
protected |
Definition at line 178 of file vtkLocator.h.
|
protected |
Definition at line 179 of file vtkLocator.h.
|
protected |
Definition at line 180 of file vtkLocator.h.
|
protected |
Definition at line 182 of file vtkLocator.h.