ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkLocator Class Reference

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

Inheritance diagram for Kitware.VTK.vtkLocator:
[legend]
Collaboration diagram for Kitware.VTK.vtkLocator:
[legend]

List of all members.

Public Member Functions

 vtkLocator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
override void Register (vtkObjectBase o)
 Handle the PointSet <-> Locator loop.
virtual void AutomaticOff ()
 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 AutomaticOn ()
 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 BuildLocator ()
 Build the locator from the input dataset.
virtual void FreeSearchStructure ()
 Free the memory required for the spatial data structure.
virtual void GenerateRepresentation (int level, vtkPolyData pd)
 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.
virtual int GetAutomatic ()
 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 uint GetBuildTime ()
 Return the time of the last data structure build.
virtual vtkDataSet GetDataSet ()
 Build the locator from the points/cells defining this dataset.
virtual int GetLevel ()
 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 int GetMaxLevel ()
 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 int GetMaxLevelMaxValue ()
 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 int GetMaxLevelMinValue ()
 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 double GetTolerance ()
 Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual double GetToleranceMaxValue ()
 Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual double GetToleranceMinValue ()
 Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual void Initialize ()
 Initialize locator. Frees memory and resets object as appropriate.
override int IsA (string type)
 Undocumented Block.
new vtkLocator NewInstance ()
 Undocumented Block.
virtual void SetAutomatic (int _arg)
 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 SetDataSet (vtkDataSet arg0)
 Build the locator from the points/cells defining this dataset.
virtual void SetMaxLevel (int _arg)
 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 void SetTolerance (double _arg)
 Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual void Update ()
 Cause the locator to rebuild itself if it or its input dataset has changed.

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkLocator SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkLocator"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "10vtkLocator"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Handle the PointSet <-> Locator loop.

Private Member Functions

static internal void vtkLocator_Register_20 (HandleRef pThis, HandleRef o)
static internal void vtkLocator_UnRegister_26 (HandleRef pThis, HandleRef o)
static internal void vtkLocator_AutomaticOff_01 (HandleRef pThis)
static internal void vtkLocator_AutomaticOn_02 (HandleRef pThis)
static internal void vtkLocator_BuildLocator_03 (HandleRef pThis)
static internal void vtkLocator_FreeSearchStructure_04 (HandleRef pThis)
static internal void vtkLocator_GenerateRepresentation_05 (HandleRef pThis, int level, HandleRef pd)
static internal int vtkLocator_GetAutomatic_06 (HandleRef pThis)
static internal uint vtkLocator_GetBuildTime_07 (HandleRef pThis)
static internal IntPtr vtkLocator_GetDataSet_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLocator_GetLevel_09 (HandleRef pThis)
static internal int vtkLocator_GetMaxLevel_10 (HandleRef pThis)
static internal int vtkLocator_GetMaxLevelMaxValue_11 (HandleRef pThis)
static internal int vtkLocator_GetMaxLevelMinValue_12 (HandleRef pThis)
static internal double vtkLocator_GetTolerance_13 (HandleRef pThis)
static internal double vtkLocator_GetToleranceMaxValue_14 (HandleRef pThis)
static internal double vtkLocator_GetToleranceMinValue_15 (HandleRef pThis)
static internal void vtkLocator_Initialize_16 (HandleRef pThis)
static internal int vtkLocator_IsA_17 (HandleRef pThis, string type)
static internal int vtkLocator_IsTypeOf_18 (string type)
static internal IntPtr vtkLocator_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkLocator_SafeDownCast_21 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLocator_SetAutomatic_22 (HandleRef pThis, int _arg)
static internal void vtkLocator_SetDataSet_23 (HandleRef pThis, HandleRef arg0)
static internal void vtkLocator_SetMaxLevel_24 (HandleRef pThis, int _arg)
static internal void vtkLocator_SetTolerance_25 (HandleRef pThis, double _arg)
static internal void vtkLocator_Update_27 (HandleRef pThis)

Static Private Member Functions

static vtkLocator ()
 Automatically generated type registration mechanics.

Detailed Description

vtkLocator - abstract base class for objects that accelerate spatial searches

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


Constructor & Destructor Documentation

static Kitware.VTK.vtkLocator.vtkLocator ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkLocator.vtkLocator ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

virtual void Kitware.VTK.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 Kitware.VTK.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 Kitware.VTK.vtkLocator.BuildLocator ( ) [virtual]
override void Kitware.VTK.vtkLocator.Dispose ( bool  disposing) [protected]
virtual void Kitware.VTK.vtkLocator.FreeSearchStructure ( ) [virtual]
virtual void Kitware.VTK.vtkLocator.GenerateRepresentation ( int  level,
vtkPolyData  pd 
) [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.

Reimplemented in Kitware.VTK.vtkKdTree, Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkCellLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkOctreePointLocator, Kitware.VTK.vtkModifiedBSPTree, Kitware.VTK.vtkOBBTree, Kitware.VTK.vtkAbstractPointLocator, and Kitware.VTK.vtkKdTreePointLocator.

virtual int Kitware.VTK.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 uint Kitware.VTK.vtkLocator.GetBuildTime ( ) [virtual]

Return the time of the last data structure build.

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

Reimplemented in Kitware.VTK.vtkKdTree.

Here is the call graph for this function:

virtual int Kitware.VTK.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.

virtual int Kitware.VTK.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.

virtual int Kitware.VTK.vtkLocator.GetMaxLevelMaxValue ( ) [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 int Kitware.VTK.vtkLocator.GetMaxLevelMinValue ( ) [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 double Kitware.VTK.vtkLocator.GetTolerance ( ) [virtual]

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

virtual double Kitware.VTK.vtkLocator.GetToleranceMaxValue ( ) [virtual]

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

virtual double Kitware.VTK.vtkLocator.GetToleranceMinValue ( ) [virtual]

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

virtual void Kitware.VTK.vtkLocator.Initialize ( ) [virtual]

Initialize locator. Frees memory and resets object as appropriate.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, and Kitware.VTK.vtkIncrementalPointLocator.

override int Kitware.VTK.vtkLocator.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkLocator.IsTypeOf ( string  type) [static]
override void Kitware.VTK.vtkLocator.Register ( vtkObjectBase  o) [virtual]

Handle the PointSet <-> Locator loop.

Reimplemented from Kitware.VTK.vtkObjectBase.

virtual void Kitware.VTK.vtkLocator.SetAutomatic ( int  _arg) [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 Kitware.VTK.vtkLocator.SetDataSet ( vtkDataSet  arg0) [virtual]

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

Reimplemented in Kitware.VTK.vtkKdTree.

virtual void Kitware.VTK.vtkLocator.SetMaxLevel ( int  _arg) [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 void Kitware.VTK.vtkLocator.SetTolerance ( double  _arg) [virtual]

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

virtual void Kitware.VTK.vtkLocator.Update ( ) [virtual]

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

static internal void Kitware.VTK.vtkLocator.vtkLocator_AutomaticOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_AutomaticOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_BuildLocator_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_FreeSearchStructure_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_GenerateRepresentation_05 ( HandleRef  pThis,
int  level,
HandleRef  pd 
) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_GetAutomatic_06 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkLocator.vtkLocator_GetBuildTime_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLocator.vtkLocator_GetDataSet_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_GetLevel_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_GetMaxLevel_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_GetMaxLevelMaxValue_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_GetMaxLevelMinValue_12 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLocator.vtkLocator_GetTolerance_13 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLocator.vtkLocator_GetToleranceMaxValue_14 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLocator.vtkLocator_GetToleranceMinValue_15 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_Initialize_16 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_IsA_17 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkLocator.vtkLocator_IsTypeOf_18 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkLocator.vtkLocator_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_Register_20 ( HandleRef  pThis,
HandleRef  o 
) [private]
static internal IntPtr Kitware.VTK.vtkLocator.vtkLocator_SafeDownCast_21 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_SetAutomatic_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_SetDataSet_23 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_SetMaxLevel_24 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_SetTolerance_25 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_UnRegister_26 ( HandleRef  pThis,
HandleRef  o 
) [private]
static internal void Kitware.VTK.vtkLocator.vtkLocator_Update_27 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkLocator.MRClassNameKey = "10vtkLocator" [static]
new const string Kitware.VTK.vtkLocator.MRFullTypeName = "Kitware.VTK.vtkLocator"

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