VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkHyperTreeCursor Class Referenceabstract

Objects for depth-first traversal HyperTrees. More...

#include <vtkHyperTreeCursor.h>

Inheritance diagram for vtkHyperTreeCursor:
[legend]
Collaboration diagram for vtkHyperTreeCursor:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkHyperTreeCursorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTree (vtkHyperTree *)=0
 Set the HyperTree to which the cursor is pointing. More...
 
virtual vtkHyperTreeGetTree ()=0
 Return the HyperTree to which the cursor is pointing. More...
 
virtual vtkIdType GetVertexId ()=0
 Return the index of the current vertex in the tree. More...
 
virtual bool IsLeaf ()=0
 Is the cursor pointing to a leaf? More...
 
virtual bool IsRoot ()=0
 Is the cursor at tree root? More...
 
virtual unsigned int GetLevel ()=0
 Return the level of the vertex pointed by the cursor. More...
 
virtual int GetChildIndex ()=0
 Return the child number of the current vertex relative to its parent. More...
 
virtual void ToRoot ()=0
 Move the cursor to the root vertex. More...
 
virtual void ToParent ()=0
 Move the cursor to the parent of the current vertex. More...
 
virtual void ToChild (int child)=0
 Move the cursor to child ‘child’ of the current vertex. More...
 
virtual void ToSameVertex (vtkHyperTreeCursor *other)=0
 Move the cursor to the same vertex pointed by ‘other’. More...
 
virtual bool IsEqual (vtkHyperTreeCursor *other)=0
 Is ‘this’ equal to ‘other’? More...
 
virtual vtkHyperTreeCursorClone ()=0
 Create a copy of ‘this’. More...
 
virtual int SameTree (vtkHyperTreeCursor *other)=0
 Are ‘this’ and ‘other’ pointing on the same hypertree? More...
 
virtual int GetNumberOfChildren ()=0
 Return the number of children for each node (non-vertex leaf) of the tree. More...
 
virtual int GetDimension ()=0
 Return the dimension of the tree. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeCursorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkHyperTreeCursor ()
 
 ~vtkHyperTreeCursor () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Objects for depth-first traversal HyperTrees.

Objects that can perform depth-first traversal of HyperTrees. This is an abstract class. Cursors are created by the HyperTree implementation.

See also
vtkObject vtkHyperTree vtkHyperTreeGrid
Thanks:
This class was written by Philippe Pebay, Joachim Pouderoux, and Charles Law, Kitware 2013 This class was modified by Guenole Harel and Jacques-Bernard Lekien 2014 This class was revised by Philippe Pebay, 2016 This work was supported by Commissariat a l'Energie Atomique (CEA/DIF)

Definition at line 42 of file vtkHyperTreeCursor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkHyperTreeCursor.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeCursor()

vtkHyperTreeCursor::vtkHyperTreeCursor ( )
protected

◆ ~vtkHyperTreeCursor()

vtkHyperTreeCursor::~vtkHyperTreeCursor ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkHyperTreeCursor::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

static vtkHyperTreeCursor* vtkHyperTreeCursor::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkHyperTreeCursor::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkHyperTreeCursor* vtkHyperTreeCursor::NewInstance ( ) const

◆ PrintSelf()

void vtkHyperTreeCursor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetTree()

virtual void vtkHyperTreeCursor::SetTree ( vtkHyperTree )
pure virtual

Set the HyperTree to which the cursor is pointing.

◆ GetTree()

virtual vtkHyperTree* vtkHyperTreeCursor::GetTree ( )
pure virtual

Return the HyperTree to which the cursor is pointing.

◆ GetVertexId()

virtual vtkIdType vtkHyperTreeCursor::GetVertexId ( )
pure virtual

Return the index of the current vertex in the tree.

◆ IsLeaf()

virtual bool vtkHyperTreeCursor::IsLeaf ( )
pure virtual

Is the cursor pointing to a leaf?

◆ IsRoot()

virtual bool vtkHyperTreeCursor::IsRoot ( )
pure virtual

Is the cursor at tree root?

◆ GetLevel()

virtual unsigned int vtkHyperTreeCursor::GetLevel ( )
pure virtual

Return the level of the vertex pointed by the cursor.

Postcondition
positive_result: result>=0

◆ GetChildIndex()

virtual int vtkHyperTreeCursor::GetChildIndex ( )
pure virtual

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

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

◆ ToRoot()

virtual void vtkHyperTreeCursor::ToRoot ( )
pure virtual

Move the cursor to the root vertex.

Precondition
can be root
Postcondition
is_root: IsRoot()

◆ ToParent()

virtual void vtkHyperTreeCursor::ToParent ( )
pure virtual

Move the cursor to the parent of the current vertex.

Precondition
not_root: !IsRoot()

◆ ToChild()

virtual void vtkHyperTreeCursor::ToChild ( int  child)
pure virtual

Move the cursor to child ‘child’ of the current vertex.

Precondition
not_leaf: !IsLeaf()
valid_child: child>=0 && child<this->GetNumberOfChildren()

◆ ToSameVertex()

virtual void vtkHyperTreeCursor::ToSameVertex ( vtkHyperTreeCursor other)
pure virtual

Move the cursor to the same vertex pointed by ‘other’.

Precondition
other_exists: other!=0
same_hypertree: this->SameTree(other);
Postcondition
equal: this->IsEqual(other)

◆ IsEqual()

virtual bool vtkHyperTreeCursor::IsEqual ( vtkHyperTreeCursor other)
pure virtual

Is ‘this’ equal to ‘other’?

Precondition
other_exists: other!=0
same_hypertree: this->SameTree(other);

◆ Clone()

virtual vtkHyperTreeCursor* vtkHyperTreeCursor::Clone ( )
pure virtual

Create a copy of ‘this’.

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

◆ SameTree()

virtual int vtkHyperTreeCursor::SameTree ( vtkHyperTreeCursor other)
pure virtual

Are ‘this’ and ‘other’ pointing on the same hypertree?

Precondition
other_exists: other!=0

◆ GetNumberOfChildren()

virtual int vtkHyperTreeCursor::GetNumberOfChildren ( )
pure virtual

Return the number of children for each node (non-vertex leaf) of the tree.

Postcondition
positive_number: result>0

◆ GetDimension()

virtual int vtkHyperTreeCursor::GetDimension ( )
pure virtual

Return the dimension of the tree.

Postcondition
positive_result: result>0

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