VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHyperTreeGridOrientedCursor Class Reference

Objects for traversal a HyperTreeGrid. More...

#include <vtkHyperTreeGridOrientedCursor.h>

Inheritance diagram for vtkHyperTreeGridOrientedCursor:
[legend]
Collaboration diagram for vtkHyperTreeGridOrientedCursor:
[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...
 
vtkHyperTreeGridOrientedCursorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkHyperTreeGridOrientedCursorClone ()
 Create a copy of `this'. More...
 
void Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
 Initialize cursor at root of given tree index in grid. More...
 
void Initialize (vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkIdType index)
 JB. More...
 
void Initialize (vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkHyperTreeGridEntry &entry)
 JB. More...
 
vtkIdType GetVertexId ()
 Return the index of the current vertex in the tree. More...
 
vtkIdType GetGlobalNodeIndex ()
 Return the global index (relative to the grid) of the current vertex in the tree. More...
 
unsigned char GetDimension ()
 Return the dimension of the tree. More...
 
unsigned char GetNumberOfChildren ()
 Return the number of children for each node (non-vertex leaf) of the tree. More...
 
void SetGlobalIndexStart (vtkIdType index)
 JB. More...
 
void SetGlobalIndexFromLocal (vtkIdType index)
 JB. More...
 
void SetMask (bool state)
 Set the blanking mask is empty or not. More...
 
bool IsMasked ()
 Determine whether blanking mask is empty or not. More...
 
bool IsLeaf ()
 Is the cursor pointing to a leaf? More...
 
void SubdivideLeaf ()
 JB Fait chier normalement on devrait passer par GetEntry. More...
 
bool IsRoot ()
 Is the cursor at tree root? More...
 
unsigned int GetLevel ()
 Get the level of the tree vertex pointed by the cursor. More...
 
void ToChild (unsigned char ichild)
 Move the cursor to child `child' of the current vertex. More...
 
vtkHyperTreeGridGetGrid ()
 Set the hyper tree grid to which the cursor is pointing. More...
 
bool HasTree () const
 Return if a Tree pointing exist. More...
 
vtkHyperTreeGetTree () const
 Set the hyper tree to which the cursor is pointing. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeGridOrientedCursorSafeDownCast (vtkObjectBase *o)
 
static vtkHyperTreeGridOrientedCursorNew ()
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkHyperTreeGridOrientedCursor ()
 Constructor. More...
 
 ~vtkHyperTreeGridOrientedCursor () override
 Destructor. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkHyperTreeGridGrid
 JB Reference sur l'hyper tree grid parcouru actuellement. More...
 
vtkHyperTreeTree
 JB. More...
 
unsigned int Level
 JB. More...
 
vtkHyperTreeGridEntry Entry
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Objects for traversal a HyperTreeGrid.

JB A REVOIR Objects that can perform depth traversal of a hyper tree grid, take into account more parameters (related to the grid structure) than the compact hyper tree cursor implemented in vtkHyperTree can. This is an abstract class. Cursors are created by the HyperTreeGrid implementation.

See also
vtkHyperTreeCursor vtkHyperTree vtkHyperTreeGrid
Thanks:
This class was written by Guenole Harel and Jacques-Bernard Lekien, 2014. This class was re-written by Philippe Pebay, 2016. JB This class was re-written for more optimisation by Jacques-Bernard Lekien, Guenole Harel and Jerome Dubois, 2018. This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.

Definition at line 49 of file vtkHyperTreeGridOrientedCursor.h.

Member Typedef Documentation

Definition at line 52 of file vtkHyperTreeGridOrientedCursor.h.

Constructor & Destructor Documentation

vtkHyperTreeGridOrientedCursor::vtkHyperTreeGridOrientedCursor ( )
protected

Constructor.

vtkHyperTreeGridOrientedCursor::~vtkHyperTreeGridOrientedCursor ( )
overrideprotected

Destructor.

Member Function Documentation

static vtkTypeBool vtkHyperTreeGridOrientedCursor::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkHyperTreeGridOrientedCursor::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.

static vtkHyperTreeGridOrientedCursor* vtkHyperTreeGridOrientedCursor::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkHyperTreeGridOrientedCursor::NewInstanceInternal ( ) const
protectedvirtual
vtkHyperTreeGridOrientedCursor* vtkHyperTreeGridOrientedCursor::NewInstance ( ) const
void vtkHyperTreeGridOrientedCursor::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.

static vtkHyperTreeGridOrientedCursor* vtkHyperTreeGridOrientedCursor::New ( )
static
vtkHyperTreeGridOrientedCursor* vtkHyperTreeGridOrientedCursor::Clone ( )

Create a copy of `this'.

Postcondition
results_exists:result!=0
void vtkHyperTreeGridOrientedCursor::Initialize ( vtkHyperTreeGrid grid,
vtkIdType  treeIndex,
bool  create = false 
)

Initialize cursor at root of given tree index in grid.

void vtkHyperTreeGridOrientedCursor::Initialize ( vtkHyperTreeGrid grid,
vtkHyperTree tree,
unsigned int  level,
vtkIdType  index 
)

JB.

void vtkHyperTreeGridOrientedCursor::Initialize ( vtkHyperTreeGrid grid,
vtkHyperTree tree,
unsigned int  level,
vtkHyperTreeGridEntry entry 
)

JB.

vtkHyperTreeGrid* vtkHyperTreeGridOrientedCursor::GetGrid ( )

Set the hyper tree grid to which the cursor is pointing.

bool vtkHyperTreeGridOrientedCursor::HasTree ( ) const

Return if a Tree pointing exist.

vtkHyperTree* vtkHyperTreeGridOrientedCursor::GetTree ( ) const

Set the hyper tree to which the cursor is pointing.

vtkIdType vtkHyperTreeGridOrientedCursor::GetVertexId ( )

Return the index of the current vertex in the tree.

vtkIdType vtkHyperTreeGridOrientedCursor::GetGlobalNodeIndex ( )

Return the global index (relative to the grid) of the current vertex in the tree.

unsigned char vtkHyperTreeGridOrientedCursor::GetDimension ( )

Return the dimension of the tree.

Postcondition
positive_result: result>0
unsigned char vtkHyperTreeGridOrientedCursor::GetNumberOfChildren ( )

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

Postcondition
positive_number: result>0
void vtkHyperTreeGridOrientedCursor::SetGlobalIndexStart ( vtkIdType  index)

JB.

void vtkHyperTreeGridOrientedCursor::SetGlobalIndexFromLocal ( vtkIdType  index)

JB.

void vtkHyperTreeGridOrientedCursor::SetMask ( bool  state)

Set the blanking mask is empty or not.

Precondition
not_tree: tree
bool vtkHyperTreeGridOrientedCursor::IsMasked ( )

Determine whether blanking mask is empty or not.

bool vtkHyperTreeGridOrientedCursor::IsLeaf ( )

Is the cursor pointing to a leaf?

void vtkHyperTreeGridOrientedCursor::SubdivideLeaf ( )

JB Fait chier normalement on devrait passer par GetEntry.

bool vtkHyperTreeGridOrientedCursor::IsRoot ( )

Is the cursor at tree root?

unsigned int vtkHyperTreeGridOrientedCursor::GetLevel ( )

Get the level of the tree vertex pointed by the cursor.

void vtkHyperTreeGridOrientedCursor::ToChild ( unsigned char  ichild)

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

Precondition
not_tree: HasTree()
not_leaf: !IsLeaf()
valid_child: ichild>=0 && ichild<GetNumberOfChildren()
depth_limiter: GetLevel() <= GetDepthLimiter()

Member Data Documentation

vtkHyperTreeGrid* vtkHyperTreeGridOrientedCursor::Grid
protected

JB Reference sur l'hyper tree grid parcouru actuellement.

Definition at line 185 of file vtkHyperTreeGridOrientedCursor.h.

vtkHyperTree* vtkHyperTreeGridOrientedCursor::Tree
protected

JB.

Definition at line 190 of file vtkHyperTreeGridOrientedCursor.h.

unsigned int vtkHyperTreeGridOrientedCursor::Level
protected

JB.

Definition at line 195 of file vtkHyperTreeGridOrientedCursor.h.

vtkHyperTreeGridEntry vtkHyperTreeGridOrientedCursor::Entry
protected

Definition at line 198 of file vtkHyperTreeGridOrientedCursor.h.


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