VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | 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...
 
struct  vtkHyperTreeGridSuperCursor
 Public structure used by filters to move around the hyper tree grid and easily access neighbors to leaves. More...
 
class  vtkHyperTreeSimpleCursor
 A simplified hyper tree cursor, to be used by the hyper tree. More...
 

Public Types

typedef vtkDataSet Superclass
 
- Public Types inherited from vtkDataSet
enum  FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }
 
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. More...
 
vtkHyperTreeGridNewInstance () const
 
void PrintSelf (ostream &, vtkIndent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetDataObjectType () override
 Return what type of dataset this is. More...
 
void CopyStructure (vtkDataSet *) override
 Copy the internal geometric and topological structure of a vtkHyperTreeGrid object. More...
 
void SetGridSize (unsigned int[3])
 Set/Get the number of local cells in each direction for the underlying rectilinear grid dataset. More...
 
void SetGridSize (unsigned int, unsigned int, unsigned int)
 
virtual unsigned intGetGridSize ()
 
virtual void GetGridSize (unsigned int &, unsigned int &, unsigned int &)
 
virtual void GetGridSize (unsigned int[3])
 
void SetGridExtent (int extent[6])
 Set/Get extent of the underlying rectilinear grid dataset. More...
 
void SetGridExtent (int, int, int, int, int, int)
 
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. More...
 
virtual bool GetTransposedRootIndexing ()
 
void SetIndexingModeToKJI ()
 
void SetIndexingModeToIJK ()
 
void SetDimension (unsigned int)
 Set/Get the dimensionality of the grid. More...
 
virtual unsigned int GetDimension ()
 
virtual void SetOrientation (unsigned int)
 Set/Get the orientation of 1D or 2D grids: More...
 
virtual unsigned int GetOrientation ()
 
void SetBranchFactor (unsigned int)
 Set/Get the subdivision factor in the grid refinement scheme. More...
 
virtual unsigned int GetBranchFactor ()
 
vtkIdType GetNumberOfTrees ()
 Return the number of trees in the level 0 grid. More...
 
vtkIdType GetNumberOfVertices ()
 Get the number of vertices in the primal tree grid. More...
 
vtkIdType GetNumberOfLeaves ()
 Get the number of leaves in the primal tree grid. More...
 
vtkIdType GetNumberOfCells () override
 Return the number of cells in the dual grid. More...
 
vtkIdType GetNumberOfPoints () override
 Return the number of points in the dual grid. More...
 
vtkIdType GetNumberOfLevels (vtkIdType)
 Return the number of levels in an individual (primal) tree. More...
 
vtkIdType GetNumberOfLevels ()
 Return the number of levels in the hyper tree grid. More...
 
void SetXCoordinates (vtkDataArray *)
 Set/Get the grid coordinates in the x-direction. More...
 
virtual vtkDataArrayGetXCoordinates ()
 
void SetYCoordinates (vtkDataArray *)
 Set/Get the grid coordinates in the y-direction. More...
 
virtual vtkDataArrayGetYCoordinates ()
 
void SetZCoordinates (vtkDataArray *)
 Set/Get the grid coordinates in the z-direction. More...
 
virtual vtkDataArrayGetZCoordinates ()
 
void SetMaterialMask (vtkBitArray *)
 Set/Get the blanking mask of primal leaf cells. More...
 
virtual vtkBitArrayGetMaterialMask ()
 
bool HasMaterialMask ()
 Determine whether blanking mask is empty or not. More...
 
virtual void SetMaterialMaskIndex (vtkIdTypeArray *)
 Set/Get the visibility mask of primal leaf cells. More...
 
virtual vtkIdTypeArrayGetMaterialMaskIndex ()
 
virtual void SetHasInterface (bool)
 Set/Get presence or absence of interface. More...
 
virtual bool GetHasInterface ()
 
virtual void HasInterfaceOn ()
 
virtual void HasInterfaceOff ()
 
virtual void SetInterfaceNormalsName (const char *)
 Set/Get names of interface normal vectors arrays. More...
 
virtual char * GetInterfaceNormalsName ()
 
virtual void SetInterfaceInterceptsName (const char *)
 Set/Get names of interface intercepts arrays. More...
 
virtual char * GetInterfaceInterceptsName ()
 
virtual void GenerateTrees ()
 This method must be called once the tree settings change. More...
 
vtkHyperTreeCursorNewCursor (vtkIdType, bool create=false)
 Create a new hyper tree cursor: an object that can traverse the cells of an individual hyper tree at given index. More...
 
vtkHyperTreeGridCursorNewGridCursor (vtkIdType, bool create=false)
 Create a new hyper tree grid cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index. More...
 
vtkHyperTreeGridCursorNewGeometricCursor (vtkIdType, bool create=false)
 Create a new hyper tree grid geometric cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index, managing the geometric properties. More...
 
vtkHyperTreeGridCursorNewVonNeumannSuperCursor (vtkIdType, bool create=false)
 Create a new hyper tree grid Von Neumann super cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index, managing geometric properties and von Neumann neighborhood with basic hyper tree grid cursors. More...
 
vtkHyperTreeGridCursorNewMooreSuperCursor (vtkIdType, bool create=false)
 Create a new hyper tree grid Moore super cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index, managing geometric properties and Moore neighborhood with basic hyper tree grid cursors. More...
 
void SubdivideLeaf (vtkHyperTreeCursor *, vtkIdType)
 Subdivide node pointed by cursor, only if its a leaf. More...
 
doubleGetPoint (vtkIdType) override
 This method should be avoided in favor of cell/point iterators. More...
 
void GetPoint (vtkIdType, double[3]) override
 This method should be avoided in favor of cell/point iterators. More...
 
vtkCellGetCell (vtkIdType) override
 This method should be avoided in favor of cell/point iterators. More...
 
vtkCellGetCell (int i, int j, int k) override
 Overridden so as no not unintentionally hide parent class. More...
 
void GetCell (vtkIdType, vtkGenericCell *) override
 This method should be avoided in favor of cell/point iterators. More...
 
int GetCellType (vtkIdType) override
 All cell types are 2: quadrilaters,3d: hexahedrons. More...
 
void GetCellPoints (vtkIdType, vtkIdList *) override
 This method should be avoided in favor of cell/point iterators. More...
 
void GetCellPoints (vtkIdType, vtkIdType &, vtkIdType *&)
 Return a pointer to a list of point ids defining cell. More...
 
void GetPointCells (vtkIdType, vtkIdList *) override
 This method should be avoided in favor of cell/point iterators. More...
 
void GetCellNeighbors (vtkIdType, vtkIdList *, vtkIdList *) override
 This method should be avoided in favor of cell/point iterators. More...
 
vtkIdType FindPoint (double x[3]) override
 Find cell to which this point belongs, or at least closest one, even if the point is outside the grid. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Locate cell based on global coordinate x and tolerance squared. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 This is a version of the above method that can be used with multithreaded applications. More...
 
void Initialize () override
 Restore data object to initial state. More...
 
vtkHyperTreeGetTree (vtkIdType)
 Return tree located at given index of hyper tree grid NB: This will return nullptr if grid slot is empty. More...
 
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. More...
 
void InitializeTreeIterator (vtkHyperTreeGridIterator &)
 Initialize an iterator to browse level 0 trees. More...
 
int GetMaxCellSize () override
 Convenience method to return largest cell size in dataset. More...
 
void ShallowCopy (vtkDataObject *) override
 Create shallow copy of hyper tree grid. More...
 
void DeepCopy (vtkDataObject *) override
 Create deep copy of hyper tree grid. More...
 
int GetExtentType () override
 Structured extent. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
virtual unsigned int GetNumberOfChildren ()
 The number of children each node can have. More...
 
bool RecursivelyInitializePureMaterialMask (vtkHyperTreeGridCursor *cursor)
 Recursively initialize pure material mask. More...
 
vtkBitArrayGetPureMaterialMask ()
 Get or create pure material mask. More...
 
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. More...
 
void GetLevelZeroCoordinatesFromIndex (vtkIdType, unsigned int &, unsigned int &, unsigned int &)
 Convert the global index of a root to its Cartesian coordinates in the grid. More...
 
void GetIndexFromLevelZeroCoordinates (vtkIdType &, unsigned int, unsigned int, unsigned int)
 Convert the Cartesian coordinates of a root in the grid to its global index. More...
 
unsigned int GetShiftedLevelZeroIndex (vtkIdType, int, int, int)
 Return the root index of a root cell with given index displaced. More...
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...
 
virtual vtkCellIteratorNewCellIterator ()
 Return an iterator that traverses the cells in this data set. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset. More...
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x. More...
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 Locate the cell that contains a point and return the cell. More...
 
vtkMTimeType GetMTime () override
 Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. More...
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data. More...
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data. More...
 
virtual void Squeeze ()
 Reclaim any extra memory used to store data. More...
 
doubleGetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
doubleGetCenter ()
 Get the center of the bounding box. More...
 
void GetCenter (double center[3])
 Get the center of the bounding box. More...
 
double GetLength ()
 Return the length of the diagonal of the bounding box. More...
 
virtual void GetScalarRange (double range[2])
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
doubleGetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. More...
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only. More...
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise. More...
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise. More...
 
virtual bool HasAnyBlankCells ()
 Returns 1 if there are any blanking cells 0 otherwise. More...
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise. More...
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point. More...
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array. More...
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points. More...
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell. More...
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array. More...
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted. More...
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static 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. More...
 
static vtkHyperTreeGridGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 
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) More...
 
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. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
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). More...
 
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). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
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 vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkHyperTreeGrid ()
 Constructor with default bounds (0,1, 0,1, 0,1). More...
 
 ~vtkHyperTreeGrid () override
 Destructor. More...
 
void ComputeBounds () override
 Compute the data bounding box from data points. More...
 
void ComputeDualGrid ()
 Traverse tree with 3x3x3 super cursor. More...
 
vtkPointsGetPoints ()
 
vtkIdTypeArrayGetConnectivity ()
 
void DeepCopyCursors (vtkHyperTreeCursor *, vtkHyperTreeCursor *)
 Perform left to right deep copy of hyper tree cursors. More...
 
void DeleteTrees ()
 Remove existing trees. More...
 
void ResetDual ()
 Reset dual mesh. More...
 
void ResetSuperCursor ()
 A convenience method to reset all cursors in a super cursor, either Von Neumann or Moore. More...
 
void TraverseDualRecursively (vtkHyperTreeGridCursor *)
 Recursively descend into tree down to leaves to generate dual. More...
 
void TraverseDualRecursively (vtkHyperTreeGridCursor *, vtkBitArray *)
 Recursively descend into tree down to leaves to generate dual, when a mask array is present. More...
 
void GenerateDualCornerFromLeaf1D (vtkHyperTreeGridCursor *)
 Process leaf cell and issue corresponding dual corner point in 1D. More...
 
void GenerateDualCornerFromLeaf1D (vtkHyperTreeGridCursor *, vtkBitArray *)
 Process leaf cell and issue corresponding dual corner point in 1D, when a mask array is present. More...
 
void GenerateDualCornerFromLeaf2D (vtkHyperTreeGridCursor *)
 Process leaf cell and issue corresponding dual corner point in 2D. More...
 
void GenerateDualCornerFromLeaf2D (vtkHyperTreeGridCursor *, vtkBitArray *)
 Process leaf cell and issue corresponding dual corner point in 2D, when a mask array is present. More...
 
void GenerateDualCornerFromLeaf3D (vtkHyperTreeGridCursor *)
 Process leaf cell and issue corresponding dual corner point in 3D. More...
 
void GenerateDualCornerFromLeaf3D (vtkHyperTreeGridCursor *, vtkBitArray *)
 Process leaf cell and issue corresponding dual corner point in 3D, when a mask array is present. More...
 
void ShiftDualCornerFromMaskedLeaf2D (vtkHyperTreeGridCursor *, vtkBitArray *)
 Compute appropriate shifts for dual corners of masked cells in 2D. More...
 
void ShiftDualCornerFromMaskedLeaf3D (vtkHyperTreeGridCursor *, vtkBitArray *)
 Compute appropriate shifts for dual corners of masked cells in 3D. More...
 
vtkIdType RecursivelyFindPoint (double x[3], vtkHyperTreeGridCursor *, double *, double *)
 Recursive method called under the hood by FindPoint(). More...
 
void EvaluateDualCorner (vtkHyperTreeSimpleCursor *)
 
void BuildLinks ()
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet () override
 
virtual void ComputeScalarRange ()
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set. More...
 
- Protected Member Functions inherited from vtkDataObject
 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

unsigned int BranchFactor
 
unsigned int Dimension
 
unsigned int Orientation
 
unsigned int GridSize [3]
 
int Extent [6]
 
unsigned int NumberOfChildren
 
bool TransposedRootIndexing
 
vtkBitArrayMaterialMask
 
vtkBitArrayPureMaterialMask
 
vtkIdTypeArrayMaterialMaskIndex
 
bool InitPureMaterialMask
 
bool HasInterface
 
char * InterfaceNormalsName
 
char * InterfaceInterceptsName
 
vtkDataArrayXCoordinates
 
vtkDataArrayYCoordinates
 
vtkDataArrayZCoordinates
 
std::map< vtkIdType, vtkHyperTree * > HyperTrees
 
vtkPointsPoints
 
vtkIdTypeArrayConnectivity
 
std::map< vtkIdType, bool > PointShifted
 
std::map< vtkIdType, doublePointShifts [3]
 
std::map< vtkIdType, doubleReductionFactors
 
vtkLineLine
 These are needed by the GetCell() method. More...
 
vtkPixelPixel
 
vtkVoxelVoxel
 
vtkCellLinksLinks
 Not really needed. More...
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
vtkUnsignedCharArrayCellGhostArray
 
bool PointGhostArrayCached
 
bool CellGhostArrayCached
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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

A hypertree grid is a dataset containing a rectilinear grid of root nodes, each of which can be refined as a vtkHyperTree grid. Each root node corresponds to a cell of the rectilinear 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.

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 work was supported by Commissariat a l'Energie Atomique (CEA/DIF)
Tests:
vtkHyperTreeGrid (Tests)

Definition at line 70 of file vtkHyperTreeGrid.h.

Member Typedef Documentation

◆ Superclass

Definition at line 84 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 vtkDataSet.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkHyperTreeGrid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSet.

◆ 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 vtkDataSet.

◆ GetDataObjectType()

int vtkHyperTreeGrid::GetDataObjectType ( )
overridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

◆ CopyStructure()

void vtkHyperTreeGrid::CopyStructure ( vtkDataSet )
overridevirtual

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

Implements vtkDataSet.

◆ SetGridSize() [1/2]

void vtkHyperTreeGrid::SetGridSize ( unsigned int  [3])

Set/Get the number of local cells in each direction for the underlying rectilinear grid dataset.

◆ SetGridSize() [2/2]

void vtkHyperTreeGrid::SetGridSize ( unsigned int  ,
unsigned int  ,
unsigned int   
)

◆ GetGridSize() [1/3]

virtual unsigned int* vtkHyperTreeGrid::GetGridSize ( )
virtual

◆ GetGridSize() [2/3]

virtual void vtkHyperTreeGrid::GetGridSize ( unsigned int ,
unsigned int ,
unsigned int  
)
virtual

◆ GetGridSize() [3/3]

virtual void vtkHyperTreeGrid::GetGridSize ( unsigned int  [3])
virtual

◆ SetGridExtent() [1/2]

void vtkHyperTreeGrid::SetGridExtent ( int  extent[6])

Set/Get extent of the underlying rectilinear grid dataset.

This is the local extent and is with respect to the points.

◆ SetGridExtent() [2/2]

void vtkHyperTreeGrid::SetGridExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)

◆ 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

◆ SetIndexingModeToKJI()

void vtkHyperTreeGrid::SetIndexingModeToKJI ( )
inline

Definition at line 123 of file vtkHyperTreeGrid.h.

◆ SetIndexingModeToIJK()

void vtkHyperTreeGrid::SetIndexingModeToIJK ( )
inline

Definition at line 125 of file vtkHyperTreeGrid.h.

◆ SetDimension()

void vtkHyperTreeGrid::SetDimension ( unsigned int  )

Set/Get the dimensionality of the grid.

◆ GetDimension()

virtual unsigned int vtkHyperTreeGrid::GetDimension ( )
virtual

◆ SetOrientation()

virtual void vtkHyperTreeGrid::SetOrientation ( unsigned int  )
virtual

Set/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

◆ GetOrientation()

virtual unsigned int vtkHyperTreeGrid::GetOrientation ( )
virtual

◆ SetBranchFactor()

void vtkHyperTreeGrid::SetBranchFactor ( unsigned int  )

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

◆ GetBranchFactor()

virtual unsigned int vtkHyperTreeGrid::GetBranchFactor ( )
virtual

◆ GetNumberOfTrees()

vtkIdType vtkHyperTreeGrid::GetNumberOfTrees ( )

Return the number of trees in the level 0 grid.

◆ GetNumberOfVertices()

vtkIdType vtkHyperTreeGrid::GetNumberOfVertices ( )

Get the number of vertices in the primal tree grid.

◆ GetNumberOfLeaves()

vtkIdType vtkHyperTreeGrid::GetNumberOfLeaves ( )

Get the number of leaves in the primal tree grid.

◆ GetNumberOfCells()

vtkIdType vtkHyperTreeGrid::GetNumberOfCells ( )
overridevirtual

Return the number of cells in the dual grid.

Implements vtkDataSet.

◆ GetNumberOfPoints()

vtkIdType vtkHyperTreeGrid::GetNumberOfPoints ( )
overridevirtual

Return the number of points in the dual grid.

Implements vtkDataSet.

◆ GetNumberOfLevels() [1/2]

vtkIdType vtkHyperTreeGrid::GetNumberOfLevels ( vtkIdType  )

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

◆ GetNumberOfLevels() [2/2]

vtkIdType vtkHyperTreeGrid::GetNumberOfLevels ( )

Return the number of levels in the hyper tree grid.

◆ SetXCoordinates()

void vtkHyperTreeGrid::SetXCoordinates ( vtkDataArray )

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

◆ GetXCoordinates()

virtual vtkDataArray* vtkHyperTreeGrid::GetXCoordinates ( )
virtual

◆ SetYCoordinates()

void vtkHyperTreeGrid::SetYCoordinates ( vtkDataArray )

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

◆ GetYCoordinates()

virtual vtkDataArray* vtkHyperTreeGrid::GetYCoordinates ( )
virtual

◆ SetZCoordinates()

void vtkHyperTreeGrid::SetZCoordinates ( vtkDataArray )

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

◆ GetZCoordinates()

virtual vtkDataArray* vtkHyperTreeGrid::GetZCoordinates ( )
virtual

◆ SetMaterialMask()

void vtkHyperTreeGrid::SetMaterialMask ( vtkBitArray )

Set/Get the blanking mask of primal leaf cells.

◆ GetMaterialMask()

virtual vtkBitArray* vtkHyperTreeGrid::GetMaterialMask ( )
virtual

◆ HasMaterialMask()

bool vtkHyperTreeGrid::HasMaterialMask ( )

Determine whether blanking mask is empty or not.

◆ SetMaterialMaskIndex()

virtual void vtkHyperTreeGrid::SetMaterialMaskIndex ( vtkIdTypeArray )
virtual

Set/Get the visibility mask of primal leaf cells.

◆ GetMaterialMaskIndex()

virtual vtkIdTypeArray* vtkHyperTreeGrid::GetMaterialMaskIndex ( )
virtual

◆ SetHasInterface()

virtual void vtkHyperTreeGrid::SetHasInterface ( bool  )
virtual

Set/Get presence or absence of interface.

◆ GetHasInterface()

virtual bool vtkHyperTreeGrid::GetHasInterface ( )
virtual

◆ HasInterfaceOn()

virtual void vtkHyperTreeGrid::HasInterfaceOn ( )
virtual

◆ HasInterfaceOff()

virtual void vtkHyperTreeGrid::HasInterfaceOff ( )
virtual

◆ SetInterfaceNormalsName()

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

Set/Get names of interface normal vectors arrays.

◆ GetInterfaceNormalsName()

virtual char* vtkHyperTreeGrid::GetInterfaceNormalsName ( )
virtual

◆ SetInterfaceInterceptsName()

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

Set/Get names of interface intercepts arrays.

◆ GetInterfaceInterceptsName()

virtual char* vtkHyperTreeGrid::GetInterfaceInterceptsName ( )
virtual

◆ GenerateTrees()

virtual void vtkHyperTreeGrid::GenerateTrees ( )
virtual

This method must be called once the tree settings change.

◆ NewCursor()

vtkHyperTreeCursor* vtkHyperTreeGrid::NewCursor ( vtkIdType  ,
bool  create = false 
)

Create a new hyper tree cursor: an object that can traverse the cells of an individual hyper tree at given index.

If no hyper tree is present at given location, then one will be created only if 'create' flag is true.

◆ NewGridCursor()

vtkHyperTreeGridCursor* vtkHyperTreeGrid::NewGridCursor ( vtkIdType  ,
bool  create = false 
)

Create a new hyper tree grid cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index.

If no hyper tree is present at given location, then one will be created only if 'create' flag is true.

◆ NewGeometricCursor()

vtkHyperTreeGridCursor* vtkHyperTreeGrid::NewGeometricCursor ( vtkIdType  ,
bool  create = false 
)

Create a new hyper tree grid geometric cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index, managing the geometric properties.

If no hyper tree is present at given location, then one will be created only if 'create' flag is true.

◆ NewVonNeumannSuperCursor()

vtkHyperTreeGridCursor* vtkHyperTreeGrid::NewVonNeumannSuperCursor ( vtkIdType  ,
bool  create = false 
)

Create a new hyper tree grid Von Neumann super cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index, managing geometric properties and von Neumann neighborhood with basic hyper tree grid cursors.

If no hyper tree is present at given location, then one will be created only if 'create' flag is true.

◆ NewMooreSuperCursor()

vtkHyperTreeGridCursor* vtkHyperTreeGrid::NewMooreSuperCursor ( vtkIdType  ,
bool  create = false 
)

Create a new hyper tree grid Moore super cursor: an object that can traverse the cells of a hyper tree grid, starting at given tree root index, managing geometric properties and Moore neighborhood with basic hyper tree grid cursors.

If no hyper tree is present at given location, then one will be created only if 'create' flag is true.

◆ SubdivideLeaf()

void vtkHyperTreeGrid::SubdivideLeaf ( vtkHyperTreeCursor ,
vtkIdType   
)

Subdivide node pointed by cursor, only if its a leaf.

At the end, cursor points on the node that used to be leaf.

Precondition
leaf_exists: leaf!=0
is_a_leaf: leaf->CurrentIsLeaf()

◆ GetPoint() [1/2]

double* vtkHyperTreeGrid::GetPoint ( vtkIdType  )
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to points requires that arrays are created explicitly. Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

◆ GetPoint() [2/2]

void vtkHyperTreeGrid::GetPoint ( vtkIdType  ,
double  [3] 
)
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to points requires that arrays are created explicitly. Copy point coordinates into user provided array x[3] for specified point id. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

◆ GetCell() [1/3]

vtkCell* vtkHyperTreeGrid::GetCell ( vtkIdType  )
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to cells requires that connectivity arrays are created explicitly. Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

◆ GetCell() [2/3]

vtkCell* vtkHyperTreeGrid::GetCell ( int  i,
int  j,
int  k 
)
inlineoverride

Overridden so as no not unintentionally hide parent class.

See -Woverloaded-virtual

Definition at line 354 of file vtkHyperTreeGrid.h.

◆ GetCell() [3/3]

void vtkHyperTreeGrid::GetCell ( vtkIdType  ,
vtkGenericCell  
)
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to cells requires that connectivity arrays are created explicitly. Get cell with cellId such that: 0 <= cellId < NumberOfCells. This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellType()

int vtkHyperTreeGrid::GetCellType ( vtkIdType  )
overridevirtual

All cell types are 2: quadrilaters,3d: hexahedrons.

They may be degenerate though. Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellPoints() [1/2]

void vtkHyperTreeGrid::GetCellPoints ( vtkIdType  ,
vtkIdList  
)
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to cells requires that connectivity arrays are created explicitly. Topological inquiry to get points defining cell. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellPoints() [2/2]

void vtkHyperTreeGrid::GetCellPoints ( vtkIdType  ,
vtkIdType ,
vtkIdType *&   
)

Return a pointer to a list of point ids defining cell.

NB: More efficient than alternative method.

◆ GetPointCells()

void vtkHyperTreeGrid::GetPointCells ( vtkIdType  ,
vtkIdList  
)
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to cells requires that connectivity arrays are created explicitly. Topological inquiry to get cells using point. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellNeighbors()

void vtkHyperTreeGrid::GetCellNeighbors ( vtkIdType  ,
vtkIdList ,
vtkIdList  
)
overridevirtual

This method should be avoided in favor of cell/point iterators.

Random access to cells requires that connectivity arrays are created explicitly. Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that the list consists of only cells that use ALL the points provided. This is exactly the same as GetCellNeighbors in unstructured grid. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

◆ FindPoint()

vtkIdType vtkHyperTreeGrid::FindPoint ( double  x[3])
overridevirtual

Find cell to which this point belongs, or at least closest one, even if the point is outside the grid.

Since dual points are leaves, use the structure of the Tree instead of a point locator.

Implements vtkDataSet.

◆ FindCell() [1/2]

vtkIdType vtkHyperTreeGrid::FindCell ( double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int subId,
double  pcoords[3],
double weights 
)
overridevirtual

Locate cell based on global coordinate x and tolerance squared.

If cell and cellId is non-nullptr, then search starts from this cell and looks at immediate neighbors. Returns cellId >= 0 if inside, < 0 otherwise. The parametric coordinates are provided in pcoords[3]. The interpolation weights are returned in weights[]. (The number of weights is equal to the number of points in the found cell). Tolerance is used to control how close the point is to be considered "in" the cell. NB: There is actually no need for a starting cell, just use the point, as the tree structure is efficient enough. THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

◆ FindCell() [2/2]

vtkIdType vtkHyperTreeGrid::FindCell ( double  x[3],
vtkCell cell,
vtkGenericCell gencell,
vtkIdType  cellId,
double  tol2,
int subId,
double  pcoords[3],
double weights 
)
overridevirtual

This is a version of the above method that can be used with multithreaded applications.

A vtkGenericCell must be passed in to be used in internal calls that might be made to GetCell() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ Initialize()

void vtkHyperTreeGrid::Initialize ( )
overridevirtual

Restore data object to initial state.

Reimplemented from vtkDataSet.

◆ GetTree()

vtkHyperTree* vtkHyperTreeGrid::GetTree ( vtkIdType  )

Return tree located at given index of hyper tree grid NB: This will return nullptr if grid slot is empty.

◆ 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.

◆ InitializeTreeIterator()

void vtkHyperTreeGrid::InitializeTreeIterator ( vtkHyperTreeGridIterator )

Initialize an iterator to browse level 0 trees.

FIXME: this method is completely unnecessary.

◆ GetMaxCellSize()

int vtkHyperTreeGrid::GetMaxCellSize ( )
overridevirtual

Convenience method to return largest cell size in dataset.

Generally used to allocate memory for supporting data structures. This is the number of points of a cell. THIS METHOD IS THREAD SAFE

Implements vtkDataSet.

◆ ShallowCopy()

void vtkHyperTreeGrid::ShallowCopy ( vtkDataObject )
overridevirtual

Create shallow copy of hyper tree grid.

Reimplemented from vtkDataSet.

◆ DeepCopy()

void vtkHyperTreeGrid::DeepCopy ( vtkDataObject )
overridevirtual

Create deep copy of hyper tree grid.

Reimplemented from vtkDataSet.

◆ GetExtentType()

int vtkHyperTreeGrid::GetExtentType ( )
inlineoverridevirtual

Structured extent.

The extent type is a 3D extent.

Reimplemented from vtkDataObject.

Definition at line 494 of file vtkHyperTreeGrid.h.

◆ 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 vtkDataSet.

◆ GetNumberOfChildren()

virtual unsigned int vtkHyperTreeGrid::GetNumberOfChildren ( )
virtual

The number of children each node can have.

◆ RecursivelyInitializePureMaterialMask()

bool vtkHyperTreeGrid::RecursivelyInitializePureMaterialMask ( vtkHyperTreeGridCursor cursor)

Recursively initialize pure material mask.

◆ GetPureMaterialMask()

vtkBitArray* vtkHyperTreeGrid::GetPureMaterialMask ( )

Get or create pure material mask.

◆ 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.

◆ GetLevelZeroCoordinatesFromIndex()

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

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

◆ GetIndexFromLevelZeroCoordinates()

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

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

◆ GetShiftedLevelZeroIndex()

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

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

by a Cartesian vector in the grid. NB: No boundary checks are performed.

◆ 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

◆ ComputeBounds()

void vtkHyperTreeGrid::ComputeBounds ( )
overrideprotectedvirtual

Compute the data bounding box from data points.

THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataSet.

◆ ComputeDualGrid()

void vtkHyperTreeGrid::ComputeDualGrid ( )
protected

Traverse tree with 3x3x3 super cursor.

Center cursor generates dual point. Smallest leaf (highest level) owns corners/dual cell. Ties are given to smallest index (z,y,x order) post: Generate Points and Connectivity.

◆ GetPoints()

vtkPoints* vtkHyperTreeGrid::GetPoints ( )
protected

◆ GetConnectivity()

vtkIdTypeArray* vtkHyperTreeGrid::GetConnectivity ( )
protected

◆ DeepCopyCursors()

void vtkHyperTreeGrid::DeepCopyCursors ( vtkHyperTreeCursor ,
vtkHyperTreeCursor  
)
protected

Perform left to right deep copy of hyper tree cursors.

◆ DeleteTrees()

void vtkHyperTreeGrid::DeleteTrees ( )
protected

Remove existing trees.

◆ ResetDual()

void vtkHyperTreeGrid::ResetDual ( )
protected

Reset dual mesh.

◆ ResetSuperCursor()

void vtkHyperTreeGrid::ResetSuperCursor ( )
protected

A convenience method to reset all cursors in a super cursor, either Von Neumann or Moore.

This is to be used by Initialize() and ToRoot(), factoring out the commonalities shared by these methods, while allowing for different inheritances.

◆ TraverseDualRecursively() [1/2]

void vtkHyperTreeGrid::TraverseDualRecursively ( vtkHyperTreeGridCursor )
protected

Recursively descend into tree down to leaves to generate dual.

◆ TraverseDualRecursively() [2/2]

void vtkHyperTreeGrid::TraverseDualRecursively ( vtkHyperTreeGridCursor ,
vtkBitArray  
)
protected

Recursively descend into tree down to leaves to generate dual, when a mask array is present.

◆ GenerateDualCornerFromLeaf1D() [1/2]

void vtkHyperTreeGrid::GenerateDualCornerFromLeaf1D ( vtkHyperTreeGridCursor )
protected

Process leaf cell and issue corresponding dual corner point in 1D.

◆ GenerateDualCornerFromLeaf1D() [2/2]

void vtkHyperTreeGrid::GenerateDualCornerFromLeaf1D ( vtkHyperTreeGridCursor ,
vtkBitArray  
)
protected

Process leaf cell and issue corresponding dual corner point in 1D, when a mask array is present.

◆ GenerateDualCornerFromLeaf2D() [1/2]

void vtkHyperTreeGrid::GenerateDualCornerFromLeaf2D ( vtkHyperTreeGridCursor )
protected

Process leaf cell and issue corresponding dual corner point in 2D.

◆ GenerateDualCornerFromLeaf2D() [2/2]

void vtkHyperTreeGrid::GenerateDualCornerFromLeaf2D ( vtkHyperTreeGridCursor ,
vtkBitArray  
)
protected

Process leaf cell and issue corresponding dual corner point in 2D, when a mask array is present.

◆ GenerateDualCornerFromLeaf3D() [1/2]

void vtkHyperTreeGrid::GenerateDualCornerFromLeaf3D ( vtkHyperTreeGridCursor )
protected

Process leaf cell and issue corresponding dual corner point in 3D.

◆ GenerateDualCornerFromLeaf3D() [2/2]

void vtkHyperTreeGrid::GenerateDualCornerFromLeaf3D ( vtkHyperTreeGridCursor ,
vtkBitArray  
)
protected

Process leaf cell and issue corresponding dual corner point in 3D, when a mask array is present.

◆ ShiftDualCornerFromMaskedLeaf2D()

void vtkHyperTreeGrid::ShiftDualCornerFromMaskedLeaf2D ( vtkHyperTreeGridCursor ,
vtkBitArray  
)
protected

Compute appropriate shifts for dual corners of masked cells in 2D.

◆ ShiftDualCornerFromMaskedLeaf3D()

void vtkHyperTreeGrid::ShiftDualCornerFromMaskedLeaf3D ( vtkHyperTreeGridCursor ,
vtkBitArray  
)
protected

Compute appropriate shifts for dual corners of masked cells in 3D.

◆ RecursivelyFindPoint()

vtkIdType vtkHyperTreeGrid::RecursivelyFindPoint ( double  x[3],
vtkHyperTreeGridCursor ,
double ,
double  
)
protected

Recursive method called under the hood by FindPoint().

◆ EvaluateDualCorner()

void vtkHyperTreeGrid::EvaluateDualCorner ( vtkHyperTreeSimpleCursor )
protected

◆ BuildLinks()

void vtkHyperTreeGrid::BuildLinks ( )
protected

Member Data Documentation

◆ BranchFactor

unsigned int vtkHyperTreeGrid::BranchFactor
protected

Definition at line 714 of file vtkHyperTreeGrid.h.

◆ Dimension

unsigned int vtkHyperTreeGrid::Dimension
protected

Definition at line 715 of file vtkHyperTreeGrid.h.

◆ Orientation

unsigned int vtkHyperTreeGrid::Orientation
protected

Definition at line 716 of file vtkHyperTreeGrid.h.

◆ GridSize

unsigned int vtkHyperTreeGrid::GridSize[3]
protected

Definition at line 717 of file vtkHyperTreeGrid.h.

◆ Extent

int vtkHyperTreeGrid::Extent[6]
protected

Definition at line 718 of file vtkHyperTreeGrid.h.

◆ NumberOfChildren

unsigned int vtkHyperTreeGrid::NumberOfChildren
protected

Definition at line 719 of file vtkHyperTreeGrid.h.

◆ TransposedRootIndexing

bool vtkHyperTreeGrid::TransposedRootIndexing
protected

Definition at line 720 of file vtkHyperTreeGrid.h.

◆ MaterialMask

vtkBitArray* vtkHyperTreeGrid::MaterialMask
protected

Definition at line 722 of file vtkHyperTreeGrid.h.

◆ PureMaterialMask

vtkBitArray* vtkHyperTreeGrid::PureMaterialMask
protected

Definition at line 723 of file vtkHyperTreeGrid.h.

◆ MaterialMaskIndex

vtkIdTypeArray* vtkHyperTreeGrid::MaterialMaskIndex
protected

Definition at line 724 of file vtkHyperTreeGrid.h.

◆ InitPureMaterialMask

bool vtkHyperTreeGrid::InitPureMaterialMask
protected

Definition at line 725 of file vtkHyperTreeGrid.h.

◆ HasInterface

bool vtkHyperTreeGrid::HasInterface
protected

Definition at line 727 of file vtkHyperTreeGrid.h.

◆ InterfaceNormalsName

char* vtkHyperTreeGrid::InterfaceNormalsName
protected

Definition at line 728 of file vtkHyperTreeGrid.h.

◆ InterfaceInterceptsName

char* vtkHyperTreeGrid::InterfaceInterceptsName
protected

Definition at line 729 of file vtkHyperTreeGrid.h.

◆ XCoordinates

vtkDataArray* vtkHyperTreeGrid::XCoordinates
protected

Definition at line 731 of file vtkHyperTreeGrid.h.

◆ YCoordinates

vtkDataArray* vtkHyperTreeGrid::YCoordinates
protected

Definition at line 732 of file vtkHyperTreeGrid.h.

◆ ZCoordinates

vtkDataArray* vtkHyperTreeGrid::ZCoordinates
protected

Definition at line 733 of file vtkHyperTreeGrid.h.

◆ HyperTrees

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

Definition at line 735 of file vtkHyperTreeGrid.h.

◆ Points

vtkPoints* vtkHyperTreeGrid::Points
protected

Definition at line 737 of file vtkHyperTreeGrid.h.

◆ Connectivity

vtkIdTypeArray* vtkHyperTreeGrid::Connectivity
protected

Definition at line 738 of file vtkHyperTreeGrid.h.

◆ PointShifted

std::map<vtkIdType, bool> vtkHyperTreeGrid::PointShifted
protected

Definition at line 739 of file vtkHyperTreeGrid.h.

◆ PointShifts

std::map<vtkIdType, double> vtkHyperTreeGrid::PointShifts[3]
protected

Definition at line 740 of file vtkHyperTreeGrid.h.

◆ ReductionFactors

std::map<vtkIdType, double> vtkHyperTreeGrid::ReductionFactors
protected

Definition at line 741 of file vtkHyperTreeGrid.h.

◆ Line

vtkLine* vtkHyperTreeGrid::Line
protected

These are needed by the GetCell() method.

Definition at line 837 of file vtkHyperTreeGrid.h.

◆ Pixel

vtkPixel* vtkHyperTreeGrid::Pixel
protected

Definition at line 838 of file vtkHyperTreeGrid.h.

◆ Voxel

vtkVoxel* vtkHyperTreeGrid::Voxel
protected

Definition at line 839 of file vtkHyperTreeGrid.h.

◆ Links

vtkCellLinks* vtkHyperTreeGrid::Links
protected

Not really needed.

Might be removed (is it a part of the vtkDataSet API?).

Definition at line 846 of file vtkHyperTreeGrid.h.


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