VTK  9.3.20240529
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkHyperTreeGrid Class Reference

A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid. More...

#include <vtkHyperTreeGrid.h>

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

Classes

class  vtkHyperTreeGridIterator
 An iterator object to iteratively access trees in the grid. More...
 

Public Types

typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS ,
  FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT , CELL , FIELD , POINT_THEN_CELL ,
  VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. More...
 
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.
 
vtkHyperTreeGridNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetModeSqueeze (const char *)
 Set/Get mode squeeze.
 
virtual char * GetModeSqueeze ()
 
virtual void Squeeze ()
 Squeeze this representation.
 
int GetDataObjectType () override
 Return what type of dataset this is.
 
virtual void CopyStructure (vtkDataObject *)
 Copy the internal geometric and topological structure of a vtkHyperTreeGrid object.
 
virtual void CopyEmptyStructure (vtkDataObject *)
 Copy the internal structure with no data associated.
 
vtkIdType GetMaxNumberOfTrees () const
 Return the maximum number of trees in the level 0 grid.
 
vtkIdType GetNumberOfNonEmptyTrees ()
 Get the number of non empty trees in this grid.
 
vtkIdType GetNumberOfLeaves ()
 Get the number of leaves in the primal tree grid.
 
unsigned int GetNumberOfLevels (vtkIdType)
 Return the number of levels in an individual (primal) tree.
 
unsigned int GetNumberOfLevels ()
 Return the number of levels in the hyper tree grid.
 
bool HasMask ()
 Determine whether blanking mask is empty or not.
 
vtkHyperTreeGridNonOrientedGeometryCursorFindNonOrientedGeometryCursor (double x[3])
 Return a geometric cursor pointing to one of the nodes at position x
 
virtual unsigned int FindDichotomicX (double value, double tol=0.0) const
 
virtual unsigned int FindDichotomicY (double value, double tol=0.0) const
 
virtual unsigned int FindDichotomicZ (double value, double tol=0.0) const
 
void Initialize () override
 Restore data object to initial state.
 
virtual vtkHyperTreeGetTree (vtkIdType, bool create=false)
 Return tree located at given index of hyper tree grid NB: This will construct a new HyperTree if grid slot is empty.
 
void SetTree (vtkIdType, vtkHyperTree *)
 Assign given tree to given index of hyper tree grid NB: This will create a new slot in the grid if needed.
 
void ShallowCopy (vtkDataObject *) override
 Create shallow copy of hyper tree grid.
 
void DeepCopy (vtkDataObject *) override
 Create deep copy of hyper tree grid.
 
int GetExtentType () override
 Structured extent.
 
virtual unsigned long GetActualMemorySizeBytes ()
 Return the actual size of the data in bytes.
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes).
 
bool SupportsGhostArray (int type) override
 Returns true if type is CELL, false otherwise.
 
vtkBitArrayGetPureMask ()
 Get or create pure material mask.
 
unsigned int GetChildMask (unsigned int)
 Return hard-coded bitcode correspondng to child mask Dimension 1: Factor 2: 0: 100, 1: 001 Factor 3: 0: 100, 1: 010, 2: 001 Dimension 2: Factor 2: 0: 1101 0000 0, 1: 0110 0100 0 2: 0001 0011 0, 3: 0000 0101 1 Factor 3: 0: 1101 0000 0, 1: 0100 0000 0, 2: 0110 0100 0 3: 0001 0000 0, 4: 0000 1000 0, 5: 0000 0100 0 6: 0001 0011 0, 7: 0000 0001 0, 8: 0000 0101 1 Dimension 3: Factor 2: 0: 1101 1000 0110 1000 0000 0000 000, 1: 0110 1100 0011 0010 0000 0000 000 2: 0001 1011 0000 1001 1000 0000 000, 3: 0000 1101 1000 0010 1100 0000 000 4: 0000 0000 0110 1000 0011 0110 000, 5: 0000 0000 0011 0010 0001 1011 000 6: 0000 0000 0000 1001 1000 0110 110, 7: 0000 0000 0000 0010 1100 0011 011 Factor 3: 0: 1101 1000 0110 1000 0000 0000 000 1: 0100 1000 0010 0000 0000 0000 000 2: 0110 1100 0011 0010 0000 0000 000 3: 0001 1000 0000 1000 0000 0000 000 4: 0000 1000 0000 0000 0000 0000 000 5: 0000 1100 0000 0010 0000 0000 000 6: 0001 1011 0000 1001 1000 0000 000 7: 0000 1001 0000 0000 1000 0000 000 8: 0000 1101 1000 0010 1100 0000 000 9: 0000 0000 0110 1000 0000 0000 000 10: 0000 0000 0010 0000 0000 0000 000 11: 0000 0000 0011 0010 0000 0000 000 12: 0000 0000 0000 1000 0000 0000 000 13: 0000 0000 0000 0100 0000 0000 000 14: 0000 0000 0000 0010 0000 0000 000 15: 0000 0000 0000 1001 1000 0000 000 16: 0000 0000 0000 0000 1000 0000 000 17: 0000 0000 0000 0010 1100 0000 000 18: 0000 0000 0110 1000 0011 0110 000 19: 0000 0000 0010 0000 0001 0010 000 20: 0000 0000 0011 0010 0001 1011 000 21: 0000 0000 0000 1000 0000 0110 000 22: 0000 0000 0000 0000 0000 0010 000 23: 0000 0000 0000 0010 0000 0011 000 24: 0000 0000 0000 1001 1000 0110 110 25: 0000 0000 0000 0000 1000 0010 010 26: 0000 0000 0000 0010 1100 0011 011.
 
void GetIndexFromLevelZeroCoordinates (vtkIdType &, unsigned int, unsigned int, unsigned int) const
 Convert the Cartesian coordinates of a root in the grid to its global index.
 
vtkIdType GetShiftedLevelZeroIndex (vtkIdType, int, int, int) const
 Return the root index of a root cell with given index displaced.
 
void GetLevelZeroCoordinatesFromIndex (vtkIdType, unsigned int &, unsigned int &, unsigned int &) const
 Convert the global index of a root to its Cartesian coordinates in the grid.
 
virtual void GetLevelZeroOriginAndSizeFromIndex (vtkIdType, double *, double *)
 Convert the global index of a root to its Spatial coordinates origin and size.
 
virtual void GetLevelZeroOriginFromIndex (vtkIdType, double *)
 Convert the global index of a root to its Spatial coordinates origin and size.
 
vtkIdType GetGlobalNodeIndexMax ()
 Return the maximum global index value.
 
void InitializeLocalIndexNode ()
 Initialize local indexes for every individual Hyper Tree after they have been refined.
 
bool HasAnyGhostCells () const
 Returns true if a ghost cell array is defined.
 
vtkUnsignedCharArrayGetGhostCells ()
 Gets the array that defines the ghost type of each cell.
 
vtkUnsignedCharArrayGetTreeGhostArray ()
 Gets the array that defines the ghost type of each cell.
 
vtkUnsignedCharArrayAllocateTreeGhostArray ()
 Allocate ghost array for points.
 
void InitializeTreeIterator (vtkHyperTreeGridIterator &)
 Initialize an iterator to browse level 0 trees.
 
virtual void ComputeBounds ()
 Compute the hyper tree grid bounding box ignoring masked cells.
 
virtual void GetGridBounds (double bounds[6])
 Return a pointer to the grid bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
double * GetCenter ()
 Get the center of the bounding box.
 
void GetCenter (double center[3])
 Get the center of the bounding box.
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's hypertree node data.
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the hypertree node field data stored as cell data.
 
vtkIdType GetNumberOfElements (int type) override
 Returns the number of nodes.
 
vtkIdType GetNumberOfCells ()
 Return the number of cells.
 
void SetDimensions (const unsigned int dims[3])
 Set/Get sizes of this rectilinear grid dataset.
 
void SetDimensions (const int dims[3])
 Set/Get sizes of this rectilinear grid dataset.
 
void SetDimensions (unsigned int i, unsigned int j, unsigned int k)
 Set/Get sizes of this rectilinear grid dataset.
 
void SetDimensions (int i, int j, int k)
 Set/Get sizes of this rectilinear grid dataset.
 
const unsigned int * GetDimensions () const
 Get dimensions of this rectilinear grid dataset.
 
void GetDimensions (int dim[3]) const
 Get dimensions of this rectilinear grid dataset.
 
void GetDimensions (unsigned int dim[3]) const
 Get dimensions of this rectilinear grid dataset.
 
void SetExtent (const int extent[6])
 Different ways to set the extent of the data array.
 
void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 Different ways to set the extent of the data array.
 
virtual int * GetExtent ()
 Different ways to set the extent of the data array.
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 Different ways to set the extent of the data array.
 
virtual void GetExtent (int[6])
 Different ways to set the extent of the data array.
 
const unsigned int * GetCellDims () const
 Get grid sizes of this structured cells dataset.
 
void GetCellDims (int cellDims[3]) const
 Get grid sizes of this structured cells dataset.
 
void GetCellDims (unsigned int cellDims[3]) const
 Get grid sizes of this structured cells dataset.
 
unsigned int GetDimension () const
 Get the dimensionality of the grid deduite a partir de Dimensions/Extent.
 
void Get1DAxis (unsigned int &axis) const
 Retourne l'indice de la dimension valide.
 
void Get2DAxes (unsigned int &axis1, unsigned int &axis2) const
 Retourne l'indice des deux dimensions valides.
 
const unsigned int * GetAxes () const
 Get the axis information (used for CopyStructure)
 
unsigned int GetNumberOfChildren () const
 The number of children each node can have.
 
virtual void SetTransposedRootIndexing (bool)
 Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.
 
virtual bool GetTransposedRootIndexing ()
 Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.
 
void SetIndexingModeToKJI ()
 Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.
 
void SetIndexingModeToIJK ()
 Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.
 
unsigned int GetOrientation () const
 Get the orientation of 1D or 2D grids:
 
virtual bool GetFreezeState ()
 Get the state of frozen.
 
void SetBranchFactor (unsigned int)
 Set/Get the subdivision factor in the grid refinement scheme.
 
unsigned int GetBranchFactor () const
 Set/Get the subdivision factor in the grid refinement scheme.
 
virtual void SetXCoordinates (vtkDataArray *)
 Set/Get the grid coordinates in the x-direction.
 
virtual vtkDataArrayGetXCoordinates ()
 Set/Get the grid coordinates in the x-direction.
 
virtual void SetYCoordinates (vtkDataArray *)
 Set/Get the grid coordinates in the y-direction.
 
virtual vtkDataArrayGetYCoordinates ()
 Set/Get the grid coordinates in the y-direction.
 
virtual void SetZCoordinates (vtkDataArray *)
 Set/Get the grid coordinates in the z-direction.
 
virtual vtkDataArrayGetZCoordinates ()
 Set/Get the grid coordinates in the z-direction.
 
virtual void CopyCoordinates (const vtkHyperTreeGrid *output)
 Augented services on Coordinates.
 
virtual void SetFixedCoordinates (unsigned int axis, double value)
 Augented services on Coordinates.
 
void SetMask (vtkBitArray *)
 Set/Get the blanking mask of primal leaf cells.
 
virtual vtkBitArrayGetMask ()
 Set/Get the blanking mask of primal leaf cells.
 
virtual void SetHasInterface (bool)
 Set/Get presence or absence of interface.
 
virtual bool GetHasInterface ()
 Set/Get presence or absence of interface.
 
virtual void HasInterfaceOn ()
 Set/Get presence or absence of interface.
 
virtual void HasInterfaceOff ()
 Set/Get presence or absence of interface.
 
virtual void SetInterfaceNormalsName (const char *)
 Set/Get names of interface normal vectors arrays.
 
virtual char * GetInterfaceNormalsName ()
 Set/Get names of interface normal vectors arrays.
 
virtual void SetInterfaceInterceptsName (const char *)
 Set/Get names of interface intercepts arrays.
 
virtual char * GetInterfaceInterceptsName ()
 Set/Get names of interface intercepts arrays.
 
virtual void SetDepthLimiter (unsigned int)
 Set/Get depth limiter value.
 
virtual unsigned int GetDepthLimiter ()
 Set/Get depth limiter value.
 
void InitializeOrientedCursor (vtkHyperTreeGridOrientedCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridOrientedCursorNewOrientedCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeOrientedGeometryCursor (vtkHyperTreeGridOrientedGeometryCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridOrientedGeometryCursorNewOrientedGeometryCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedCursor (vtkHyperTreeGridNonOrientedCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedCursorNewNonOrientedCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedGeometryCursor (vtkHyperTreeGridNonOrientedGeometryCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedGeometryCursorNewNonOrientedGeometryCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedUnlimitedGeometryCursor (vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedUnlimitedGeometryCursorNewNonOrientedUnlimitedGeometryCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedVonNeumannSuperCursor (vtkHyperTreeGridNonOrientedVonNeumannSuperCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedVonNeumannSuperCursorNewNonOrientedVonNeumannSuperCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedVonNeumannSuperCursorLight (vtkHyperTreeGridNonOrientedVonNeumannSuperCursorLight *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedVonNeumannSuperCursorLightNewNonOrientedVonNeumannSuperCursorLight (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedMooreSuperCursor (vtkHyperTreeGridNonOrientedMooreSuperCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedMooreSuperCursorNewNonOrientedMooreSuperCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedMooreSuperCursorLight (vtkHyperTreeGridNonOrientedMooreSuperCursorLight *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedMooreSuperCursorLightNewNonOrientedMooreSuperCursorLight (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
void InitializeNonOrientedUnlimitedMooreSuperCursor (vtkHyperTreeGridNonOrientedUnlimitedMooreSuperCursor *cursor, vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
vtkHyperTreeGridNonOrientedUnlimitedMooreSuperCursorNewNonOrientedUnlimitedMooreSuperCursor (vtkIdType index, bool create=false)
 Used to initialize a cursor of the given type.
 
virtual double * GetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
- Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Data objects are composite objects and need to check each part for MTime.
 
virtual void Initialize ()
 Restore data object to initial state,.
 
void ReleaseData ()
 Release data back to system to conserve memory resource.
 
virtual int GetDataObjectType ()
 Return class name of data type.
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
 
virtual unsigned long GetActualMemorySize ()
 Return the actual size of the data in kibibytes (1024 bytes).
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information.
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information.
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data.
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted.
 
virtual void ShallowCopy (vtkDataObject *src)
 The goal of the method is to copy the data up to the array pointers only.
 
virtual void DeepCopy (vtkDataObject *src)
 The goal of the method is to copy the complete data from src into this object.
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent.
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkUnsignedCharArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified attribute type.
 
virtual bool SupportsGhostArray (int type)
 Returns if this type of data object support ghost array for specified type.
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData.
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from.
 
virtual vtkIdType GetNumberOfElements (int type)
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object.
 
virtual vtkTypeBool GetDataReleased ()
 Get the flag indicating the data has been released.
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object.
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object.
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
- 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.
 
vtkCommandGetCommand (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 vtkInformationIntegerKeyLEVELS ()
 
static vtkInformationIntegerKeyDIMENSION ()
 
static vtkInformationIntegerKeyORIENTATION ()
 
static vtkInformationDoubleVectorKeySIZES ()
 
static vtkHyperTreeGridNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeGridSafeDownCast (vtkObjectBase *o)
 
static vtkHyperTreeGridGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkHyperTreeGridGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array.
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters.
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e.
 
static int GetAssociationTypeFromString (const char *associationName)
 Given a string association name, this static method returns an integer association type for the attribute (i.e.
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
static void SetGlobalReleaseDataFlag (vtkTypeBool val)
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
static vtkTypeBool GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
- 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.
 
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 vtkObjectBaseNew ()
 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.
 

Static Public Attributes

static constexpr vtkIdType InvalidIndex = ~0
 Invalid index that is returned for undefined nodes, for example for nodes that are out of bounds (they can exist with the super cursors).
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkHyperTreeGrid ()
 Constructor with default bounds (0,1, 0,1, 0,1).
 
 ~vtkHyperTreeGrid () override
 Destructor.
 
- Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataObject ()
 
 ~vtkDataObject () 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.
 
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

char * ModeSqueeze
 ModeSqueeze.
 
double Bounds [6]
 
double Center [3]
 
bool FreezeState
 
unsigned int BranchFactor
 
unsigned int Dimension
 
unsigned int NumberOfChildren
 
bool TransposedRootIndexing
 
int DataDescription
 
int Extent [6]
 
bool WithCoordinates
 
vtkDataArrayXCoordinates
 
vtkDataArrayYCoordinates
 
vtkDataArrayZCoordinates
 
vtkBitArrayMask
 
vtkBitArrayPureMask
 
bool HasInterface
 
char * InterfaceNormalsName
 
char * InterfaceInterceptsName
 
std::map< vtkIdType, vtkSmartPointer< vtkHyperTree > > HyperTrees
 
vtkNew< vtkCellDataCellData
 
unsigned int DepthLimiter
 
vtkUnsignedCharArrayTreeGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
bool TreeGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
vtkTypeBool DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- 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 ()
 

Detailed Description

A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.

An hypertree grid is a dataset containing a rectilinear grid of root nodes, each of which can be refined as a vtkHyperTree grid. This organization of the root nodes allows for the definition of tree-based AMR grids that do not have uniform geometry. Some filters can be applied on this dataset: contour, outline, geometry.

The order and number of points must match that specified by the dimensions of the grid. The point order increases in i fastest (from 0<=i<dims[0]), then j (0<=j<dims[1]), then k (0<=k<dims[2]) where dims[] are the dimensions of the grid in the i-j-k topological directions. The number of points is dims[0]*dims[1]*dims[2]. The same is true for the cells of the grid. The order and number of cells must match that specified by the dimensions of the grid. The cell order increases in i fastest (from 0<=i<(dims[0]-1)), then j (0<=j<(dims[1]-1)), then k (0<=k<(dims[2]-1)) The number of cells is (dims[0]-1)*(dims[1]-1)*(dims[2]-1).

Dimensions : number of points by direction of rectilinear grid CellDims : number of cells by directions of rectilinear grid (1 for each dimensions 1)

Warning
It is not a spatial search object. If you are looking for this kind of octree see vtkCellLocator instead. Extent support is not finished yet.
See also
vtkHyperTree vtkRectilinearGrid
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 rewritten by Philippe Pebay, 2016 This class was modified by Jacques-Bernard Lekien 2018 This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.
Tests:
vtkHyperTreeGrid (Tests)

Definition at line 88 of file vtkHyperTreeGrid.h.

Member Typedef Documentation

◆ Superclass

Definition at line 97 of file vtkHyperTreeGrid.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGrid()

vtkHyperTreeGrid::vtkHyperTreeGrid ( )
protected

Constructor with default bounds (0,1, 0,1, 0,1).

◆ ~vtkHyperTreeGrid()

vtkHyperTreeGrid::~vtkHyperTreeGrid ( )
overrideprotected

Destructor.

Member Function Documentation

◆ LEVELS()

static vtkInformationIntegerKey * vtkHyperTreeGrid::LEVELS ( )
static

◆ DIMENSION()

static vtkInformationIntegerKey * vtkHyperTreeGrid::DIMENSION ( )
static

◆ ORIENTATION()

static vtkInformationIntegerKey * vtkHyperTreeGrid::ORIENTATION ( )
static

◆ SIZES()

static vtkInformationDoubleVectorKey * vtkHyperTreeGrid::SIZES ( )
static

◆ New()

static vtkHyperTreeGrid * vtkHyperTreeGrid::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkHyperTreeGrid::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 vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHyperTreeGrid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

◆ NewInstance()

vtkHyperTreeGrid * vtkHyperTreeGrid::NewInstance ( ) const

◆ PrintSelf()

void vtkHyperTreeGrid::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 vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SetModeSqueeze()

virtual void vtkHyperTreeGrid::SetModeSqueeze ( const char *  )
virtual

Set/Get mode squeeze.

◆ GetModeSqueeze()

virtual char * vtkHyperTreeGrid::GetModeSqueeze ( )
virtual

◆ Squeeze()

virtual void vtkHyperTreeGrid::Squeeze ( )
virtual

Squeeze this representation.

◆ GetDataObjectType()

int vtkHyperTreeGrid::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

Definition at line 120 of file vtkHyperTreeGrid.h.

◆ CopyStructure()

virtual void vtkHyperTreeGrid::CopyStructure ( vtkDataObject )
virtual

Copy the internal geometric and topological structure of a vtkHyperTreeGrid object.

Reimplemented in vtkUniformHyperTreeGrid.

◆ CopyEmptyStructure()

virtual void vtkHyperTreeGrid::CopyEmptyStructure ( vtkDataObject )
virtual

Copy the internal structure with no data associated.

◆ SetDimensions() [1/4]

void vtkHyperTreeGrid::SetDimensions ( const unsigned int  dims[3])

Set/Get sizes of this rectilinear grid dataset.

◆ SetDimensions() [2/4]

void vtkHyperTreeGrid::SetDimensions ( const int  dims[3])

Set/Get sizes of this rectilinear grid dataset.

◆ SetDimensions() [3/4]

void vtkHyperTreeGrid::SetDimensions ( unsigned int  i,
unsigned int  j,
unsigned int  k 
)

Set/Get sizes of this rectilinear grid dataset.

◆ SetDimensions() [4/4]

void vtkHyperTreeGrid::SetDimensions ( int  i,
int  j,
int  k 
)

Set/Get sizes of this rectilinear grid dataset.

◆ GetDimensions() [1/3]

const unsigned int * vtkHyperTreeGrid::GetDimensions ( ) const

Get dimensions of this rectilinear grid dataset.

The dimensions correspond to the number of points

◆ GetDimensions() [2/3]

void vtkHyperTreeGrid::GetDimensions ( int  dim[3]) const

Get dimensions of this rectilinear grid dataset.

The dimensions correspond to the number of points

◆ GetDimensions() [3/3]

void vtkHyperTreeGrid::GetDimensions ( unsigned int  dim[3]) const

Get dimensions of this rectilinear grid dataset.

The dimensions correspond to the number of points

◆ SetExtent() [1/2]

void vtkHyperTreeGrid::SetExtent ( const int  extent[6])

Different ways to set the extent of the data array.

The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). Set/Get extent of this rectilinear grid dataset.

◆ SetExtent() [2/2]

void vtkHyperTreeGrid::SetExtent ( int  x1,
int  x2,
int  y1,
int  y2,
int  z1,
int  z2 
)

Different ways to set the extent of the data array.

The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). Set/Get extent of this rectilinear grid dataset.

◆ GetExtent() [1/3]

virtual int * vtkHyperTreeGrid::GetExtent ( )
virtual

Different ways to set the extent of the data array.

The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). Set/Get extent of this rectilinear grid dataset.

◆ GetExtent() [2/3]

virtual void vtkHyperTreeGrid::GetExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

Different ways to set the extent of the data array.

The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). Set/Get extent of this rectilinear grid dataset.

◆ GetExtent() [3/3]

virtual void vtkHyperTreeGrid::GetExtent ( int  [6])
virtual

Different ways to set the extent of the data array.

The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). Set/Get extent of this rectilinear grid dataset.

◆ GetCellDims() [1/3]

const unsigned int * vtkHyperTreeGrid::GetCellDims ( ) const

Get grid sizes of this structured cells dataset.

Valeurs deduites a partir de Dimensions/Extent Les dimensions non exprimees auront pour valeur 1.

◆ GetCellDims() [2/3]

void vtkHyperTreeGrid::GetCellDims ( int  cellDims[3]) const

Get grid sizes of this structured cells dataset.

Valeurs deduites a partir de Dimensions/Extent Les dimensions non exprimees auront pour valeur 1.

◆ GetCellDims() [3/3]

void vtkHyperTreeGrid::GetCellDims ( unsigned int  cellDims[3]) const

Get grid sizes of this structured cells dataset.

Valeurs deduites a partir de Dimensions/Extent Les dimensions non exprimees auront pour valeur 1.

◆ GetDimension()

unsigned int vtkHyperTreeGrid::GetDimension ( ) const
inline

Get the dimensionality of the grid deduite a partir de Dimensions/Extent.

Definition at line 187 of file vtkHyperTreeGrid.h.

◆ Get1DAxis()

void vtkHyperTreeGrid::Get1DAxis ( unsigned int &  axis) const
inline

Retourne l'indice de la dimension valide.

Definition at line 194 of file vtkHyperTreeGrid.h.

◆ Get2DAxes()

void vtkHyperTreeGrid::Get2DAxes ( unsigned int &  axis1,
unsigned int &  axis2 
) const
inline

Retourne l'indice des deux dimensions valides.

Definition at line 205 of file vtkHyperTreeGrid.h.

◆ GetAxes()

const unsigned int * vtkHyperTreeGrid::GetAxes ( ) const
inline

Get the axis information (used for CopyStructure)

Definition at line 217 of file vtkHyperTreeGrid.h.

◆ GetNumberOfChildren()

unsigned int vtkHyperTreeGrid::GetNumberOfChildren ( ) const
inline

The number of children each node can have.

Definition at line 225 of file vtkHyperTreeGrid.h.

◆ SetTransposedRootIndexing()

virtual void vtkHyperTreeGrid::SetTransposedRootIndexing ( bool  )
virtual

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.

◆ GetTransposedRootIndexing()

virtual bool vtkHyperTreeGrid::GetTransposedRootIndexing ( )
virtual

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.

◆ SetIndexingModeToKJI()

void vtkHyperTreeGrid::SetIndexingModeToKJI ( )
inline

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.

Definition at line 235 of file vtkHyperTreeGrid.h.

◆ SetIndexingModeToIJK()

void vtkHyperTreeGrid::SetIndexingModeToIJK ( )
inline

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last.

Definition at line 236 of file vtkHyperTreeGrid.h.

◆ GetOrientation()

unsigned int vtkHyperTreeGrid::GetOrientation ( ) const
inline

Get the orientation of 1D or 2D grids:

  • in 1D: 0, 1, 2 = aligned along X, Y, Z axis
  • in 2D: 0, 1, 2 = normal to X, Y, Z axis NB: Not used in 3D

Definition at line 246 of file vtkHyperTreeGrid.h.

◆ GetFreezeState()

virtual bool vtkHyperTreeGrid::GetFreezeState ( )
virtual

Get the state of frozen.

◆ SetBranchFactor()

void vtkHyperTreeGrid::SetBranchFactor ( unsigned int  )

Set/Get the subdivision factor in the grid refinement scheme.

◆ GetBranchFactor()

unsigned int vtkHyperTreeGrid::GetBranchFactor ( ) const
inline

Set/Get the subdivision factor in the grid refinement scheme.

Definition at line 261 of file vtkHyperTreeGrid.h.

◆ GetMaxNumberOfTrees()

vtkIdType vtkHyperTreeGrid::GetMaxNumberOfTrees ( ) const

Return the maximum number of trees in the level 0 grid.

◆ GetNumberOfNonEmptyTrees()

vtkIdType vtkHyperTreeGrid::GetNumberOfNonEmptyTrees ( )

Get the number of non empty trees in this grid.

◆ GetNumberOfLeaves()

vtkIdType vtkHyperTreeGrid::GetNumberOfLeaves ( )

Get the number of leaves in the primal tree grid.

◆ GetNumberOfLevels() [1/2]

unsigned int vtkHyperTreeGrid::GetNumberOfLevels ( vtkIdType  )

Return the number of levels in an individual (primal) tree.

◆ GetNumberOfLevels() [2/2]

unsigned int vtkHyperTreeGrid::GetNumberOfLevels ( )

Return the number of levels in the hyper tree grid.

◆ SetXCoordinates()

virtual void vtkHyperTreeGrid::SetXCoordinates ( vtkDataArray )
virtual

Set/Get the grid coordinates in the x-direction.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetXCoordinates()

virtual vtkDataArray * vtkHyperTreeGrid::GetXCoordinates ( )
virtual

Set/Get the grid coordinates in the x-direction.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SetYCoordinates()

virtual void vtkHyperTreeGrid::SetYCoordinates ( vtkDataArray )
virtual

Set/Get the grid coordinates in the y-direction.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetYCoordinates()

virtual vtkDataArray * vtkHyperTreeGrid::GetYCoordinates ( )
virtual

Set/Get the grid coordinates in the y-direction.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SetZCoordinates()

virtual void vtkHyperTreeGrid::SetZCoordinates ( vtkDataArray )
virtual

Set/Get the grid coordinates in the z-direction.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetZCoordinates()

virtual vtkDataArray * vtkHyperTreeGrid::GetZCoordinates ( )
virtual

Set/Get the grid coordinates in the z-direction.

Reimplemented in vtkUniformHyperTreeGrid.

◆ CopyCoordinates()

virtual void vtkHyperTreeGrid::CopyCoordinates ( const vtkHyperTreeGrid output)
virtual

Augented services on Coordinates.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SetFixedCoordinates()

virtual void vtkHyperTreeGrid::SetFixedCoordinates ( unsigned int  axis,
double  value 
)
virtual

Augented services on Coordinates.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SetMask()

void vtkHyperTreeGrid::SetMask ( vtkBitArray )

Set/Get the blanking mask of primal leaf cells.

◆ GetMask()

virtual vtkBitArray * vtkHyperTreeGrid::GetMask ( )
virtual

Set/Get the blanking mask of primal leaf cells.

◆ HasMask()

bool vtkHyperTreeGrid::HasMask ( )

Determine whether blanking mask is empty or not.

◆ SetHasInterface()

virtual void vtkHyperTreeGrid::SetHasInterface ( bool  )
virtual

Set/Get presence or absence of interface.

◆ GetHasInterface()

virtual bool vtkHyperTreeGrid::GetHasInterface ( )
virtual

Set/Get presence or absence of interface.

◆ HasInterfaceOn()

virtual void vtkHyperTreeGrid::HasInterfaceOn ( )
virtual

Set/Get presence or absence of interface.

◆ HasInterfaceOff()

virtual void vtkHyperTreeGrid::HasInterfaceOff ( )
virtual

Set/Get presence or absence of interface.

◆ SetInterfaceNormalsName()

virtual void vtkHyperTreeGrid::SetInterfaceNormalsName ( const char *  )
virtual

Set/Get names of interface normal vectors arrays.

◆ GetInterfaceNormalsName()

virtual char * vtkHyperTreeGrid::GetInterfaceNormalsName ( )
virtual

Set/Get names of interface normal vectors arrays.

◆ SetInterfaceInterceptsName()

virtual void vtkHyperTreeGrid::SetInterfaceInterceptsName ( const char *  )
virtual

Set/Get names of interface intercepts arrays.

◆ GetInterfaceInterceptsName()

virtual char * vtkHyperTreeGrid::GetInterfaceInterceptsName ( )
virtual

Set/Get names of interface intercepts arrays.

◆ SetDepthLimiter()

virtual void vtkHyperTreeGrid::SetDepthLimiter ( unsigned int  )
virtual

Set/Get depth limiter value.

◆ GetDepthLimiter()

virtual unsigned int vtkHyperTreeGrid::GetDepthLimiter ( )
virtual

Set/Get depth limiter value.

◆ InitializeOrientedCursor()

void vtkHyperTreeGrid::InitializeOrientedCursor ( vtkHyperTreeGridOrientedCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewOrientedCursor()

vtkHyperTreeGridOrientedCursor * vtkHyperTreeGrid::NewOrientedCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeOrientedGeometryCursor()

void vtkHyperTreeGrid::InitializeOrientedGeometryCursor ( vtkHyperTreeGridOrientedGeometryCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewOrientedGeometryCursor()

vtkHyperTreeGridOrientedGeometryCursor * vtkHyperTreeGrid::NewOrientedGeometryCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedCursor()

void vtkHyperTreeGrid::InitializeNonOrientedCursor ( vtkHyperTreeGridNonOrientedCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedCursor()

vtkHyperTreeGridNonOrientedCursor * vtkHyperTreeGrid::NewNonOrientedCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedGeometryCursor()

void vtkHyperTreeGrid::InitializeNonOrientedGeometryCursor ( vtkHyperTreeGridNonOrientedGeometryCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedGeometryCursor()

vtkHyperTreeGridNonOrientedGeometryCursor * vtkHyperTreeGrid::NewNonOrientedGeometryCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedUnlimitedGeometryCursor()

void vtkHyperTreeGrid::InitializeNonOrientedUnlimitedGeometryCursor ( vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedUnlimitedGeometryCursor()

vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor * vtkHyperTreeGrid::NewNonOrientedUnlimitedGeometryCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ FindNonOrientedGeometryCursor()

vtkHyperTreeGridNonOrientedGeometryCursor * vtkHyperTreeGrid::FindNonOrientedGeometryCursor ( double  x[3])

Return a geometric cursor pointing to one of the nodes at position x

◆ FindDichotomicX()

virtual unsigned int vtkHyperTreeGrid::FindDichotomicX ( double  value,
double  tol = 0.0 
) const
virtual

Reimplemented in vtkUniformHyperTreeGrid.

◆ FindDichotomicY()

virtual unsigned int vtkHyperTreeGrid::FindDichotomicY ( double  value,
double  tol = 0.0 
) const
virtual

Reimplemented in vtkUniformHyperTreeGrid.

◆ FindDichotomicZ()

virtual unsigned int vtkHyperTreeGrid::FindDichotomicZ ( double  value,
double  tol = 0.0 
) const
virtual

Reimplemented in vtkUniformHyperTreeGrid.

◆ InitializeNonOrientedVonNeumannSuperCursor()

void vtkHyperTreeGrid::InitializeNonOrientedVonNeumannSuperCursor ( vtkHyperTreeGridNonOrientedVonNeumannSuperCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedVonNeumannSuperCursor()

vtkHyperTreeGridNonOrientedVonNeumannSuperCursor * vtkHyperTreeGrid::NewNonOrientedVonNeumannSuperCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedVonNeumannSuperCursorLight()

void vtkHyperTreeGrid::InitializeNonOrientedVonNeumannSuperCursorLight ( vtkHyperTreeGridNonOrientedVonNeumannSuperCursorLight cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedVonNeumannSuperCursorLight()

vtkHyperTreeGridNonOrientedVonNeumannSuperCursorLight * vtkHyperTreeGrid::NewNonOrientedVonNeumannSuperCursorLight ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedMooreSuperCursor()

void vtkHyperTreeGrid::InitializeNonOrientedMooreSuperCursor ( vtkHyperTreeGridNonOrientedMooreSuperCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedMooreSuperCursor()

vtkHyperTreeGridNonOrientedMooreSuperCursor * vtkHyperTreeGrid::NewNonOrientedMooreSuperCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedMooreSuperCursorLight()

void vtkHyperTreeGrid::InitializeNonOrientedMooreSuperCursorLight ( vtkHyperTreeGridNonOrientedMooreSuperCursorLight cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedMooreSuperCursorLight()

vtkHyperTreeGridNonOrientedMooreSuperCursorLight * vtkHyperTreeGrid::NewNonOrientedMooreSuperCursorLight ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ InitializeNonOrientedUnlimitedMooreSuperCursor()

void vtkHyperTreeGrid::InitializeNonOrientedUnlimitedMooreSuperCursor ( vtkHyperTreeGridNonOrientedUnlimitedMooreSuperCursor cursor,
vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ NewNonOrientedUnlimitedMooreSuperCursor()

vtkHyperTreeGridNonOrientedUnlimitedMooreSuperCursor * vtkHyperTreeGrid::NewNonOrientedUnlimitedMooreSuperCursor ( vtkIdType  index,
bool  create = false 
)

Used to initialize a cursor of the given type.

cursor: the cursor to initialize

index: the index of the tree to use in the HTG

create: allow to construct the hyper tree if the slot is empty

◆ Initialize()

void vtkHyperTreeGrid::Initialize ( )
overridevirtual

Restore data object to initial state.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetTree()

virtual vtkHyperTree * vtkHyperTreeGrid::GetTree ( vtkIdType  ,
bool  create = false 
)
virtual

Return tree located at given index of hyper tree grid NB: This will construct a new HyperTree if grid slot is empty.

Reimplemented in vtkUniformHyperTreeGrid.

◆ SetTree()

void vtkHyperTreeGrid::SetTree ( vtkIdType  ,
vtkHyperTree  
)

Assign given tree to given index of hyper tree grid NB: This will create a new slot in the grid if needed.

◆ ShallowCopy()

void vtkHyperTreeGrid::ShallowCopy ( vtkDataObject )
overridevirtual

Create shallow copy of hyper tree grid.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

◆ DeepCopy()

void vtkHyperTreeGrid::DeepCopy ( vtkDataObject )
overridevirtual

Create deep copy of hyper tree grid.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetExtentType()

int vtkHyperTreeGrid::GetExtentType ( )
inlineoverridevirtual

Structured extent.

The extent type is a 3D extent.

Reimplemented from vtkDataObject.

Definition at line 496 of file vtkHyperTreeGrid.h.

◆ GetActualMemorySizeBytes()

virtual unsigned long vtkHyperTreeGrid::GetActualMemorySizeBytes ( )
virtual

Return the actual size of the data in bytes.

This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetActualMemorySize()

unsigned long vtkHyperTreeGrid::GetActualMemorySize ( )
overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkDataObject.

◆ SupportsGhostArray()

bool vtkHyperTreeGrid::SupportsGhostArray ( int  type)
overridevirtual

Returns true if type is CELL, false otherwise.

Reimplemented from vtkDataObject.

◆ GetPureMask()

vtkBitArray * vtkHyperTreeGrid::GetPureMask ( )

Get or create pure material mask.

PureMask is a boolean array size to the number of cells which describes, for each cell, if it is pure material mask (PMM), a mask which is true if the cell is not pure. The PMM of a cell is true:

  • if the cell is hidden; we do not take into account if the cell is leaf or coarse;
  • if the fine/leaf cell is mixed (HasInterface is true, InterfaceInterceptsName and InterfaceNormalsName are the vector value field names with 3 components); the description of its type at the interface (the third component of the field named InterfaceInterceptsName) is < 2 (2 indicates that this cell contains only one material, cell is pure);
  • if the coarse cell has at least one of its child cells which has set PMM to true.

The PureMask array is deleted during a call to the SetMask method (which itself calls the CleanPureMask method). It will be (re)built during the first call to this GetPureMask method. A second call to this same method will be free because this array is stored permanently in memory, as long as the CleanPureMask method is not called.

◆ GetChildMask()

unsigned int vtkHyperTreeGrid::GetChildMask ( unsigned int  )

Return hard-coded bitcode correspondng to child mask Dimension 1: Factor 2: 0: 100, 1: 001 Factor 3: 0: 100, 1: 010, 2: 001 Dimension 2: Factor 2: 0: 1101 0000 0, 1: 0110 0100 0 2: 0001 0011 0, 3: 0000 0101 1 Factor 3: 0: 1101 0000 0, 1: 0100 0000 0, 2: 0110 0100 0 3: 0001 0000 0, 4: 0000 1000 0, 5: 0000 0100 0 6: 0001 0011 0, 7: 0000 0001 0, 8: 0000 0101 1 Dimension 3: Factor 2: 0: 1101 1000 0110 1000 0000 0000 000, 1: 0110 1100 0011 0010 0000 0000 000 2: 0001 1011 0000 1001 1000 0000 000, 3: 0000 1101 1000 0010 1100 0000 000 4: 0000 0000 0110 1000 0011 0110 000, 5: 0000 0000 0011 0010 0001 1011 000 6: 0000 0000 0000 1001 1000 0110 110, 7: 0000 0000 0000 0010 1100 0011 011 Factor 3: 0: 1101 1000 0110 1000 0000 0000 000 1: 0100 1000 0010 0000 0000 0000 000 2: 0110 1100 0011 0010 0000 0000 000 3: 0001 1000 0000 1000 0000 0000 000 4: 0000 1000 0000 0000 0000 0000 000 5: 0000 1100 0000 0010 0000 0000 000 6: 0001 1011 0000 1001 1000 0000 000 7: 0000 1001 0000 0000 1000 0000 000 8: 0000 1101 1000 0010 1100 0000 000 9: 0000 0000 0110 1000 0000 0000 000 10: 0000 0000 0010 0000 0000 0000 000 11: 0000 0000 0011 0010 0000 0000 000 12: 0000 0000 0000 1000 0000 0000 000 13: 0000 0000 0000 0100 0000 0000 000 14: 0000 0000 0000 0010 0000 0000 000 15: 0000 0000 0000 1001 1000 0000 000 16: 0000 0000 0000 0000 1000 0000 000 17: 0000 0000 0000 0010 1100 0000 000 18: 0000 0000 0110 1000 0011 0110 000 19: 0000 0000 0010 0000 0001 0010 000 20: 0000 0000 0011 0010 0001 1011 000 21: 0000 0000 0000 1000 0000 0110 000 22: 0000 0000 0000 0000 0000 0010 000 23: 0000 0000 0000 0010 0000 0011 000 24: 0000 0000 0000 1001 1000 0110 110 25: 0000 0000 0000 0000 1000 0010 010 26: 0000 0000 0000 0010 1100 0011 011.

◆ GetIndexFromLevelZeroCoordinates()

void vtkHyperTreeGrid::GetIndexFromLevelZeroCoordinates ( vtkIdType ,
unsigned int  ,
unsigned int  ,
unsigned int   
) const

Convert the Cartesian coordinates of a root in the grid to its global index.

◆ GetShiftedLevelZeroIndex()

vtkIdType vtkHyperTreeGrid::GetShiftedLevelZeroIndex ( vtkIdType  ,
int  ,
int  ,
int   
) const

Return the root index of a root cell with given index displaced.

by a cartesian vector in the grid (di,dj,dk).

However, in HTG 2D, this method used Orientation information. According to the orientation values (0/1/2), the association of the topological axes changes with the real axes (YZ/XZ/XY).

NB: No boundary checks are performed.

◆ GetLevelZeroCoordinatesFromIndex()

void vtkHyperTreeGrid::GetLevelZeroCoordinatesFromIndex ( vtkIdType  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &   
) const

Convert the global index of a root to its Cartesian coordinates in the grid.

◆ GetLevelZeroOriginAndSizeFromIndex()

virtual void vtkHyperTreeGrid::GetLevelZeroOriginAndSizeFromIndex ( vtkIdType  ,
double *  ,
double *   
)
virtual

Convert the global index of a root to its Spatial coordinates origin and size.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetLevelZeroOriginFromIndex()

virtual void vtkHyperTreeGrid::GetLevelZeroOriginFromIndex ( vtkIdType  ,
double *   
)
virtual

Convert the global index of a root to its Spatial coordinates origin and size.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetGlobalNodeIndexMax()

vtkIdType vtkHyperTreeGrid::GetGlobalNodeIndexMax ( )

Return the maximum global index value.

Can be useful to allocate new cell arrays.

◆ InitializeLocalIndexNode()

void vtkHyperTreeGrid::InitializeLocalIndexNode ( )

Initialize local indexes for every individual Hyper Tree after they have been refined.

◆ HasAnyGhostCells()

bool vtkHyperTreeGrid::HasAnyGhostCells ( ) const

Returns true if a ghost cell array is defined.

◆ GetGhostCells()

vtkUnsignedCharArray * vtkHyperTreeGrid::GetGhostCells ( )

Gets the array that defines the ghost type of each cell.

see also GetTreeGhostArray().

◆ GetTreeGhostArray()

vtkUnsignedCharArray * vtkHyperTreeGrid::GetTreeGhostArray ( )

Gets the array that defines the ghost type of each cell.

Unlike GetGhostCells(), we cache the pointer to the array to save a lookup involving string comparisons

◆ AllocateTreeGhostArray()

vtkUnsignedCharArray * vtkHyperTreeGrid::AllocateTreeGhostArray ( )

Allocate ghost array for points.

◆ InitializeTreeIterator()

void vtkHyperTreeGrid::InitializeTreeIterator ( vtkHyperTreeGridIterator )

Initialize an iterator to browse level 0 trees.

FIXME: this method is completely unnecessary.

◆ GetData() [1/2]

static vtkHyperTreeGrid * vtkHyperTreeGrid::GetData ( vtkInformation info)
static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkHyperTreeGrid * vtkHyperTreeGrid::GetData ( vtkInformationVector v,
int  i = 0 
)
static

Retrieve an instance of this class from an information object.

◆ ComputeBounds()

virtual void vtkHyperTreeGrid::ComputeBounds ( )
virtual

Compute the hyper tree grid bounding box ignoring masked cells.

THIS METHOD IS NOT THREAD SAFE.

◆ GetBounds() [1/2]

virtual double * vtkHyperTreeGrid::GetBounds ( )
virtual

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

This method was incorrectly providing grid bounds before vtk 9.4, grid bounds are available in GetGridBounds() if needed. THIS METHOD IS NOT THREAD SAFE.

◆ GetBounds() [2/2]

void vtkHyperTreeGrid::GetBounds ( double  bounds[6])

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

This method was incorrectly providing grid bounds before vtk 9.4, grid bounds are available in GetGridBounds() if needed. THIS METHOD IS NOT THREAD SAFE.

◆ GetGridBounds()

virtual void vtkHyperTreeGrid::GetGridBounds ( double  bounds[6])
virtual

Return a pointer to the grid bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

THIS METHOD IS NOT THREAD SAFE.

Reimplemented in vtkUniformHyperTreeGrid.

◆ GetCenter() [1/2]

double * vtkHyperTreeGrid::GetCenter ( )

Get the center of the bounding box.

THIS METHOD IS NOT THREAD SAFE.

◆ GetCenter() [2/2]

void vtkHyperTreeGrid::GetCenter ( double  center[3])

Get the center of the bounding box.

THIS METHOD IS NOT THREAD SAFE.

◆ GetCellData()

vtkCellData * vtkHyperTreeGrid::GetCellData ( )

Return a pointer to this dataset's hypertree node data.

THIS METHOD IS THREAD SAFE

◆ GetAttributesAsFieldData()

vtkFieldData * vtkHyperTreeGrid::GetAttributesAsFieldData ( int  type)
overridevirtual

Returns the hypertree node field data stored as cell data.

If type != vtkDataObject::AttributeTypes::CELL, it defers to vtkDataObject;

Reimplemented from vtkDataObject.

◆ GetNumberOfElements()

vtkIdType vtkHyperTreeGrid::GetNumberOfElements ( int  type)
overridevirtual

Returns the number of nodes.

Ii type == vtkDataObject::AttributeTypes::CELL, it defers to vtkDataObject.

Reimplemented from vtkDataObject.

◆ GetNumberOfCells()

vtkIdType vtkHyperTreeGrid::GetNumberOfCells ( )

Return the number of cells.

It matches the total number of internal nodes and leaves of the underlying hypertrees.

Member Data Documentation

◆ InvalidIndex

constexpr vtkIdType vtkHyperTreeGrid::InvalidIndex = ~0
staticconstexpr

Invalid index that is returned for undefined nodes, for example for nodes that are out of bounds (they can exist with the super cursors).

Definition at line 104 of file vtkHyperTreeGrid.h.

◆ ModeSqueeze

char* vtkHyperTreeGrid::ModeSqueeze
protected

ModeSqueeze.

Definition at line 802 of file vtkHyperTreeGrid.h.

◆ Bounds

double vtkHyperTreeGrid::Bounds[6]
protected

Definition at line 804 of file vtkHyperTreeGrid.h.

◆ Center

double vtkHyperTreeGrid::Center[3]
protected

Definition at line 805 of file vtkHyperTreeGrid.h.

◆ FreezeState

bool vtkHyperTreeGrid::FreezeState
protected

Definition at line 807 of file vtkHyperTreeGrid.h.

◆ BranchFactor

unsigned int vtkHyperTreeGrid::BranchFactor
protected

Definition at line 808 of file vtkHyperTreeGrid.h.

◆ Dimension

unsigned int vtkHyperTreeGrid::Dimension
protected

Definition at line 809 of file vtkHyperTreeGrid.h.

◆ TreeGhostArray

vtkUnsignedCharArray* vtkHyperTreeGrid::TreeGhostArray
protected

These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))

Definition at line 816 of file vtkHyperTreeGrid.h.

◆ TreeGhostArrayCached

bool vtkHyperTreeGrid::TreeGhostArrayCached
protected

These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))

Definition at line 817 of file vtkHyperTreeGrid.h.

◆ NumberOfChildren

unsigned int vtkHyperTreeGrid::NumberOfChildren
protected

Definition at line 826 of file vtkHyperTreeGrid.h.

◆ TransposedRootIndexing

bool vtkHyperTreeGrid::TransposedRootIndexing
protected

Definition at line 827 of file vtkHyperTreeGrid.h.

◆ DataDescription

int vtkHyperTreeGrid::DataDescription
protected

Definition at line 836 of file vtkHyperTreeGrid.h.

◆ Extent

int vtkHyperTreeGrid::Extent[6]
protected

Definition at line 837 of file vtkHyperTreeGrid.h.

◆ WithCoordinates

bool vtkHyperTreeGrid::WithCoordinates
protected

Definition at line 839 of file vtkHyperTreeGrid.h.

◆ XCoordinates

vtkDataArray* vtkHyperTreeGrid::XCoordinates
protected

Definition at line 840 of file vtkHyperTreeGrid.h.

◆ YCoordinates

vtkDataArray* vtkHyperTreeGrid::YCoordinates
protected

Definition at line 841 of file vtkHyperTreeGrid.h.

◆ ZCoordinates

vtkDataArray* vtkHyperTreeGrid::ZCoordinates
protected

Definition at line 842 of file vtkHyperTreeGrid.h.

◆ Mask

vtkBitArray* vtkHyperTreeGrid::Mask
protected

Definition at line 845 of file vtkHyperTreeGrid.h.

◆ PureMask

vtkBitArray* vtkHyperTreeGrid::PureMask
protected

Definition at line 846 of file vtkHyperTreeGrid.h.

◆ HasInterface

bool vtkHyperTreeGrid::HasInterface
protected

Definition at line 848 of file vtkHyperTreeGrid.h.

◆ InterfaceNormalsName

char* vtkHyperTreeGrid::InterfaceNormalsName
protected

Definition at line 849 of file vtkHyperTreeGrid.h.

◆ InterfaceInterceptsName

char* vtkHyperTreeGrid::InterfaceInterceptsName
protected

Definition at line 850 of file vtkHyperTreeGrid.h.

◆ HyperTrees

std::map<vtkIdType, vtkSmartPointer<vtkHyperTree> > vtkHyperTreeGrid::HyperTrees
protected

Definition at line 852 of file vtkHyperTreeGrid.h.

◆ CellData

vtkNew<vtkCellData> vtkHyperTreeGrid::CellData
protected

Definition at line 854 of file vtkHyperTreeGrid.h.

◆ DepthLimiter

unsigned int vtkHyperTreeGrid::DepthLimiter
protected

Definition at line 856 of file vtkHyperTreeGrid.h.


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