Objects that can traverse hypertree nodes.
More...
#include <vtkHyperTreeCursor.h>
Inherits vtkObject.
Objects that can traverse hypertree nodes.
Objects that can traverse hyper3TREE nodes. It is an abstract class. Cursors are created by the hyper3TREE.
- See Also
- vtkDataObject vtkFieldData vtkHyper3TREEAlgorithm
- Thanks:
- This class was written by Philippe Pebay, Joachim Pouderoux and Charles Law, Kitware 2013 This work was supported in part by Commissariat a l'Energie Atomique (CEA/DIF)
Definition at line 56 of file vtkHyperTreeCursor.h.
vtkHyperTreeCursor::vtkHyperTreeCursor |
( |
| ) |
|
|
protected |
virtual vtkHyperTreeCursor::~vtkHyperTreeCursor |
( |
| ) |
|
|
protectedvirtual |
static int vtkHyperTreeCursor::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
virtual int vtkHyperTreeCursor::IsA |
( |
const char * |
type | ) |
|
|
virtual |
virtual vtkObjectBase* vtkHyperTreeCursor::NewInstanceInternal |
( |
| ) |
const |
|
protectedvirtual |
void vtkHyperTreeCursor::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
Return the HyperTree on which the cursor points to.
virtual vtkIdType vtkHyperTreeCursor::GetLeafId |
( |
| ) |
|
|
pure virtual |
Return the index of the current leaf in the data arrays.
- Precondition
- is_leaf: IsLeaf()
virtual vtkIdType vtkHyperTreeCursor::GetNodeId |
( |
| ) |
|
|
pure virtual |
Return the index of the current node in the data arrays.
virtual bool vtkHyperTreeCursor::IsLeaf |
( |
| ) |
|
|
pure virtual |
Is the node pointed by the cursor a leaf?
virtual bool vtkHyperTreeCursor::IsTerminalNode |
( |
| ) |
|
|
pure virtual |
virtual bool vtkHyperTreeCursor::IsRoot |
( |
| ) |
|
|
pure virtual |
Is the node pointed by the cursor the root?
virtual int vtkHyperTreeCursor::GetCurrentLevel |
( |
| ) |
|
|
pure virtual |
Return the level of the node pointed by the cursor.
- Postcondition
- positive_result: result>=0
virtual int vtkHyperTreeCursor::GetChildIndex |
( |
| ) |
|
|
pure virtual |
Return the child number of the current node relative to its parent.
- Precondition
- not_root: !IsRoot().
- Postcondition
- valid_range: result>=0 && result<GetNumberOfChildren()
virtual void vtkHyperTreeCursor::ToRoot |
( |
| ) |
|
|
pure virtual |
Move the cursor to the root node.
- Precondition
- can be root
- Postcondition
- is_root: IsRoot()
virtual void vtkHyperTreeCursor::ToParent |
( |
| ) |
|
|
pure virtual |
Move the cursor to the parent of the current node.
- Precondition
- not_root: !IsRoot()
virtual void vtkHyperTreeCursor::ToChild |
( |
int |
child | ) |
|
|
pure virtual |
Move the cursor to child `child' of the current node.
- Precondition
- not_leaf: !IsLeaf()
-
valid_child: child>=0 && child<this->GetNumberOfChildren()
Move the cursor to the same node pointed by `other'.
- Precondition
- other_exists: other!=0
-
same_hyper3TREE: this->SameTree(other);
- Postcondition
- equal: this->IsEqual(other)
Is `this' equal to `other'?
- Precondition
- other_exists: other!=0
-
same_hyper3TREE: this->SameTree(other);
Create a copy of `this'.
- Postcondition
- results_exists:result!=0
-
same_tree: result->SameTree(this)
Are `this' and `other' pointing on the same hyper3TREE?
- Precondition
- other_exists: other!=0
virtual int vtkHyperTreeCursor::GetIndex |
( |
int |
d | ) |
|
|
pure 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 vtkHyperTreeCursor::GetNumberOfChildren |
( |
| ) |
|
|
pure virtual |
Return the number of children for each node of the tree.
- Postcondition
- positive_number: result>0
virtual int vtkHyperTreeCursor::GetDimension |
( |
| ) |
|
|
pure virtual |
Return the dimension of the tree.
- Postcondition
- positive_result: result>0
virtual void vtkHyperTreeCursor::MoveToNode |
( |
int * |
indices, |
|
|
int |
level |
|
) |
| |
|
pure 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
virtual bool vtkHyperTreeCursor::Found |
( |
| ) |
|
|
pure virtual |
Did the last call to MoveToNode succeed?
The documentation for this class was generated from the following file: