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

vtkHyperOctreeCursor - Objects that can traverse hyperoctree nodes. More...

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

List of all members.

Public Member Functions

 vtkHyperOctreeCursor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkHyperOctreeCursor Clone ()
 Create a copy of `this'.
virtual int CurrentIsLeaf ()
 Is the node pointed by the cursor a leaf?
virtual int CurrentIsRoot ()
 Is the node pointed by the cursor the root?
virtual int CurrentIsTerminalNode ()
 Are the children of the current node all leaves? This query can be called also on a leaf node.
virtual int Found ()
 Description Did the last call to MoveToNode succeed?
virtual int GetChildIndex ()
 Return the child number of the current node relative to its parent.
virtual int GetCurrentLevel ()
 Return the level of the node pointed by the cursor.
virtual int GetDimension ()
 Return the dimension of the tree.
virtual int GetIndex (int d)
 Return the index in dimension `d', as if the node was a cell of a uniform grid of 1<<GetCurrentLevel() cells in each dimension.
virtual int GetLeafId ()
 Return the index of the current leaf in the data arrays.
virtual int GetNumberOfChildren ()
 Return the number of children for each node of the tree.
override int IsA (string type)
 Undocumented Block.
virtual int IsEqual (vtkHyperOctreeCursor other)
 Is `this' equal to `other'?
virtual void MoveToNode (IntPtr indices, int level)
 Move to the node described by its indices in each dimension and at a given level. If there is actually a node or a leaf at this location, Found() returns true. Otherwise, Found() returns false and the cursor moves to the closest parent of the query. It can be the root in the worst case.
new vtkHyperOctreeCursor NewInstance ()
 Undocumented Block.
virtual int SameTree (vtkHyperOctreeCursor other)
 Are `this' and `other' pointing on the same hyperoctree?
virtual void ToChild (int child)
 Move the cursor to child `child' of the current node.
virtual void ToParent ()
 Move the cursor to the parent of the current node.
virtual void ToRoot ()
 Move the cursor the root node.
virtual void ToSameNode (vtkHyperOctreeCursor other)
 Move the cursor to the same node pointed by `other'.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkHyperOctreeCursor"
 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 vtkHyperOctreeCursor_Clone_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkHyperOctreeCursor_CurrentIsLeaf_02 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_CurrentIsRoot_03 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_CurrentIsTerminalNode_04 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_Found_05 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_GetChildIndex_06 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_GetCurrentLevel_07 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_GetDimension_08 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_GetIndex_09 (HandleRef pThis, int d)
static internal int vtkHyperOctreeCursor_GetLeafId_10 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_GetNumberOfChildren_11 (HandleRef pThis)
static internal int vtkHyperOctreeCursor_IsA_12 (HandleRef pThis, string type)
static internal int vtkHyperOctreeCursor_IsEqual_13 (HandleRef pThis, HandleRef other)
static internal int vtkHyperOctreeCursor_IsTypeOf_14 (string type)
static internal void vtkHyperOctreeCursor_MoveToNode_15 (HandleRef pThis, IntPtr indices, int level)
static internal IntPtr vtkHyperOctreeCursor_NewInstance_16 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHyperOctreeCursor_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkHyperOctreeCursor_SameTree_18 (HandleRef pThis, HandleRef other)
static internal void vtkHyperOctreeCursor_ToChild_19 (HandleRef pThis, int child)
static internal void vtkHyperOctreeCursor_ToParent_20 (HandleRef pThis)
static internal void vtkHyperOctreeCursor_ToRoot_21 (HandleRef pThis)
static internal void vtkHyperOctreeCursor_ToSameNode_22 (HandleRef pThis, HandleRef other)

Static Private Member Functions

static vtkHyperOctreeCursor ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHyperOctreeCursor - Objects that can traverse hyperoctree nodes.

Description Objects that can traverse hyperoctree nodes. It is an abstract class. Cursors are created by the hyperoctree.

vtkDataObject vtkFieldData vtkHyperOctreeAlgorithm


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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


Member Function Documentation

Create a copy of `this'.

Postcondition:
results_exists:result!=0
same_tree: result->SameTree(this)

Here is the call graph for this function:

Is the node pointed by the cursor a leaf?

Is the node pointed by the cursor the root?

Are the children of the current node all leaves? This query can be called also on a leaf node.

Postcondition:
compatible: result implies !CurrentIsLeaf()
override void Kitware.VTK.vtkHyperOctreeCursor.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.vtkObject.

virtual int Kitware.VTK.vtkHyperOctreeCursor.Found ( ) [virtual]

Description Did the last call to MoveToNode succeed?

Return the child number of the current node relative to its parent.

Precondition:
not_root: !CurrentIsRoot().
Postcondition:
valid_range: result>=0 && result<GetNumberOfChildren()

Return the level of the node pointed by the cursor.

Postcondition:
positive_result: result>=0

Return the dimension of the tree.

Postcondition:
positive_result: result>0
virtual int Kitware.VTK.vtkHyperOctreeCursor.GetIndex ( int  d) [virtual]

Return the index in dimension `d', as if the node was a cell of a uniform grid of 1<<GetCurrentLevel() cells in each dimension.

Precondition:
valid_range: d>=0 && d<GetDimension()
Postcondition:
valid_result: result>=0 && result<(1<<GetCurrentLevel())
virtual int Kitware.VTK.vtkHyperOctreeCursor.GetLeafId ( ) [virtual]

Return the index of the current leaf in the data arrays.

Precondition:
is_leaf: CurrentIsLeaf()

Return the number of children for each node of the tree.

Postcondition:
positive_number: result>0
override int Kitware.VTK.vtkHyperOctreeCursor.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Is `this' equal to `other'?

Precondition:
other_exists: other!=0
same_hyperoctree: this->SameTree(other);
static new int Kitware.VTK.vtkHyperOctreeCursor.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

virtual void Kitware.VTK.vtkHyperOctreeCursor.MoveToNode ( IntPtr  indices,
int  level 
) [virtual]

Move to the node described by its indices in each dimension and at a given level. If there is actually a node or a leaf at this location, Found() returns true. Otherwise, Found() returns false and the cursor moves to the closest parent of the query. It can be the root in the worst case.

Precondition:
indices_exists: indices!=0
valid_size: sizeof(indices)==GetDimension()
valid_level: level>=0

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

Are `this' and `other' pointing on the same hyperoctree?

Precondition:
other_exists: other!=0
virtual void Kitware.VTK.vtkHyperOctreeCursor.ToChild ( int  child) [virtual]

Move the cursor to child `child' of the current node.

Precondition:
not_leaf: !CurrentIsLeaf()
valid_child: child>=0 && child<this->GetNumberOfChildren()
virtual void Kitware.VTK.vtkHyperOctreeCursor.ToParent ( ) [virtual]

Move the cursor to the parent of the current node.

Precondition:
not_root: !CurrentIsRoot()
virtual void Kitware.VTK.vtkHyperOctreeCursor.ToRoot ( ) [virtual]

Move the cursor the root node.

Precondition:
can be root
Postcondition:
is_root: CurrentIsRoot()

Move the cursor to the same node pointed by `other'.

Precondition:
other_exists: other!=0
same_hyperoctree: this->SameTree(other);
Postcondition:
equal: this->IsEqual(other)
static internal IntPtr Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_Clone_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_CurrentIsLeaf_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_CurrentIsRoot_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_CurrentIsTerminalNode_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_Found_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_GetChildIndex_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_GetCurrentLevel_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_GetDimension_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_GetIndex_09 ( HandleRef  pThis,
int  d 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_GetLeafId_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_GetNumberOfChildren_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_IsA_12 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_IsEqual_13 ( HandleRef  pThis,
HandleRef  other 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_IsTypeOf_14 ( string  type) [private]
static internal void Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_MoveToNode_15 ( HandleRef  pThis,
IntPtr  indices,
int  level 
) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_NewInstance_16 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_SafeDownCast_17 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_SameTree_18 ( HandleRef  pThis,
HandleRef  other 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_ToChild_19 ( HandleRef  pThis,
int  child 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_ToParent_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_ToRoot_21 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCursor.vtkHyperOctreeCursor_ToSameNode_22 ( HandleRef  pThis,
HandleRef  other 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkHyperOctreeCursor.MRClassNameKey = "20vtkHyperOctreeCursor" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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