VTK
9.4.20250129
|
Objects for traversal a HyperTreeGrid. More...
#include <vtkHyperTreeGridNonOrientedSuperCursor.h>
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. | |
vtkHyperTreeGridNonOrientedSuperCursor * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual vtkHyperTreeGridNonOrientedSuperCursor * | Clone () |
Create a copy of ‘this’. | |
virtual void | Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)=0 |
Initialize cursor at root of given tree index in grid. | |
bool | HasTree (unsigned int icursor) |
Return if a HyperTree pointing exist. | |
vtkIdType | GetVertexId () |
Return the index of the current vertex in the tree. | |
vtkIdType | GetVertexId (unsigned int icursor) |
vtkIdType | GetGlobalNodeIndex () |
Return the global index (relative to the hypertree grid and defined by server) of the current vertex in the tree. | |
vtkIdType | GetGlobalNodeIndex (unsigned int icursor) |
Return the global index (relative to the hypertree grid and defined by server) of the neighbor icursor current vertex in the tree. | |
vtkHyperTree * | GetInformation (unsigned int icursor, unsigned int &level, bool &leaf, vtkIdType &id) |
Combine three get information into one. | |
unsigned char | GetDimension () |
Return the dimension of the tree. | |
unsigned char | GetNumberOfChildren () |
Return the number of children for each node (non-vertex leaf) of the tree. | |
void | SetGlobalIndexStart (vtkIdType index) |
Calls this method once per HyperTree to set the global index of the first cell. | |
void | SetGlobalIndexFromLocal (vtkIdType index) |
Calls this method for each cell in the HT to set the global index associated with them. | |
double * | GetOrigin () |
Get the origin cell. | |
double * | GetOrigin (unsigned int icursor) |
double * | GetSize () |
Get the size cell. | |
void | SetMask (bool state) |
Set the blanking mask is empty or not. | |
void | SetMask (unsigned int icursor, bool state) |
bool | IsMasked () |
Determine whether blanking mask is empty or not. | |
bool | IsMasked (unsigned int icursor) |
bool | IsLeaf () |
Is the cursor pointing to a leaf? | |
bool | IsLeaf (unsigned int icursor) |
void | SubdivideLeaf () |
Subdivide Leaf. | |
bool | IsRoot () |
Answer if a cursor is root. | |
unsigned int | GetLevel () |
Get the level of the tree vertex pointed by the cursor. | |
unsigned int | GetLevel (unsigned int icursor) |
void | ToChild (unsigned char ichild) |
Move the cursor to child ‘child’ of the current vertex. | |
void | ToRoot () |
Move the cursor to the root vertex. | |
void | ToParent () |
Move the cursor to the parent of the current vertex. | |
unsigned int | GetNumberOfCursors () const |
Get the number of cursors to describe neighboring cells and the current cell. | |
unsigned int | GetIndiceCentralCursor () const |
Get the indice of central cursor, the current cell. | |
vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursor > | GetOrientedGeometryCursor (unsigned int icursor) |
Return the cursor pointing into i-th neighbor. | |
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursor > | GetNonOrientedGeometryCursor (unsigned int icursor) |
Return the cursor pointing into i-th neighbor. | |
vtkHyperTreeGrid * | GetGrid () |
Set the hyper tree grid to which the cursor is pointing. | |
bool | HasTree () |
Return if a Tree pointing exist. | |
vtkHyperTree * | GetTree () |
Set the hyper tree to which the cursor is pointing. | |
vtkHyperTree * | GetTree (unsigned int icursor) |
Set the hyper tree to which the cursor is pointing. | |
void | GetBounds (double bounds[6]) |
Returns the coordinates of the bounding box : (xmin, xmax, ymin, ymax, zmin, zmax). | |
void | GetBounds (unsigned int icursor, double bounds[6]) |
Returns the coordinates of the bounding box : (xmin, xmax, ymin, ymax, zmin, zmax). | |
void | GetPoint (double point[3]) |
Returns the coordinates cell center. | |
void | GetPoint (unsigned int icursor, double point[3]) |
Returns the coordinates cell center. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkHyperTreeGridNonOrientedSuperCursor * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkHyperTreeGridNonOrientedSuperCursor () | |
Constructor. | |
~vtkHyperTreeGridNonOrientedSuperCursor () override | |
Destructor. | |
unsigned int | GetIndiceEntry (unsigned int icursor) |
Get index entry of icursor. | |
unsigned int | GetIndicePreviousEntry (unsigned int icursor) |
The previous value. | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkHyperTreeGrid * | Grid |
The pointer to the HyperTreeGrid instance during the crossing. | |
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursor > | CentralCursor |
Describes the central cursor necessary an instance of vtkHyperTreeGridNonOrientedGeometryCursor. | |
unsigned int | CurrentFirstNonValidEntryByLevel |
Hyper tree grid to which the cursor is attached. | |
std::vector< unsigned int > | FirstNonValidEntryByLevel |
std::vector< vtkHyperTreeGridGeometryLevelEntry > | Entries |
unsigned int | FirstCurrentNeighboorReferenceEntry |
The last valid reference describing neighbors. | |
std::vector< unsigned int > | ReferenceEntries |
unsigned int | IndiceCentralCursor |
Index central cursor. | |
unsigned int | NumberOfCursors |
const unsigned int * | ChildCursorToParentCursorTable |
const unsigned int * | ChildCursorToChildTable |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Objects for traversal a HyperTreeGrid.
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.
Supercursor allows to retrieve various kind of cursor for any childs. This class is also a building block for Moore and VonNeumann SuperCursor, which have neighborhood traversal abilities.
Definition at line 46 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
Definition at line 49 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Constructor.
|
overrideprotected |
Destructor.
|
static |
|
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 |
|
protectedvirtual |
Reimplemented in vtkHyperTreeGridNonOrientedMooreSuperCursor, and vtkHyperTreeGridNonOrientedVonNeumannSuperCursor.
vtkHyperTreeGridNonOrientedSuperCursor * vtkHyperTreeGridNonOrientedSuperCursor::NewInstance | ( | ) | const |
|
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 vtkObjectBase.
Reimplemented in vtkHyperTreeGridNonOrientedVonNeumannSuperCursor.
|
virtual |
Create a copy of ‘this’.
|
pure virtual |
Initialize cursor at root of given tree index in grid.
The create option only applies to the central HT.
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 | ) |
Return if a HyperTree 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 hypertree grid and defined by server) of the current vertex in the tree.
vtkIdType vtkHyperTreeGridNonOrientedSuperCursor::GetGlobalNodeIndex | ( | unsigned int | icursor | ) |
Return the global index (relative to the hypertree grid and defined by server) of the neighbor icursor current vertex in the tree.
vtkHyperTree * vtkHyperTreeGridNonOrientedSuperCursor::GetInformation | ( | unsigned int | icursor, |
unsigned int & | level, | ||
bool & | leaf, | ||
vtkIdType & | id | ||
) |
Combine three get information into one.
unsigned char vtkHyperTreeGridNonOrientedSuperCursor::GetDimension | ( | ) |
Return the dimension of the tree.
unsigned char vtkHyperTreeGridNonOrientedSuperCursor::GetNumberOfChildren | ( | ) |
Return the number of children for each node (non-vertex leaf) of the tree.
void vtkHyperTreeGridNonOrientedSuperCursor::SetGlobalIndexStart | ( | vtkIdType | index | ) |
Calls this method once per HyperTree to set the global index of the first cell.
This initializes implicit indexing. /!\ This appeal is inconsistent with SetGlobalIndexFromLocal's appeal.
void vtkHyperTreeGridNonOrientedSuperCursor::SetGlobalIndexFromLocal | ( | vtkIdType | index | ) |
Calls this method for each cell in the HT to set the global index associated with them.
This initializes explicit indexing. /!\ This appeal is inconsistent with SetGlobalIndexStart's appeal.
double * vtkHyperTreeGridNonOrientedSuperCursor::GetOrigin | ( | ) |
Get the origin cell.
double * vtkHyperTreeGridNonOrientedSuperCursor::GetOrigin | ( | unsigned int | icursor | ) |
double * vtkHyperTreeGridNonOrientedSuperCursor::GetSize | ( | ) |
Get the size cell.
void vtkHyperTreeGridNonOrientedSuperCursor::SetMask | ( | bool | state | ) |
Set the blanking mask is empty or not.
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] | ) |
Returns the coordinates of the bounding box : (xmin, xmax, ymin, ymax, zmin, zmax).
void vtkHyperTreeGridNonOrientedSuperCursor::GetBounds | ( | unsigned int | icursor, |
double | bounds[6] | ||
) |
Returns the coordinates of the bounding box : (xmin, xmax, ymin, ymax, zmin, zmax).
void vtkHyperTreeGridNonOrientedSuperCursor::GetPoint | ( | double | point[3] | ) |
Returns the coordinates cell center.
void vtkHyperTreeGridNonOrientedSuperCursor::GetPoint | ( | unsigned int | icursor, |
double | point[3] | ||
) |
Returns the coordinates cell center.
bool vtkHyperTreeGridNonOrientedSuperCursor::IsLeaf | ( | ) |
Is the cursor pointing to a leaf?
bool vtkHyperTreeGridNonOrientedSuperCursor::IsLeaf | ( | unsigned int | icursor | ) |
void vtkHyperTreeGridNonOrientedSuperCursor::SubdivideLeaf | ( | ) |
Subdivide Leaf.
bool vtkHyperTreeGridNonOrientedSuperCursor::IsRoot | ( | ) |
Answer if a cursor is 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.
void vtkHyperTreeGridNonOrientedSuperCursor::ToRoot | ( | ) |
void vtkHyperTreeGridNonOrientedSuperCursor::ToParent | ( | ) |
Move the cursor to the parent of the current vertex.
Authorized if HasHistory return true.
|
inline |
Get the number of cursors to describe neighboring cells and the current cell.
Definition at line 231 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
inline |
Get the indice of central cursor, the current cell.
Definition at line 236 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.
|
protected |
Get index entry of icursor.
|
protected |
The previous value.
In the neighborhood, it does not have to be a parent.
|
protected |
The pointer to the HyperTreeGrid instance during the crossing.
Definition at line 268 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Describes the central cursor necessary an instance of vtkHyperTreeGridNonOrientedGeometryCursor.
Definition at line 274 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Hyper tree grid to which the cursor is attached.
Definition at line 279 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Definition at line 280 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Definition at line 281 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
The last valid reference describing neighbors.
It is also the offset of the first neighbor at the last level.
Definition at line 287 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Definition at line 288 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Index central cursor.
Definition at line 303 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Definition at line 308 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Definition at line 314 of file vtkHyperTreeGridNonOrientedSuperCursor.h.
|
protected |
Definition at line 320 of file vtkHyperTreeGridNonOrientedSuperCursor.h.