A specifalized type of vtkHyperTreeGrid for the case when root cells have uniform sizes in each direction. More...

#include <vtkUniformHyperTreeGrid.h>

Inheritance diagram for vtkUniformHyperTreeGrid:

Collaboration diagram for vtkUniformHyperTreeGrid:

Public Types
typedef vtkHyperTreeGrid	Superclass

Public Types inherited from vtkHyperTreeGrid
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...

vtkUniformHyperTreeGrid *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) 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 (vtkDataObject *) override
	Copy the internal geometric and topological structure of a vtkUniformHyperTreeGrid object. More...

void	Initialize () override
	Restore data object to initial state. More...

void	SetGridScale (double)
	Set all scales at once when root cells are d-cubes. More...

void	GetGridBounds (double bounds[6]) override
	Return a pointer to the grid bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...

void	GetLevelZeroOriginAndSizeFromIndex (vtkIdType, double , double ) override
	Convert the global index of a root to its Spatial coordinates origin and size. More...

void	GetLevelZeroOriginFromIndex (vtkIdType, double *) override
	Convert the global index of a root to its Spatial coordinates origin and size. 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...

unsigned long	GetActualMemorySizeBytes () override
	Return the actual size of the data bytes. More...

vtkHyperTree *	GetTree (vtkIdType, bool create=false) override
	Return tree located at given index of hyper tree grid NB: This will construct a new HyperTree if grid slot is empty. More...


virtual void	SetOrigin (double, double, double)
	Set/Get origin of grid. More...

virtual void	SetOrigin (double[3])
	Set/Get origin of grid. More...

virtual double *	GetOrigin ()
	Set/Get origin of grid. More...

virtual void	GetOrigin (double &, double &, double &)
	Set/Get origin of grid. More...

virtual void	GetOrigin (double[3])
	Set/Get origin of grid. More...


void	SetGridScale (double, double, double)
	Set/Get scale of root cells along each direction. More...

void	SetGridScale (double *)
	Set/Get scale of root cells along each direction. More...

virtual double *	GetGridScale ()
	Set/Get scale of root cells along each direction. More...

virtual void	GetGridScale (double &, double &, double &)
	Set/Get scale of root cells along each direction. More...

virtual void	GetGridScale (double[3])
	Set/Get scale of root cells along each direction. More...


void	SetXCoordinates (vtkDataArray *XCoordinates) override
	Set/Get the grid coordinates in the x-direction. More...

vtkDataArray *	GetXCoordinates () override
	Set/Get the grid coordinates in the x-direction. More...


void	SetYCoordinates (vtkDataArray *YCoordinates) override
	Set/Get the grid coordinates in the y-direction. More...

vtkDataArray *	GetYCoordinates () override
	Set/Get the grid coordinates in the y-direction. More...


void	SetZCoordinates (vtkDataArray *ZCoordinates) override
	Set/Get the grid coordinates in the z-direction. More...

vtkDataArray *	GetZCoordinates () override
	Set/Get the grid coordinates in the z-direction. More...


void	CopyCoordinates (const vtkHyperTreeGrid *output) override
	Augented services on Coordinates. More...

void	SetFixedCoordinates (unsigned int axis, double value) override
	Augented services on Coordinates. More...

Public Member Functions inherited from vtkHyperTreeGrid
vtkHyperTreeGrid *	NewInstance () const

virtual void	SetModeSqueeze (const char *)
	Set/Get mode squeeze. More...

virtual char *	GetModeSqueeze ()

virtual void	Squeeze ()
	Squeeze this representation. More...

virtual void	CopyEmptyStructure (vtkDataObject *)
	Copy the internal structure with no data associated. More...

vtkIdType	GetMaxNumberOfTrees () const
	Return the maximum number of trees in the level 0 grid. More...

vtkIdType	GetNumberOfNonEmptyTrees ()
	Get the number of non empty trees in this grid. More...

vtkIdType	GetNumberOfLeaves ()
	Get the number of leaves in the primal tree grid. More...

unsigned int	GetNumberOfLevels (vtkIdType)
	Return the number of levels in an individual (primal) tree. More...

unsigned int	GetNumberOfLevels ()
	Return the number of levels in the hyper tree grid. More...

bool	HasMask ()
	Determine whether blanking mask is empty or not. More...

vtkHyperTreeGridNonOrientedGeometryCursor *	FindNonOrientedGeometryCursor (double x[3])
	Return a geometric cursor pointing to one of the nodes at position `x` 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...

int	GetExtentType () override
	Structured extent. More...

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes). More...

bool	SupportsGhostArray (int type) override
	Returns true if type is CELL, false otherwise. More...

vtkBitArray *	GetPureMask ()
	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	GetIndexFromLevelZeroCoordinates (vtkIdType &, unsigned int, unsigned int, unsigned int) const
	Convert the Cartesian coordinates of a root in the grid to its global index. More...

vtkIdType	GetShiftedLevelZeroIndex (vtkIdType, int, int, int) const
	Return the root index of a root cell with given index displaced. More...

void	GetLevelZeroCoordinatesFromIndex (vtkIdType, unsigned int &, unsigned int &, unsigned int &) const
	Convert the global index of a root to its Cartesian coordinates in the grid. More...

vtkIdType	GetGlobalNodeIndexMax ()
	Return the maximum global index value. More...

void	InitializeLocalIndexNode ()
	Initialize local indexes for every individual Hyper Tree after they have been refined. More...

bool	HasAnyGhostCells () const
	Returns true if a ghost cell array is defined. More...

vtkUnsignedCharArray *	GetGhostCells ()
	Gets the array that defines the ghost type of each cell. More...

vtkUnsignedCharArray *	GetTreeGhostArray ()
	Gets the array that defines the ghost type of each cell. More...

vtkUnsignedCharArray *	AllocateTreeGhostArray ()
	Allocate ghost array for points. More...

void	InitializeTreeIterator (vtkHyperTreeGridIterator &)
	Initialize an iterator to browse level 0 trees. More...

virtual void	ComputeBounds ()
	Compute the hyper tree grid bounding box ignoring masked cells. More...

double *	GetCenter ()
	Get the center of the bounding box. More...

void	GetCenter (double center[3])
	Get the center of the bounding box. More...

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's hypertree node data. More...

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the hypertree node field data stored as cell data. More...

vtkIdType	GetNumberOfElements (int type) override
	Returns the number of nodes. More...

vtkIdType	GetNumberOfCells ()
	Return the number of cells. More...

void	SetDimensions (const unsigned int dims[3])
	Set/Get sizes of this rectilinear grid dataset. More...

void	SetDimensions (const int dims[3])
	Set/Get sizes of this rectilinear grid dataset. More...

void	SetDimensions (unsigned int i, unsigned int j, unsigned int k)
	Set/Get sizes of this rectilinear grid dataset. More...

void	SetDimensions (int i, int j, int k)
	Set/Get sizes of this rectilinear grid dataset. More...

const unsigned int *	GetDimensions () const
	Get dimensions of this rectilinear grid dataset. More...

void	GetDimensions (int dim[3]) const
	Get dimensions of this rectilinear grid dataset. More...

void	GetDimensions (unsigned int dim[3]) const
	Get dimensions of this rectilinear grid dataset. More...

void	SetExtent (const int extent[6])
	Different ways to set the extent of the data array. More...

void	SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
	Different ways to set the extent of the data array. More...

virtual int *	GetExtent ()
	Different ways to set the extent of the data array. More...

virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
	Different ways to set the extent of the data array. More...

virtual void	GetExtent (int[6])
	Different ways to set the extent of the data array. More...

const unsigned int *	GetCellDims () const
	Get grid sizes of this structured cells dataset. More...

void	GetCellDims (int cellDims[3]) const
	Get grid sizes of this structured cells dataset. More...

void	GetCellDims (unsigned int cellDims[3]) const
	Get grid sizes of this structured cells dataset. More...

unsigned int	GetDimension () const
	Get the dimensionality of the grid deduite a partir de Dimensions/Extent. More...

void	Get1DAxis (unsigned int &axis) const
	Retourne l'indice de la dimension valide. More...

void	Get2DAxes (unsigned int &axis1, unsigned int &axis2) const
	Retourne l'indice des deux dimensions valides. More...

const unsigned int *	GetAxes () const
	Get the axis information (used for CopyStructure) More...

unsigned int	GetNumberOfChildren () const
	The number of children each node can have. More...

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 ()
	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...

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

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

unsigned int	GetOrientation () const
	Get the orientation of 1D or 2D grids: More...

virtual bool	GetFreezeState ()
	Get the state of frozen. More...

void	SetBranchFactor (unsigned int)
	Set/Get the subdivision factor in the grid refinement scheme. More...

unsigned int	GetBranchFactor () const
	Set/Get the subdivision factor in the grid refinement scheme. More...

void	SetMask (vtkBitArray *)
	Set/Get the blanking mask of primal leaf cells. More...

virtual vtkBitArray *	GetMask ()
	Set/Get the blanking mask of primal leaf cells. More...

virtual void	SetHasInterface (bool)
	Set/Get presence or absence of interface. More...

virtual bool	GetHasInterface ()
	Set/Get presence or absence of interface. More...

virtual void	HasInterfaceOn ()
	Set/Get presence or absence of interface. More...

virtual void	HasInterfaceOff ()
	Set/Get presence or absence of interface. More...

virtual void	SetInterfaceNormalsName (const char *)
	Set/Get names of interface normal vectors arrays. More...

virtual char *	GetInterfaceNormalsName ()
	Set/Get names of interface normal vectors arrays. More...

virtual void	SetInterfaceInterceptsName (const char *)
	Set/Get names of interface intercepts arrays. More...

virtual char *	GetInterfaceInterceptsName ()
	Set/Get names of interface intercepts arrays. More...

virtual void	SetDepthLimiter (unsigned int)
	Set/Get depth limiter value. More...

virtual unsigned int	GetDepthLimiter ()
	Set/Get depth limiter value. More...

void	InitializeOrientedCursor (vtkHyperTreeGridOrientedCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridOrientedCursor *	NewOrientedCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeOrientedGeometryCursor (vtkHyperTreeGridOrientedGeometryCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridOrientedGeometryCursor *	NewOrientedGeometryCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedCursor (vtkHyperTreeGridNonOrientedCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedCursor *	NewNonOrientedCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedGeometryCursor (vtkHyperTreeGridNonOrientedGeometryCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedGeometryCursor *	NewNonOrientedGeometryCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedUnlimitedGeometryCursor (vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor *	NewNonOrientedUnlimitedGeometryCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedVonNeumannSuperCursor (vtkHyperTreeGridNonOrientedVonNeumannSuperCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedVonNeumannSuperCursor *	NewNonOrientedVonNeumannSuperCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedVonNeumannSuperCursorLight (vtkHyperTreeGridNonOrientedVonNeumannSuperCursorLight *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedVonNeumannSuperCursorLight *	NewNonOrientedVonNeumannSuperCursorLight (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedMooreSuperCursor (vtkHyperTreeGridNonOrientedMooreSuperCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedMooreSuperCursor *	NewNonOrientedMooreSuperCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedMooreSuperCursorLight (vtkHyperTreeGridNonOrientedMooreSuperCursorLight *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedMooreSuperCursorLight *	NewNonOrientedMooreSuperCursorLight (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

void	InitializeNonOrientedUnlimitedMooreSuperCursor (vtkHyperTreeGridNonOrientedUnlimitedMooreSuperCursor *cursor, vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

vtkHyperTreeGridNonOrientedUnlimitedMooreSuperCursor *	NewNonOrientedUnlimitedMooreSuperCursor (vtkIdType index, bool create=false)
	Used to initialize a cursor of the given type. More...

virtual double *	GetBounds ()
	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...

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime. More...

void	ReleaseData ()
	Release data back to system to conserve memory resource. More...

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 vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type. More...

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays 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...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object. More...

virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released. More...

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object. More...

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. 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...

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. 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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

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

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkUniformHyperTreeGrid *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkUniformHyperTreeGrid *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkHyperTreeGrid
static vtkInformationIntegerKey *	LEVELS ()

static vtkInformationIntegerKey *	DIMENSION ()

static vtkInformationIntegerKey *	ORIENTATION ()

static vtkInformationDoubleVectorKey *	SIZES ()

static vtkHyperTreeGrid *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkHyperTreeGrid *	SafeDownCast (vtkObjectBase *o)

static vtkHyperTreeGrid *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkHyperTreeGrid *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (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 vtkInformation *	GetNamedFieldInformation (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 vtkInformation *	SetActiveAttribute (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 *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e. More...

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkUniformHyperTreeGrid ()
	Constructor. More...

	~vtkUniformHyperTreeGrid () override
	Destructor. More...

unsigned int	FindDichotomic (double value, unsigned char dim, double tol) const

unsigned int	FindDichotomicX (double value, double tolerance=0.0) const override

unsigned int	FindDichotomicY (double value, double tolerance=0.0) const override

unsigned int	FindDichotomicZ (double value, double tolerance=0.0) const override

Protected Member Functions inherited from vtkHyperTreeGrid
	vtkHyperTreeGrid ()
	Constructor with default bounds (0,1, 0,1, 0,1). More...

	~vtkHyperTreeGrid () override
	Destructor. 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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Origin [3]
	Grid Origin. More...

double	GridScale [3]
	Element sizes in each direction. More...

std::shared_ptr< vtkHyperTreeGridScales >	Scales
	Storage of pre-computed per-level cell scales. More...


bool	ComputedXCoordinates
	Keep track of whether coordinates have been explicitly computed. More...

bool	ComputedYCoordinates
	Keep track of whether coordinates have been explicitly computed. More...

bool	ComputedZCoordinates
	Keep track of whether coordinates have been explicitly computed. More...

Protected Attributes inherited from vtkHyperTreeGrid
char *	ModeSqueeze
	ModeSqueeze. More...

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

vtkDataArray *	XCoordinates

vtkDataArray *	YCoordinates

vtkDataArray *	ZCoordinates

vtkBitArray *	Mask

vtkBitArray *	PureMask

bool	HasInterface

char *	InterfaceNormalsName

char *	InterfaceInterceptsName

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

vtkNew< vtkCellData >	CellData

unsigned int	DepthLimiter

vtkUnsignedCharArray *	TreeGhostArray
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...

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

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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 Public Attributes inherited from vtkHyperTreeGrid
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). More...

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

A specifalized type of vtkHyperTreeGrid for the case when root cells have uniform sizes in each direction.

See also: vtkHyperTree vtkHyperTreeGrid vtkRectilinearGrid

Thanks:: This class was written by Philippe Pebay, NexGen Analytics 2017 Modified to introduce Scales by Jacques-Bernard Lekien, CEA 2018. This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.

Tests:: vtkUniformHyperTreeGrid (Tests)

Definition at line 36 of file vtkUniformHyperTreeGrid.h.

Member Typedef Documentation

◆ Superclass

typedef vtkHyperTreeGrid vtkUniformHyperTreeGrid::Superclass

Definition at line 40 of file vtkUniformHyperTreeGrid.h.

Constructor & Destructor Documentation

◆ vtkUniformHyperTreeGrid()

vtkUniformHyperTreeGrid::vtkUniformHyperTreeGrid ( )

protected

Constructor.

◆ ~vtkUniformHyperTreeGrid()

vtkUniformHyperTreeGrid::~vtkUniformHyperTreeGrid ( )

overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkUniformHyperTreeGrid* vtkUniformHyperTreeGrid::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkUniformHyperTreeGrid::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkHyperTreeGrid.

◆ NewInstance()

vtkUniformHyperTreeGrid* vtkUniformHyperTreeGrid::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetDataObjectType()

int vtkUniformHyperTreeGrid::GetDataObjectType ( )

inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkHyperTreeGrid.

Definition at line 46 of file vtkUniformHyperTreeGrid.h.

◆ CopyStructure()

void vtkUniformHyperTreeGrid::CopyStructure ( vtkDataObject * )

overridevirtual

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

Reimplemented from vtkHyperTreeGrid.

◆ Initialize()

void vtkUniformHyperTreeGrid::Initialize ( )

overridevirtual

Restore data object to initial state.

Reimplemented from vtkHyperTreeGrid.

◆ SetOrigin() [1/2]

virtual void vtkUniformHyperTreeGrid::SetOrigin	(	double	,
		double	,
		double
	)

virtual

Set/Get origin of grid.

◆ SetOrigin() [2/2]

virtual void vtkUniformHyperTreeGrid::SetOrigin ( double [3] )

virtual

Set/Get origin of grid.

◆ GetOrigin() [1/3]

virtual double* vtkUniformHyperTreeGrid::GetOrigin ( )

virtual

Set/Get origin of grid.

◆ GetOrigin() [2/3]

virtual void vtkUniformHyperTreeGrid::GetOrigin	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get origin of grid.

◆ GetOrigin() [3/3]

virtual void vtkUniformHyperTreeGrid::GetOrigin ( double [3] )

virtual

Set/Get origin of grid.

◆ SetGridScale() [1/3]

void vtkUniformHyperTreeGrid::SetGridScale	(	double	,
		double	,
		double
	)

Set/Get scale of root cells along each direction.

◆ SetGridScale() [2/3]

void vtkUniformHyperTreeGrid::SetGridScale ( double * )

Set/Get scale of root cells along each direction.

◆ GetGridScale() [1/3]

virtual double* vtkUniformHyperTreeGrid::GetGridScale ( )

virtual

Set/Get scale of root cells along each direction.

◆ GetGridScale() [2/3]

virtual void vtkUniformHyperTreeGrid::GetGridScale	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get scale of root cells along each direction.

◆ GetGridScale() [3/3]

virtual void vtkUniformHyperTreeGrid::GetGridScale ( double [3] )

virtual

Set/Get scale of root cells along each direction.

◆ SetGridScale() [3/3]

void vtkUniformHyperTreeGrid::SetGridScale ( double )

Set all scales at once when root cells are d-cubes.

◆ GetGridBounds()

void vtkUniformHyperTreeGrid::GetGridBounds ( double bounds[6] )

overridevirtual

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

THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkHyperTreeGrid.