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.vtkOBBTree Class Reference

vtkOBBTree - generate oriented bounding box (OBB) tree More...

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

List of all members.

Public Member Functions

 vtkOBBTree (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkOBBTree ()
 Construct with automatic computation of divisions, averaging 25 cells per octant.
override void BuildLocator ()
 Satisfy locator's abstract interface, see vtkLocator.
void ComputeOBB (vtkDataSet input, IntPtr corner, IntPtr max, IntPtr mid, IntPtr min, IntPtr size)
 Compute an OBB for the input dataset using the cells in the data. Return the corner point and the three axes defining the orientation of the OBB. Also return a sorted list of relative "sizes" of axes for comparison purposes.
override void FindClosestPoint (IntPtr x, IntPtr closestPoint, ref int cellId, ref int subId, ref double dist2)
 Return the closest point and the cell which is closest to the point x. The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This version takes in a vtkGenericCell to avoid allocating and deallocating the cell. This is much faster than the version which does not take a *cell, especially when this function is called many times in a row such as by a for loop, where the allocation and deallocation can be done only once outside the for loop. If a cell is found, "cell" contains the points and ptIds for the cell "cellId" upon exit.
override void FindClosestPoint (IntPtr x, IntPtr closestPoint, vtkGenericCell cell, ref int cellId, ref int subId, ref double dist2)
 reimplemented from vtkAbstractCellLocator to support bad compilers
override int FindClosestPointWithinRadius (IntPtr x, double radius, IntPtr closestPoint, ref int cellId, ref int subId, ref double dist2)
 reimplemented from vtkAbstractCellLocator to support bad compilers
override int FindClosestPointWithinRadius (IntPtr x, double radius, IntPtr closestPoint, vtkGenericCell cell, ref int cellId, ref int subId, ref double dist2)
 reimplemented from vtkAbstractCellLocator to support bad compilers
override int FindClosestPointWithinRadius (IntPtr x, double radius, IntPtr closestPoint, vtkGenericCell cell, ref int cellId, ref int subId, ref double dist2, ref int inside)
 reimplemented from vtkAbstractCellLocator to support bad compilers
override void FreeSearchStructure ()
 Satisfy locator's abstract interface, see vtkLocator.
override void GenerateRepresentation (int level, vtkPolyData pd)
 Create polygonal representation for OBB tree at specified level. If level < 0, then the leaf OBB nodes will be gathered. The aspect ratio (ar) and line diameter (d) are used to control the building of the representation. If a OBB node edge ratio's are greater than ar, then the dimension of the OBB is collapsed (OBB->plane->line). A "line" OBB will be represented either as two crossed polygons, or as a line, depending on the relative diameter of the OBB compared to the diameter (d).
int InsideOrOutside (IntPtr point)
 Determine whether a point is inside or outside the data used to build this OBB tree. The data must be a closed surface vtkPolyData data set. The return value is +1 if outside, -1 if inside, and 0 if undecided.
override int IntersectWithLine (IntPtr a0, IntPtr a1, double tol, ref double t, IntPtr x, IntPtr pcoords, ref int subId)
 reimplemented from vtkAbstractCellLocator to support bad compilers
override int IntersectWithLine (IntPtr a0, IntPtr a1, double tol, ref double t, IntPtr x, IntPtr pcoords, ref int subId, ref int cellId)
 reimplemented from vtkAbstractCellLocator to support bad compilers
override int IntersectWithLine (IntPtr a0, IntPtr a1, vtkPoints points, vtkIdList cellIds)
 Take the passed line segment and intersect it with the data set. This method assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that are returned in 'points' alternate between entrance points and exit points. The return value of the function is 0 if no intersections were found,.
override int IntersectWithLine (IntPtr a0, IntPtr a1, double tol, ref double t, IntPtr x, IntPtr pcoords, ref int subId, ref int cellId, vtkGenericCell cell)
 Return the first intersection of the specified line segment with the OBB tree, as well as information about the cell which the line segment intersected.
override int IsA (string type)
 Undocumented Block.
new vtkOBBTree NewInstance ()
 Undocumented Block.

Static Public Member Functions

static new vtkOBBTree New ()
 Construct with automatic computation of divisions, averaging 25 cells per octant.
static void ComputeOBB (vtkPoints pts, IntPtr corner, IntPtr max, IntPtr mid, IntPtr min, IntPtr size)
 Compute an OBB from the list of points given. Return the corner point and the three axes defining the orientation of the OBB. Also return a sorted list of relative "sizes" of axes for comparison purposes.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkOBBTree SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

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

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkOBBTree_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkOBBTree_BuildLocator_01 (HandleRef pThis)
static internal void vtkOBBTree_ComputeOBB_02 (HandleRef pts, IntPtr corner, IntPtr max, IntPtr mid, IntPtr min, IntPtr size)
static internal void vtkOBBTree_ComputeOBB_03 (HandleRef pThis, HandleRef input, IntPtr corner, IntPtr max, IntPtr mid, IntPtr min, IntPtr size)
static internal void vtkOBBTree_FindClosestPoint_04 (HandleRef pThis, IntPtr x, IntPtr closestPoint, ref int cellId, ref int subId, ref double dist2)
static internal void vtkOBBTree_FindClosestPoint_05 (HandleRef pThis, IntPtr x, IntPtr closestPoint, HandleRef cell, ref int cellId, ref int subId, ref double dist2)
static internal int vtkOBBTree_FindClosestPointWithinRadius_06 (HandleRef pThis, IntPtr x, double radius, IntPtr closestPoint, ref int cellId, ref int subId, ref double dist2)
static internal int vtkOBBTree_FindClosestPointWithinRadius_07 (HandleRef pThis, IntPtr x, double radius, IntPtr closestPoint, HandleRef cell, ref int cellId, ref int subId, ref double dist2)
static internal int vtkOBBTree_FindClosestPointWithinRadius_08 (HandleRef pThis, IntPtr x, double radius, IntPtr closestPoint, HandleRef cell, ref int cellId, ref int subId, ref double dist2, ref int inside)
static internal void vtkOBBTree_FreeSearchStructure_09 (HandleRef pThis)
static internal void vtkOBBTree_GenerateRepresentation_10 (HandleRef pThis, int level, HandleRef pd)
static internal int vtkOBBTree_InsideOrOutside_11 (HandleRef pThis, IntPtr point)
static internal int vtkOBBTree_IntersectWithLine_12 (HandleRef pThis, IntPtr a0, IntPtr a1, double tol, ref double t, IntPtr x, IntPtr pcoords, ref int subId)
static internal int vtkOBBTree_IntersectWithLine_13 (HandleRef pThis, IntPtr a0, IntPtr a1, double tol, ref double t, IntPtr x, IntPtr pcoords, ref int subId, ref int cellId)
static internal int vtkOBBTree_IntersectWithLine_14 (HandleRef pThis, IntPtr a0, IntPtr a1, HandleRef points, HandleRef cellIds)
static internal int vtkOBBTree_IntersectWithLine_15 (HandleRef pThis, IntPtr a0, IntPtr a1, double tol, ref double t, IntPtr x, IntPtr pcoords, ref int subId, ref int cellId, HandleRef cell)
static internal int vtkOBBTree_IsA_16 (HandleRef pThis, string type)
static internal int vtkOBBTree_IsTypeOf_17 (string type)
static internal IntPtr vtkOBBTree_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkOBBTree_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)

Static Private Member Functions

static vtkOBBTree ()
 Automatically generated type registration mechanics.

Detailed Description

vtkOBBTree - generate oriented bounding box (OBB) tree

Description vtkOBBTree is an object to generate oriented bounding box (OBB) trees. An oriented bounding box is a bounding box that does not necessarily line up along coordinate axes. The OBB tree is a hierarchical tree structure of such boxes, where deeper levels of OBB confine smaller regions of space.

To build the OBB, a recursive, top-down process is used. First, the root OBB is constructed by finding the mean and covariance matrix of the cells (and their points) that define the dataset. The eigenvectors of the covariance matrix are extracted, giving a set of three orthogonal vectors that define the tightest-fitting OBB. To create the two children OBB's, a split plane is found that (approximately) divides the number cells in half. These are then assigned to the children OBB's. This process then continues until the MaxLevel ivar limits the recursion, or no split plane can be found.

A good reference for OBB-trees is Gottschalk & Manocha in Proceedings of Siggraph `96.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Construct with automatic computation of divisions, averaging 25 cells per octant.


Member Function Documentation

override void Kitware.VTK.vtkOBBTree.BuildLocator ( ) [virtual]

Satisfy locator's abstract interface, see vtkLocator.

Reimplemented from Kitware.VTK.vtkLocator.

static void Kitware.VTK.vtkOBBTree.ComputeOBB ( vtkPoints  pts,
IntPtr  corner,
IntPtr  max,
IntPtr  mid,
IntPtr  min,
IntPtr  size 
) [static]

Compute an OBB from the list of points given. Return the corner point and the three axes defining the orientation of the OBB. Also return a sorted list of relative "sizes" of axes for comparison purposes.

void Kitware.VTK.vtkOBBTree.ComputeOBB ( vtkDataSet  input,
IntPtr  corner,
IntPtr  max,
IntPtr  mid,
IntPtr  min,
IntPtr  size 
)

Compute an OBB for the input dataset using the cells in the data. Return the corner point and the three axes defining the orientation of the OBB. Also return a sorted list of relative "sizes" of axes for comparison purposes.

override void Kitware.VTK.vtkOBBTree.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override void Kitware.VTK.vtkOBBTree.FindClosestPoint ( IntPtr  x,
IntPtr  closestPoint,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [virtual]

Return the closest point and the cell which is closest to the point x. The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This version takes in a vtkGenericCell to avoid allocating and deallocating the cell. This is much faster than the version which does not take a *cell, especially when this function is called many times in a row such as by a for loop, where the allocation and deallocation can be done only once outside the for loop. If a cell is found, "cell" contains the points and ptIds for the cell "cellId" upon exit.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override void Kitware.VTK.vtkOBBTree.FindClosestPoint ( IntPtr  x,
IntPtr  closestPoint,
vtkGenericCell  cell,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.FindClosestPointWithinRadius ( IntPtr  x,
double  radius,
IntPtr  closestPoint,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.FindClosestPointWithinRadius ( IntPtr  x,
double  radius,
IntPtr  closestPoint,
vtkGenericCell  cell,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.FindClosestPointWithinRadius ( IntPtr  x,
double  radius,
IntPtr  closestPoint,
vtkGenericCell  cell,
ref int  cellId,
ref int  subId,
ref double  dist2,
ref int  inside 
) [virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override void Kitware.VTK.vtkOBBTree.FreeSearchStructure ( ) [virtual]

Satisfy locator's abstract interface, see vtkLocator.

Reimplemented from Kitware.VTK.vtkLocator.

override void Kitware.VTK.vtkOBBTree.GenerateRepresentation ( int  level,
vtkPolyData  pd 
) [virtual]

Create polygonal representation for OBB tree at specified level. If level < 0, then the leaf OBB nodes will be gathered. The aspect ratio (ar) and line diameter (d) are used to control the building of the representation. If a OBB node edge ratio's are greater than ar, then the dimension of the OBB is collapsed (OBB->plane->line). A "line" OBB will be represented either as two crossed polygons, or as a line, depending on the relative diameter of the OBB compared to the diameter (d).

Reimplemented from Kitware.VTK.vtkLocator.

Determine whether a point is inside or outside the data used to build this OBB tree. The data must be a closed surface vtkPolyData data set. The return value is +1 if outside, -1 if inside, and 0 if undecided.

override int Kitware.VTK.vtkOBBTree.IntersectWithLine ( IntPtr  a0,
IntPtr  a1,
double  tol,
ref double  t,
IntPtr  x,
IntPtr  pcoords,
ref int  subId 
) [virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.IntersectWithLine ( IntPtr  a0,
IntPtr  a1,
double  tol,
ref double  t,
IntPtr  x,
IntPtr  pcoords,
ref int  subId,
ref int  cellId 
) [virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.IntersectWithLine ( IntPtr  a0,
IntPtr  a1,
vtkPoints  points,
vtkIdList  cellIds 
) [virtual]

Take the passed line segment and intersect it with the data set. This method assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that are returned in 'points' alternate between entrance points and exit points. The return value of the function is 0 if no intersections were found,.

-1 if point 'a0' lies inside the closed surface, or +1 if point 'a0' lies outside the closed surface. Either 'points' or 'cellIds' can be set to NULL if you don't want to receive that information.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.IntersectWithLine ( IntPtr  a0,
IntPtr  a1,
double  tol,
ref double  t,
IntPtr  x,
IntPtr  pcoords,
ref int  subId,
ref int  cellId,
vtkGenericCell  cell 
) [virtual]

Return the first intersection of the specified line segment with the OBB tree, as well as information about the cell which the line segment intersected.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

override int Kitware.VTK.vtkOBBTree.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

static new int Kitware.VTK.vtkOBBTree.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

static new vtkOBBTree Kitware.VTK.vtkOBBTree.New ( ) [static]

Construct with automatic computation of divisions, averaging 25 cells per octant.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

Here is the call graph for this function:

static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_BuildLocator_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_ComputeOBB_02 ( HandleRef  pts,
IntPtr  corner,
IntPtr  max,
IntPtr  mid,
IntPtr  min,
IntPtr  size 
) [private]
static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_ComputeOBB_03 ( HandleRef  pThis,
HandleRef  input,
IntPtr  corner,
IntPtr  max,
IntPtr  mid,
IntPtr  min,
IntPtr  size 
) [private]
static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_FindClosestPoint_04 ( HandleRef  pThis,
IntPtr  x,
IntPtr  closestPoint,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [private]
static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_FindClosestPoint_05 ( HandleRef  pThis,
IntPtr  x,
IntPtr  closestPoint,
HandleRef  cell,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_FindClosestPointWithinRadius_06 ( HandleRef  pThis,
IntPtr  x,
double  radius,
IntPtr  closestPoint,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_FindClosestPointWithinRadius_07 ( HandleRef  pThis,
IntPtr  x,
double  radius,
IntPtr  closestPoint,
HandleRef  cell,
ref int  cellId,
ref int  subId,
ref double  dist2 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_FindClosestPointWithinRadius_08 ( HandleRef  pThis,
IntPtr  x,
double  radius,
IntPtr  closestPoint,
HandleRef  cell,
ref int  cellId,
ref int  subId,
ref double  dist2,
ref int  inside 
) [private]
static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_FreeSearchStructure_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkOBBTree.vtkOBBTree_GenerateRepresentation_10 ( HandleRef  pThis,
int  level,
HandleRef  pd 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_InsideOrOutside_11 ( HandleRef  pThis,
IntPtr  point 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_IntersectWithLine_12 ( HandleRef  pThis,
IntPtr  a0,
IntPtr  a1,
double  tol,
ref double  t,
IntPtr  x,
IntPtr  pcoords,
ref int  subId 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_IntersectWithLine_13 ( HandleRef  pThis,
IntPtr  a0,
IntPtr  a1,
double  tol,
ref double  t,
IntPtr  x,
IntPtr  pcoords,
ref int  subId,
ref int  cellId 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_IntersectWithLine_14 ( HandleRef  pThis,
IntPtr  a0,
IntPtr  a1,
HandleRef  points,
HandleRef  cellIds 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_IntersectWithLine_15 ( HandleRef  pThis,
IntPtr  a0,
IntPtr  a1,
double  tol,
ref double  t,
IntPtr  x,
IntPtr  pcoords,
ref int  subId,
ref int  cellId,
HandleRef  cell 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkOBBTree.vtkOBBTree_IsTypeOf_17 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkOBBTree.vtkOBBTree_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkOBBTree.vtkOBBTree_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkOBBTree.vtkOBBTree_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkOBBTree.MRClassNameKey = "10vtkOBBTree" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.

new const string Kitware.VTK.vtkOBBTree.MRFullTypeName = "Kitware.VTK.vtkOBBTree"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractCellLocator.


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