vtkHyperTreeCursor Class Reference

Objects that can traverse hypertree nodes. More...

#include <vtkHyperTreeCursor.h>

Inheritance diagram for vtkHyperTreeCursor:

Collaboration diagram for vtkHyperTreeCursor:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkHyperTreeCursor *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkHyperTree *	GetTree ()=0
virtual vtkIdType	GetLeafId ()=0
virtual vtkIdType	GetNodeId ()=0
virtual bool	IsLeaf ()=0
virtual bool	IsTerminalNode ()=0
virtual bool	IsRoot ()=0
virtual int	GetCurrentLevel ()=0
virtual int	GetChildIndex ()=0
virtual void	ToRoot ()=0
virtual void	ToParent ()=0
virtual void	ToChild (int child)=0
virtual void	ToSameNode (vtkHyperTreeCursor *other)=0
virtual bool	IsEqual (vtkHyperTreeCursor *other)=0
virtual vtkHyperTreeCursor *	Clone ()=0
virtual int	SameTree (vtkHyperTreeCursor *other)=0
virtual int	GetIndex (int d)=0
virtual int	GetNumberOfChildren ()=0
virtual int	GetDimension ()=0
virtual void	MoveToNode (int *indices, int level)=0
virtual bool	Found ()=0
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkHyperTreeCursor *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkHyperTreeCursor ()
virtual	~vtkHyperTreeCursor ()

---

Detailed Description

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.

---

Member Typedef Documentation

typedef vtkObject vtkHyperTreeCursor::Superclass

Reimplemented from vtkObject.

Definition at line 59 of file vtkHyperTreeCursor.h.

---

Constructor & Destructor Documentation

vtkHyperTreeCursor::vtkHyperTreeCursor

(

)

[protected]

virtual vtkHyperTreeCursor::~vtkHyperTreeCursor

(

)

[protected, virtual]

---

Member Function Documentation

static int vtkHyperTreeCursor::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkHyperTreeCursor::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkHyperTreeCursor* vtkHyperTreeCursor::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkHyperTreeCursor::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkHyperTreeCursor* vtkHyperTreeCursor::NewInstance

(

)

const

Reimplemented from vtkObject.

void vtkHyperTreeCursor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

virtual vtkHyperTree* vtkHyperTreeCursor::GetTree

(

)

[pure virtual]

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()

virtual void vtkHyperTreeCursor::ToSameNode

(

vtkHyperTreeCursor *

other

)

[pure virtual]

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)

virtual bool vtkHyperTreeCursor::IsEqual

(

vtkHyperTreeCursor *

other

)

[pure virtual]

Is `this' equal to `other'?

Precondition:

other_exists: other!=0

same_hyper3TREE: this->SameTree(other);

virtual vtkHyperTreeCursor* vtkHyperTreeCursor::Clone

(

)

[pure virtual]

Create a copy of `this'.

Postcondition:

results_exists:result!=0

same_tree: result->SameTree(this)

virtual int vtkHyperTreeCursor::SameTree

(

vtkHyperTreeCursor *

other

)

[pure virtual]

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:

• dox/Common/DataModel/vtkHyperTreeCursor.h