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

vtkSimpleScalarTree - organize data according to scalar values (used to accelerate contouring operations) More...

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

List of all members.

Public Member Functions

 vtkSimpleScalarTree (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSimpleScalarTree ()
 Instantiate scalar tree with maximum level of 20 and branching factor of 5.
override void BuildTree ()
 Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.
virtual int GetBranchingFactor ()
 Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.
virtual int GetBranchingFactorMaxValue ()
 Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.
virtual int GetBranchingFactorMinValue ()
 Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.
virtual int GetLevel ()
 Get the level of the scalar tree. This value may change each time the scalar tree is built and the branching factor changes.
virtual int GetMaxLevel ()
 Set the maximum allowable level for the tree.
virtual int GetMaxLevelMaxValue ()
 Set the maximum allowable level for the tree.
virtual int GetMaxLevelMinValue ()
 Set the maximum allowable level for the tree.
override vtkCell GetNextCell (ref int cellId, vtkIdList ptIds, vtkDataArray cellScalars)
 Return the next cell that may contain scalar value specified to initialize traversal. The value NULL is returned if the list is exhausted. Make sure that InitTraversal() has been invoked first or you'll get erratic behavior.
override void InitTraversal (double scalarValue)
 Begin to traverse the cells based on a scalar value. Returned cells will have scalar values that span the scalar value specified.
override void Initialize ()
 Initialize locator. Frees memory and resets object as appropriate.
override int IsA (string type)
 Standard type related macros and PrintSelf() method.
new vtkSimpleScalarTree NewInstance ()
 Standard type related macros and PrintSelf() method.
virtual void SetBranchingFactor (int _arg)
 Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.
virtual void SetMaxLevel (int _arg)
 Set the maximum allowable level for the tree.

Static Public Member Functions

static new vtkSimpleScalarTree New ()
 Instantiate scalar tree with maximum level of 20 and branching factor of 5.
static new int IsTypeOf (string type)
 Standard type related macros and PrintSelf() method.
static new vtkSimpleScalarTree SafeDownCast (vtkObjectBase o)
 Standard type related macros and PrintSelf() method.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "19vtkSimpleScalarTree"
 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 vtkSimpleScalarTree_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSimpleScalarTree_BuildTree_01 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetBranchingFactor_02 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetBranchingFactorMaxValue_03 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetBranchingFactorMinValue_04 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetLevel_05 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetMaxLevel_06 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetMaxLevelMaxValue_07 (HandleRef pThis)
static internal int vtkSimpleScalarTree_GetMaxLevelMinValue_08 (HandleRef pThis)
static internal IntPtr vtkSimpleScalarTree_GetNextCell_09 (HandleRef pThis, ref int cellId, HandleRef ptIds, HandleRef cellScalars, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSimpleScalarTree_InitTraversal_10 (HandleRef pThis, double scalarValue)
static internal void vtkSimpleScalarTree_Initialize_11 (HandleRef pThis)
static internal int vtkSimpleScalarTree_IsA_12 (HandleRef pThis, string type)
static internal int vtkSimpleScalarTree_IsTypeOf_13 (string type)
static internal IntPtr vtkSimpleScalarTree_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSimpleScalarTree_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSimpleScalarTree_SetBranchingFactor_17 (HandleRef pThis, int _arg)
static internal void vtkSimpleScalarTree_SetMaxLevel_18 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkSimpleScalarTree ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSimpleScalarTree - organize data according to scalar values (used to accelerate contouring operations)

Description vtkSimpleScalarTree creates a pointerless binary tree that helps search for cells that lie within a particular scalar range. This object is used to accelerate some contouring (and other scalar-based techniques).

The tree consists of an array of (min,max) scalar range pairs per node in the tree. The (min,max) range is determined from looking at the range of the children of the tree node. If the node is a leaf, then the range is determined by scanning the range of scalar data in n cells in the dataset. The n cells are determined by arbitrary selecting cell ids from id(i) to id(i+n), and where n is specified using the BranchingFactor ivar. Note that leaf node i=0 contains the scalar range computed from cell ids (0,n-1); leaf node i=1 contains the range from cell ids (n,2n-1); and so on. The implication is that there are no direct lists of cell ids per leaf node, instead the cell ids are implicitly known.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate scalar tree with maximum level of 20 and branching factor of 5.


Member Function Documentation

override void Kitware.VTK.vtkSimpleScalarTree.BuildTree ( ) [virtual]

Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.

Reimplemented from Kitware.VTK.vtkScalarTree.

override void Kitware.VTK.vtkSimpleScalarTree.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.vtkScalarTree.

Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.

Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.

Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.

virtual int Kitware.VTK.vtkSimpleScalarTree.GetLevel ( ) [virtual]

Get the level of the scalar tree. This value may change each time the scalar tree is built and the branching factor changes.

Set the maximum allowable level for the tree.

Set the maximum allowable level for the tree.

Set the maximum allowable level for the tree.

override vtkCell Kitware.VTK.vtkSimpleScalarTree.GetNextCell ( ref int  cellId,
vtkIdList  ptIds,
vtkDataArray  cellScalars 
) [virtual]

Return the next cell that may contain scalar value specified to initialize traversal. The value NULL is returned if the list is exhausted. Make sure that InitTraversal() has been invoked first or you'll get erratic behavior.

Reimplemented from Kitware.VTK.vtkScalarTree.

Here is the call graph for this function:

override void Kitware.VTK.vtkSimpleScalarTree.Initialize ( ) [virtual]

Initialize locator. Frees memory and resets object as appropriate.

Reimplemented from Kitware.VTK.vtkScalarTree.

override void Kitware.VTK.vtkSimpleScalarTree.InitTraversal ( double  scalarValue) [virtual]

Begin to traverse the cells based on a scalar value. Returned cells will have scalar values that span the scalar value specified.

Reimplemented from Kitware.VTK.vtkScalarTree.

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

Standard type related macros and PrintSelf() method.

Reimplemented from Kitware.VTK.vtkScalarTree.

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

Standard type related macros and PrintSelf() method.

Reimplemented from Kitware.VTK.vtkScalarTree.

Instantiate scalar tree with maximum level of 20 and branching factor of 5.

Reimplemented from Kitware.VTK.vtkObject.

Standard type related macros and PrintSelf() method.

Reimplemented from Kitware.VTK.vtkScalarTree.

Standard type related macros and PrintSelf() method.

Reimplemented from Kitware.VTK.vtkScalarTree.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSimpleScalarTree.SetBranchingFactor ( int  _arg) [virtual]

Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.

virtual void Kitware.VTK.vtkSimpleScalarTree.SetMaxLevel ( int  _arg) [virtual]

Set the maximum allowable level for the tree.

static internal void Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_BuildTree_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_GetBranchingFactor_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_GetLevel_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_GetMaxLevel_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_GetMaxLevelMaxValue_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_GetMaxLevelMinValue_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_GetNextCell_09 ( HandleRef  pThis,
ref int  cellId,
HandleRef  ptIds,
HandleRef  cellScalars,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_Initialize_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_InitTraversal_10 ( HandleRef  pThis,
double  scalarValue 
) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_IsA_12 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_SetBranchingFactor_17 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSimpleScalarTree.vtkSimpleScalarTree_SetMaxLevel_18 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSimpleScalarTree.MRClassNameKey = "19vtkSimpleScalarTree" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkScalarTree.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkScalarTree.


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