VTK
|
abstract base class for objects that accelerate spatial searches More...
#include <vtkLocator.h>
Public Member Functions | |
virtual void | Update () |
virtual void | Initialize () |
virtual void | BuildLocator ()=0 |
virtual void | FreeSearchStructure ()=0 |
virtual void | GenerateRepresentation (int level, vtkPolyData *pd)=0 |
virtual void | SetDataSet (vtkDataSet *) |
virtual vtkDataSet * | GetDataSet () |
virtual void | SetMaxLevel (int) |
virtual int | GetMaxLevel () |
virtual int | GetLevel () |
virtual void | SetAutomatic (int) |
virtual int | GetAutomatic () |
virtual void | AutomaticOn () |
virtual void | AutomaticOff () |
virtual void | SetTolerance (double) |
virtual double | GetTolerance () |
virtual unsigned long | GetBuildTime () |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
Public Member Functions inherited from vtkObject | |
vtkObject * | NewInstance () const |
virtual void | DebugOn () |
virtual void | DebugOff () |
bool | GetDebug () |
void | SetDebug (bool debugFlag) |
virtual void | Modified () |
virtual unsigned long | GetMTime () |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
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 *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
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) |
int | InvokeEvent (unsigned long event, void *callData) |
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 |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
void | SetReferenceCount (int) |
void | PrintRevisions (ostream &) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Protected Member Functions | |
vtkLocator () | |
~vtkLocator () | |
virtual void | ReportReferences (vtkGarbageCollector *) |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
virtual | ~vtkObject () |
virtual void | RegisterInternal (vtkObjectBase *, int check) |
virtual void | UnRegisterInternal (vtkObjectBase *, int check) |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
void | InternalReleaseFocus () |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkDataSet * | DataSet |
int | 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 |
typedef vtkObject | Superclass |
static int | IsTypeOf (const char *type) |
static vtkLocator * | SafeDownCast (vtkObjectBase *o) |
virtual int | IsA (const char *type) |
vtkLocator * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual vtkObjectBase * | NewInstanceInternal () const |
Additional Inherited Members | |
Public Types inherited from vtkObject | |
typedef vtkObjectBase | Superclass |
Static Public Member Functions inherited from vtkObject | |
static int | IsTypeOf (const char *type) |
static vtkObject * | SafeDownCast (vtkObjectBase *o) |
static vtkObject * | New () |
static void | BreakOnError () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
Static Public Member Functions inherited from vtkObjectBase | |
static int | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
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 68 of file vtkLocator.h.
typedef vtkObject vtkLocator::Superclass |
Standard type and print methods.
Definition at line 73 of file vtkLocator.h.
|
protected |
|
protected |
|
static |
Standard type and print methods.
|
virtual |
Standard type and print methods.
Reimplemented from vtkObject.
Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkKdTree, vtkStaticPointLocator, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkPKdTree, vtkCellTreeLocator, vtkCellLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkAbstractCellLocator, vtkNonMergingPointLocator, vtkAbstractPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.
|
static |
Standard type and print methods.
|
protectedvirtual |
Standard type and print methods.
Reimplemented from vtkObject.
Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkKdTree, vtkStaticPointLocator, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkPKdTree, vtkCellTreeLocator, vtkCellLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkAbstractCellLocator, vtkNonMergingPointLocator, vtkAbstractPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.
vtkLocator* vtkLocator::NewInstance | ( | ) | const |
Standard type and print methods.
|
virtual |
Standard type and print methods.
Reimplemented from vtkObject.
Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkStaticPointLocator, vtkPointLocator, vtkPKdTree, vtkCellTreeLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, and vtkMergePoints.
|
virtual |
Build the locator from the points/cells defining this dataset.
Reimplemented in vtkKdTree.
|
virtual |
Build the locator from the points/cells defining this dataset.
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 |
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 |
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 |
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 |
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 |
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 |
Specify absolute tolerance (in world coordinates) for performing geometric operations.
|
virtual |
Specify absolute tolerance (in world coordinates) for performing geometric operations.
|
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 vtkPointLocator, vtkStaticPointLocator, vtkIncrementalOctreePointLocator, and vtkIncrementalPointLocator.
|
pure virtual |
Build the locator from the input dataset.
Implemented in vtkKdTree, vtkPointLocator, vtkModifiedBSPTree, vtkOBBTree, vtkCellLocator, vtkStaticPointLocator, vtkCellTreeLocator, vtkIncrementalOctreePointLocator, vtkAbstractPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, and vtkPKdTree.
|
pure virtual |
Free the memory required for the spatial data structure.
Implemented in vtkKdTree, vtkPointLocator, vtkOBBTree, vtkModifiedBSPTree, vtkCellLocator, vtkOctreePointLocator, vtkStaticPointLocator, vtkCellTreeLocator, vtkAbstractPointLocator, vtkIncrementalOctreePointLocator, and vtkKdTreePointLocator.
|
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 vtkKdTree, vtkPointLocator, vtkOBBTree, vtkModifiedBSPTree, vtkCellLocator, vtkOctreePointLocator, vtkStaticPointLocator, vtkCellTreeLocator, vtkIncrementalOctreePointLocator, vtkAbstractPointLocator, and vtkKdTreePointLocator.
|
virtual |
Return the time of the last data structure build.
|
virtual |
Handle the PointSet <-> Locator loop.
Reimplemented from vtkObjectBase.
|
virtual |
Handle the PointSet <-> Locator loop.
Reimplemented from vtkObjectBase.
|
protectedvirtual |
Reimplemented from vtkObjectBase.
|
protected |
Definition at line 149 of file vtkLocator.h.
|
protected |
Definition at line 150 of file vtkLocator.h.
|
protected |
Definition at line 151 of file vtkLocator.h.
|
protected |
Definition at line 152 of file vtkLocator.h.
|
protected |
Definition at line 153 of file vtkLocator.h.
|
protected |
Definition at line 155 of file vtkLocator.h.