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

Objects for traversal a HyperTreeGrid. More...

#include <vtkHyperTreeGridNonOrientedSuperCursor.h>

Inheritance diagram for vtkHyperTreeGridNonOrientedSuperCursor:
[legend]
Collaboration diagram for vtkHyperTreeGridNonOrientedSuperCursor:
[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...
 
vtkHyperTreeGridNonOrientedSuperCursorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkHyperTreeGridNonOrientedSuperCursorClone ()
 Create a copy of `this'. More...
 
virtual void Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)=0
 Initialize cursor at root of given tree index in grid. More...
 
bool HasTree (unsigned int icursor)
 JB Return if a Tree pointing exist. More...
 
vtkIdType GetVertexId ()
 Return the index of the current vertex in the tree. More...
 
vtkIdType GetVertexId (unsigned int icursor)
 
vtkIdType GetGlobalNodeIndex ()
 Return the global index (relative to the grid) of the current vertex in the tree. More...
 
vtkIdType GetGlobalNodeIndex (unsigned int icursor)
 JB Return the global index (relative to the grid) of the neighboor icursor current vertex in the tree. More...
 
vtkHyperTreeGetInformation (unsigned int icursor, unsigned int &level, bool &leaf, vtkIdType &id)
 JB. 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...
 
doubleGetOrigin ()
 JB. More...
 
doubleGetSize ()
 
void SetMask (bool state)
 Set the blanking mask is empty or not. More...
 
void SetMask (unsigned int icursor, bool state)
 
bool IsMasked ()
 Determine whether blanking mask is empty or not. More...
 
bool IsMasked (unsigned int icursor)
 
void GetBounds (double bounds[6])
 JB Coordonnees de la boite englobante. More...
 
void GetBounds (unsigned int icursor, double bounds[6])
 
void GetPoint (double point[3])
 JB Coordonnees du centre de la maille. More...
 
void GetPoint (unsigned int icursor, double point[3])
 
bool IsLeaf ()
 Is the cursor pointing to a leaf? More...
 
bool IsLeaf (unsigned int icursor)
 
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...
 
unsigned int GetLevel (unsigned int icursor)
 
void ToChild (unsigned char ichild)
 Move the cursor to child `child' of the current vertex. More...
 
void ToRoot ()
 Move the cursor to the root vertex. More...
 
void ToParent ()
 Move the cursor to the parent of the current vertex. More...
 
unsigned int GetNumberOfCursors ()
 JB. More...
 
vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursorGetOrientedGeometryCursor (unsigned int icursor)
 Return the cursor pointing into i-th neighbor. More...
 
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursorGetNonOrientedGeometryCursor (unsigned int icursor)
 Return the cursor pointing into i-th neighbor. More...
 
vtkHyperTreeGridGetGrid ()
 Set the hyper tree grid to which the cursor is pointing. More...
 
bool HasTree ()
 Return if a Tree pointing exist. More...
 
vtkHyperTreeGetTree ()
 Set the hyper tree to which the cursor is pointing. More...
 
vtkHyperTreeGetTree (unsigned int icursor)
 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 vtkHyperTreeGridNonOrientedSuperCursorSafeDownCast (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 ()
 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
 
 vtkHyperTreeGridNonOrientedSuperCursor ()
 Constructor. More...
 
 ~vtkHyperTreeGridNonOrientedSuperCursor () override
 Destructor. More...
 
unsigned int GetIndiceEntry (unsigned int icursor)
 JB. More...
 
unsigned int GetIndicePreviousEntry (unsigned int icursor)
 JB La valeur precedente. 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...
 
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursorCentralCursor
 JB. More...
 
unsigned int CurrentFirstNonValidEntryByLevel
 JB Hyper tree grid to which the cursor is attached. More...
 
std::vector< unsigned intFirstNonValidEntryByLevel
 
std::vector< vtkHyperTreeGridGeometryLevelEntryEntries
 
unsigned int FirstCurrentNeighboorReferenceEntry
 JB La derniere reference valide pour decrire tous les voisins. More...
 
std::vector< unsigned intReferenceEntries
 
unsigned int IndiceCentralCursor
 JB. More...
 
unsigned int NumberOfCursors
 
const unsigned intChildCursorToParentCursorTable
 
const unsigned intChildCursorToChildTable
 
- 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. This class was re-written and optimized 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 54 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

Member Typedef Documentation

Definition at line 57 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

Constructor & Destructor Documentation

vtkHyperTreeGridNonOrientedSuperCursor::vtkHyperTreeGridNonOrientedSuperCursor ( )
protected

Constructor.

vtkHyperTreeGridNonOrientedSuperCursor::~vtkHyperTreeGridNonOrientedSuperCursor ( )
overrideprotected

Destructor.

Member Function Documentation

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

Reimplemented in vtkHyperTreeGridNonOrientedMooreSuperCursor, and vtkHyperTreeGridNonOrientedVonNeumannSuperCursor.

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

Reimplemented in vtkHyperTreeGridNonOrientedVonNeumannSuperCursor.

virtual vtkHyperTreeGridNonOrientedSuperCursor* vtkHyperTreeGridNonOrientedSuperCursor::Clone ( )
virtual

Create a copy of `this'.

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

Initialize cursor at root of given tree index in grid.

JB Le create ne s'applique que sur le HT central.

Implemented in vtkHyperTreeGridNonOrientedMooreSuperCursor, and vtkHyperTreeGridNonOrientedVonNeumannSuperCursor.

vtkHyperTreeGrid* vtkHyperTreeGridNonOrientedSuperCursor::GetGrid ( )

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

bool vtkHyperTreeGridNonOrientedSuperCursor::HasTree ( )

Return if a Tree pointing exist.

bool vtkHyperTreeGridNonOrientedSuperCursor::HasTree ( unsigned int  icursor)

JB Return if a Tree pointing exist.

vtkHyperTree* vtkHyperTreeGridNonOrientedSuperCursor::GetTree ( )

Set the hyper tree to which the cursor is pointing.

vtkHyperTree* vtkHyperTreeGridNonOrientedSuperCursor::GetTree ( unsigned int  icursor)

Set the hyper tree to which the cursor is pointing.

vtkIdType vtkHyperTreeGridNonOrientedSuperCursor::GetVertexId ( )

Return the index of the current vertex in the tree.

vtkIdType vtkHyperTreeGridNonOrientedSuperCursor::GetVertexId ( unsigned int  icursor)
vtkIdType vtkHyperTreeGridNonOrientedSuperCursor::GetGlobalNodeIndex ( )

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

vtkIdType vtkHyperTreeGridNonOrientedSuperCursor::GetGlobalNodeIndex ( unsigned int  icursor)

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

vtkHyperTree* vtkHyperTreeGridNonOrientedSuperCursor::GetInformation ( unsigned int  icursor,
unsigned int level,
bool &  leaf,
vtkIdType id 
)

JB.

unsigned char vtkHyperTreeGridNonOrientedSuperCursor::GetDimension ( )

Return the dimension of the tree.

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

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

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

JB.

void vtkHyperTreeGridNonOrientedSuperCursor::SetGlobalIndexFromLocal ( vtkIdType  index)

JB.

double* vtkHyperTreeGridNonOrientedSuperCursor::GetOrigin ( )

JB.

double* vtkHyperTreeGridNonOrientedSuperCursor::GetSize ( )
void vtkHyperTreeGridNonOrientedSuperCursor::SetMask ( bool  state)

Set the blanking mask is empty or not.

Precondition
not_tree: tree
void vtkHyperTreeGridNonOrientedSuperCursor::SetMask ( unsigned int  icursor,
bool  state 
)
bool vtkHyperTreeGridNonOrientedSuperCursor::IsMasked ( )

Determine whether blanking mask is empty or not.

bool vtkHyperTreeGridNonOrientedSuperCursor::IsMasked ( unsigned int  icursor)
void vtkHyperTreeGridNonOrientedSuperCursor::GetBounds ( double  bounds[6])

JB Coordonnees de la boite englobante.

void vtkHyperTreeGridNonOrientedSuperCursor::GetBounds ( unsigned int  icursor,
double  bounds[6] 
)
void vtkHyperTreeGridNonOrientedSuperCursor::GetPoint ( double  point[3])

JB Coordonnees du centre de la maille.

void vtkHyperTreeGridNonOrientedSuperCursor::GetPoint ( unsigned int  icursor,
double  point[3] 
)
bool vtkHyperTreeGridNonOrientedSuperCursor::IsLeaf ( )

Is the cursor pointing to a leaf?

bool vtkHyperTreeGridNonOrientedSuperCursor::IsLeaf ( unsigned int  icursor)
void vtkHyperTreeGridNonOrientedSuperCursor::SubdivideLeaf ( )

JB Fait chier normalement on devrait passer par GetEntry.

bool vtkHyperTreeGridNonOrientedSuperCursor::IsRoot ( )

Is the cursor at tree root?

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::GetLevel ( )

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

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::GetLevel ( unsigned int  icursor)
void vtkHyperTreeGridNonOrientedSuperCursor::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()
void vtkHyperTreeGridNonOrientedSuperCursor::ToRoot ( )

Move the cursor to the root vertex.

Precondition
can be root
Postcondition
is_root: IsRoot()
void vtkHyperTreeGridNonOrientedSuperCursor::ToParent ( )

Move the cursor to the parent of the current vertex.

Authorized if HasHistory return true.

Precondition
Non_root: !IsRoot()
unsigned int vtkHyperTreeGridNonOrientedSuperCursor::GetNumberOfCursors ( )
inline

JB.

Definition at line 223 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor> vtkHyperTreeGridNonOrientedSuperCursor::GetOrientedGeometryCursor ( unsigned int  icursor)

Return the cursor pointing into i-th neighbor.

The neighborhood definition depends on the type of cursor. NB: Only super cursors keep track of neighborhoods.

vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor> vtkHyperTreeGridNonOrientedSuperCursor::GetNonOrientedGeometryCursor ( unsigned int  icursor)

Return the cursor pointing into i-th neighbor.

The neighborhood definition depends on the type of cursor. NB: Only super cursors keep track of neighborhoods.

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::GetIndiceEntry ( unsigned int  icursor)
protected

JB.

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::GetIndicePreviousEntry ( unsigned int  icursor)
protected

JB La valeur precedente.

Dans le voisinage, ce n'est pas forcement un parent.

Member Data Documentation

vtkHyperTreeGrid* vtkHyperTreeGridNonOrientedSuperCursor::Grid
protected

JB Reference sur l'hyper tree grid parcouru actuellement.

Definition at line 257 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor> vtkHyperTreeGridNonOrientedSuperCursor::CentralCursor
protected

JB.

Definition at line 263 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::CurrentFirstNonValidEntryByLevel
protected

JB Hyper tree grid to which the cursor is attached.

Definition at line 268 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

std::vector< unsigned int > vtkHyperTreeGridNonOrientedSuperCursor::FirstNonValidEntryByLevel
protected

Definition at line 269 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

std::vector< vtkHyperTreeGridGeometryLevelEntry > vtkHyperTreeGridNonOrientedSuperCursor::Entries
protected

Definition at line 270 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::FirstCurrentNeighboorReferenceEntry
protected

JB La derniere reference valide pour decrire tous les voisins.

C'est donc aussi l'offset du premier voisin du dernier niveau.

Definition at line 276 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

std::vector< unsigned int > vtkHyperTreeGridNonOrientedSuperCursor::ReferenceEntries
protected

Definition at line 277 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::IndiceCentralCursor
protected

JB.

Definition at line 292 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

unsigned int vtkHyperTreeGridNonOrientedSuperCursor::NumberOfCursors
protected

Definition at line 295 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

const unsigned int* vtkHyperTreeGridNonOrientedSuperCursor::ChildCursorToParentCursorTable
protected

Definition at line 299 of file vtkHyperTreeGridNonOrientedSuperCursor.h.

const unsigned int* vtkHyperTreeGridNonOrientedSuperCursor::ChildCursorToChildTable
protected

Definition at line 303 of file vtkHyperTreeGridNonOrientedSuperCursor.h.


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