Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages
vtkLocator Class Reference
#include <vtkLocator.h>
Inheritance diagram for vtkLocator:
[legend]Collaboration diagram for vtkLocator:
[legend]List of all members.
Detailed Description
abstract base class for objects that accelerate spatial searches
- Date:
-
2003/01/06 20:36:14
- Revision:
-
1.49
vtkLocator is an abstract base class for spatial search objects, or locators. The principle behind locators is that they divide 3-space into small pieces (or "buckets") that can be quickly found in response to queries like point location, line intersection, or object-object intersection.
The purpose of this base class is to provide ivars 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 tree. 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.
- See also:
-
vtkPointLocator vtkCellLocator vtkOBBTree vtkLocatorFilter
- Created by:
-
- CVS contributions (if > 5%):
-
- CVS logs (CVSweb):
-
- .
cxx (/Common/vtkLocator.cxx) - .
h (/Common/vtkLocator.h)
Definition at line 74 of file vtkLocator.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkLocator::vtkLocator |
( |
|
) |
[protected] |
|
| vtkLocator::~vtkLocator |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkLocator::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkLocator::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
| virtual int vtkLocator::IsA |
( |
const char * |
type |
) |
[virtual] |
|
| vtkLocator* vtkLocator::SafeDownCast |
( |
vtkObject * |
o |
) |
[static] |
|
| void vtkLocator::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
| virtual void vtkLocator::SetDataSet |
( |
vtkDataSet * |
|
) |
[virtual] |
|
|
|
Build the locator from the points/cells defining this dataset. |
| virtual vtkDataSet* vtkLocator::GetDataSet |
( |
|
) |
[virtual] |
|
|
|
Build the locator from the points/cells defining this dataset. |
| 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. |
| 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. |
| 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. |
| virtual void vtkLocator::SetAutomatic |
( |
int |
|
) |
[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 int 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). |
| 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). |
| 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). |
| virtual void vtkLocator::SetTolerance |
( |
float |
|
) |
[virtual] |
|
|
|
Specify absolute tolerance (in world coordinates) for performing geometric operations. |
| virtual float vtkLocator::GetTolerance |
( |
|
) |
[virtual] |
|
|
|
Specify absolute tolerance (in world coordinates) for performing geometric operations. |
| virtual void vtkLocator::SetRetainCellLists |
( |
int |
|
) |
[virtual] |
|
|
|
Boolean controls whether to maintain list of entities in each bucket. Normally the lists are maintained, but if the locator is being used as a geometry simplification technique, there is no need to keep them. |
| virtual int vtkLocator::GetRetainCellLists |
( |
|
) |
[virtual] |
|
|
|
Boolean controls whether to maintain list of entities in each bucket. Normally the lists are maintained, but if the locator is being used as a geometry simplification technique, there is no need to keep them. |
| virtual void vtkLocator::RetainCellListsOn |
( |
|
) |
[virtual] |
|
|
|
Boolean controls whether to maintain list of entities in each bucket. Normally the lists are maintained, but if the locator is being used as a geometry simplification technique, there is no need to keep them. |
| virtual void vtkLocator::RetainCellListsOff |
( |
|
) |
[virtual] |
|
|
|
Boolean controls whether to maintain list of entities in each bucket. Normally the lists are maintained, but if the locator is being used as a geometry simplification technique, there is no need to keep them. |
| virtual void vtkLocator::Update |
( |
|
) |
[virtual] |
|
|
|
Cause the locator to rebuild itself if it or its input dataset has changed. |
| virtual void vtkLocator::Initialize |
( |
|
) |
[virtual] |
|
| virtual void vtkLocator::BuildLocator |
( |
|
) |
[pure virtual] |
|
| virtual void vtkLocator::FreeSearchStructure |
( |
|
) |
[pure virtual] |
|
| virtual void vtkLocator::GenerateRepresentation |
( |
int |
level, |
|
|
vtkPolyData * |
pd |
|
) |
[pure virtual] |
|
| virtual unsigned long vtkLocator::GetBuildTime |
( |
|
) |
[virtual] |
|
|
|
Return the time of the last data structure build. |
Member Data Documentation
int vtkLocator::Automatic [protected]
|
|
float vtkLocator::Tolerance [protected]
|
|
int vtkLocator::MaxLevel [protected]
|
|
int vtkLocator::Level [protected]
|
|
int vtkLocator::RetainCellLists [protected]
|
|
The documentation for this class was generated from the following file: