structured grid with explicit topology and geometry More...

#include <vtkExplicitStructuredGrid.h>

Inheritance diagram for vtkExplicitStructuredGrid:

Collaboration diagram for vtkExplicitStructuredGrid:

Public Member Functions
int	GetDataObjectType () override
	Return what type of dataset this is.

void	CopyStructure (vtkDataSet *ds) override
	Copy the geometric and topological structure of an input poly data object.

int	GetDataDimension ()
	Return the dimensionality of the data.

void	GetCellDims (int cellDims[3])
	Computes the cell dimensions according to internal point dimensions.

int	GetExtentType () override
	The extent type is a 3D extent.

void	BuildLinks ()
	Build topological links from points to lists of cells that use each point.

vtkIdType *	GetCellPoints (vtkIdType cellId)
	Get direct raw pointer to the 8 points indices of an hexahedra.

void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType *&pts)
	More efficient method to obtain cell points.

void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds) override
	More efficient method to obtain cell points.

void	GetCellNeighbors (vtkIdType cellId, vtkIdType neighbors[6], int *wholeExtent=nullptr)
	Get cell neighbors of the cell for every faces.

void	ComputeCellStructuredCoords (vtkIdType cellId, int &i, int &j, int &k, bool adjustForExtent=true)
	Given a cellId, get the structured coordinates (i-j-k).

vtkIdType	ComputeCellId (int i, int j, int k, bool adjustForExtent=true)
	Given a location in structured coordinates (i-j-k), return the cell id.

void	ComputeFacesConnectivityFlagsArray ()
	Compute the faces connectivity flags array.

bool	HasAnyBlankCells () override
	Returns true if one or more cells are blanked, false otherwise.

unsigned char	IsCellVisible (vtkIdType cellId)
	Return non-zero value if specified cell is visible.

unsigned char	IsCellGhost (vtkIdType cellId)
	Return non-zero value if specified cell is a ghost cell.

bool	HasAnyGhostCells ()
	Returns true if one or more cells are ghost, false otherwise.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kilobytes.

void	CheckAndReorderFaces ()
	Check faces are numbered correctly regarding ijk numbering If not this will reorganize cell points order so face order is valid.


void	Initialize () override
	Standard vtkDataSet API methods.

vtkCell *	GetCell (vtkIdType cellId) override
	Standard vtkDataSet API methods.

void	GetCell (vtkIdType cellId, vtkGenericCell *cell) override
	Standard vtkDataSet API methods.

void	GetCellBounds (vtkIdType cellId, double bounds[6]) override
	Standard vtkDataSet API methods.

int	GetCellType (vtkIdType cellId) override
	Standard vtkDataSet API methods.

vtkIdType	GetCellSize (vtkIdType cellId) override
	Standard vtkDataSet API methods.

vtkIdType	GetNumberOfCells () override
	Standard vtkDataSet API methods.

void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
	Standard vtkDataSet API methods.

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
	Standard vtkDataSet API methods.

int	GetMaxCellSize () override
	Standard vtkDataSet API methods.

int	GetMaxSpatialDimension () override
	Standard vtkDataSet API methods.

void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds) override
	Standard vtkDataSet API methods.

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
	Standard vtkDataSet API methods.

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.


void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy.

void	DeepCopy (vtkDataObject *src) override
	Shallow and Deep copy.


void	SetDimensions (int i, int j, int k)
	Set/Get the dimensions of this structured dataset in term of number of points along each direction.

void	SetDimensions (int dim[3])
	Set/Get the dimensions of this structured dataset in term of number of points along each direction.

void	GetDimensions (int dim[3])
	Set/Get the dimensions of this structured dataset in term of number of points along each direction.


void	SetExtent (int x0, int x1, int y0, int y1, int z0, int z1)
	Set/Get the extent of this structured dataset in term of number of points along each direction.

void	SetExtent (int extent[6])
	Set/Get the extent of this structured dataset in term of number of points along each direction.

virtual int *	GetExtent ()
	Set/Get the extent of this structured dataset in term of number of points along each direction.

virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
	Set/Get the extent of this structured dataset in term of number of points along each direction.

virtual void	GetExtent (int[6])
	Set/Get the extent of this structured dataset in term of number of points along each direction.


	vtkSetSmartPointerMacro (Cells, vtkCellArray)
	Set/Get the cell array defining hexahedron.

	vtkGetSmartPointerMacro (Cells, vtkCellArray)
	Set/Get the cell array defining hexahedron.


	vtkSetSmartPointerMacro (Links, vtkAbstractCellLinks)
	Set/Get the links that you created possibly without using BuildLinks.

	vtkGetSmartPointerMacro (Links, vtkAbstractCellLinks)
	Set/Get the links that you created possibly without using BuildLinks.


virtual void	SetFacesConnectivityFlagsArrayName (const char *)
	Set/Get the name of the faces connectivity flags array.

virtual char *	GetFacesConnectivityFlagsArrayName ()
	Set/Get the name of the faces connectivity flags array.


void	BlankCell (vtkIdType cellId)
	Methods for supporting blanking of cells.

void	UnBlankCell (vtkIdType cellId)
	Methods for supporting blanking of cells.


void	Crop (const int *updateExtent) override
	Reallocates and copies to set the Extent to the UpdateExtent.

virtual void	Crop (vtkExplicitStructuredGrid input, const int updateExtent, bool generateOriginalCellIds)
	Reallocates and copies to set the Extent to the UpdateExtent.


void	GenerateGhostArray (int zeroExt[6], bool cellOnly) override
	Normally called by pipeline executives or algorithms only.

virtual void	GenerateGhostArray (int zeroExt[6])
	Normally called by pipeline executives or algorithms only.

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)
	Normally called by pipeline executives or algorithms only.

Public Member Functions inherited from vtkPointSet
int	GetDataObjectType () override
	Standard vtkDataSet API methods.

void	Initialize () override
	Reset to an empty state and free any memory.

void	CopyStructure (vtkDataSet *pd) override
	Copy the geometric structure of an input point set object.

vtkCell *	GetCell (vtkIdType) override
	This method always return a `vtkEmptyCell`, as there is no cell in a `vtkPointSet`.

void	GetCell (vtkIdType, vtkGenericCell *cell) override
	This method sets cell to be an empty cell.

int	GetCellType (vtkIdType) override
	This method always returns `VTK_EMPTY_CELL`, as there is no cell in a `vtkPointSet`.

vtkIdType	GetCellSize (vtkIdType) override
	This method always returns 1, as all cells are point in a pure `vtkPointSet`.

double *	GetPoint (vtkIdType ptId) override
	See vtkDataSet for additional information.

vtkCellIterator *	NewCellIterator () override
	Return an iterator that traverses the cells in this data set.

void	BuildCellLocator ()
	Build the cell locator.

vtkMTimeType	GetMTime () override
	Get MTime which also considers its vtkPoints MTime.

void	ComputeBounds () override
	Compute the (X, Y, Z) bounds of the data.

void	Squeeze () override
	Reclaim any unused memory.

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

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	SetEditable (bool)
	Specify whether this dataset is editable after creation.

virtual bool	GetEditable ()
	Specify whether this dataset is editable after creation.

virtual void	EditableOn ()
	Specify whether this dataset is editable after creation.

virtual void	EditableOff ()
	Specify whether this dataset is editable after creation.

vtkIdType	GetNumberOfPoints () override
	See vtkDataSet for additional information.

void	GetPoint (vtkIdType ptId, double x[3]) override
	See vtkDataSet for additional information.

vtkIdType	FindPoint (double x[3]) override
	See vtkDataSet for additional information.

vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	See vtkDataSet for additional information.

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	See vtkDataSet for additional information.

vtkIdType	GetNumberOfCells () override
	This method always returns 0, as there are no cells in a `vtkPointSet`.

int	GetMaxCellSize () override
	This method always returns 0, as there are no cells in a `vtkPointSet`.

void	GetCellPoints (vtkIdType, vtkIdList *idList) override
	This method resets parameter idList, as there is no cell in a `vtkPointSet`.

void	GetPointCells (vtkIdType, vtkIdList *idList) override
	This method resets parameter idList, as there is no cell in a `vtkPointSet`.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
	This method resets parameter idList, as there is no cell in a `vtkPointSet`.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds)
	This method resets parameter idList, as there is no cell in a `vtkPointSet`.

void	BuildPointLocator ()
	Build the internal point locator .

void	BuildLocator ()
	Build the internal point locator .

virtual void	SetPointLocator (vtkAbstractPointLocator *)
	Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.

virtual vtkAbstractPointLocator *	GetPointLocator ()
	Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.

virtual void	SetCellLocator (vtkAbstractCellLocator *)
	Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation.

virtual vtkAbstractCellLocator *	GetCellLocator ()
	Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation.

virtual void	SetPoints (vtkPoints *)
	Specify point array to define point coordinates.

vtkPoints *	GetPoints () override
	Specify point array to define point coordinates.

void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy.

void	DeepCopy (vtkDataObject *src) override
	Shallow and Deep copy.

bool	UsesGarbageCollector () const override
	Overwritten to handle the data/locator loop.

vtkPointSet *	NewInstance () const
	Standard methods for type information and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.

Public Member Functions inherited from vtkDataSet
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataSet *	NewInstance () const

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

virtual void	CopyStructure (vtkDataSet *ds)=0
	Copy the geometric and topological structure of an object.

virtual void	CopyAttributes (vtkDataSet *ds)
	Copy the attributes associated with the specified dataset to this instance of vtkDataSet.

virtual vtkIdType	GetNumberOfPoints ()=0
	Determine the number of points composing the dataset.

virtual vtkIdType	GetNumberOfCells ()=0
	Determine the number of cells composing the dataset.

virtual vtkPoints *	GetPoints ()
	If the subclass has (implicit/explicit) points, then return them.

virtual double *	GetPoint (vtkIdType ptId)=0
	Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

virtual void	GetPoint (vtkIdType id, double x[3])
	Copy point coordinates into user provided array x[3] for specified point id.

virtual vtkCellIterator *	NewCellIterator ()
	Return an iterator that traverses the cells in this data set.

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))

void	SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell)

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
	Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual int	GetCellType (vtkIdType cellId)=0
	Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkIdType	GetCellSize (vtkIdType cellId)
	Get the size of cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	GetCellTypes (vtkCellTypes *types)
	Get a list of types of cells in a dataset.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
	Topological inquiry to get points defining cell.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds)
	Topological inquiry to get points defining cell.

virtual void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
	Topological inquiry to get cells using point.

virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)
	Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId).

int	GetCellNumberOfFaces (vtkIdType cellId, unsigned char &cellType, vtkGenericCell *cell)
	Get the number of faces of a cell.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)=0
	Locate cell based on global coordinate x and tolerance squared.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
	This is a version of the above method that can be used with multithreaded applications.

virtual vtkCell *	FindAndGetCell (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.

vtkMTimeType	GetMTime () override
	Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's cell data.

vtkPointData *	GetPointData ()
	Return a pointer to this dataset's point data.

virtual void	Squeeze ()
	Reclaim any extra memory used to store data.

virtual void	ComputeBounds ()
	Compute the data bounding box from data points.

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

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

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

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

double	GetLength ()
	Return the length of the diagonal of the bounding box.

double	GetLength2 ()
	Return the squared length of the diagonal of the bounding box.

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

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.

double *	GetScalarRange ()
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.

virtual int	GetMaxCellSize ()=0
	Convenience method returns largest cell size in dataset.

virtual int	GetMaxSpatialDimension ()
	Get the maximum spatial dimensionality of the data which is the maximum dimension of all cells.

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

int	GetDataObjectType () override
	Return the type of data object.

int	CheckAttributes ()
	This method checks to see if the cell and point attributes match the geometry.

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData.

vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

bool	HasAnyGhostCells ()
	Returns 1 if there are any ghost cells 0 otherwise.

bool	HasAnyGhostPoints ()
	Returns 1 if there are any ghost points 0 otherwise.

virtual bool	HasAnyBlankCells ()
	Returns 1 if there are any blanking cells 0 otherwise.

virtual bool	HasAnyBlankPoints ()
	Returns 1 if there are any blanking points 0 otherwise.

vtkUnsignedCharArray *	GetPointGhostArray ()
	Gets the array that defines the ghost type of each point.

void	UpdatePointGhostArrayCache ()
	Updates the pointer to the point ghost array.

vtkUnsignedCharArray *	AllocatePointGhostArray ()
	Allocate ghost array for points.

vtkUnsignedCharArray *	GetCellGhostArray ()
	Get the array that defines the ghost type of each cell.

void	UpdateCellGhostArrayCache ()
	Updates the pointer to the cell ghost array.

vtkUnsignedCharArray *	AllocateCellGhostArray ()
	Allocate ghost array for cells.

vtkUnsignedCharArray *	GetGhostArray (int type) override
	Returns the ghost array for the given type (point or cell).

bool	SupportsGhostArray (int type) override
	Returns true for POINT or CELL, false otherwise.

vtkIdType	FindPoint (double x, double y, double z)
	Locate the closest point to the global coordinate x.

Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataObject *	NewInstance () const

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

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

virtual void	Initialize ()
	Restore data object to initial state,.

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

virtual int	GetDataObjectType ()
	Return class name of data type.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

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

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual void	ShallowCopy (vtkDataObject *src)
	The goal of the method is to copy the data up to the array pointers only.

virtual void	DeepCopy (vtkDataObject *src)
	The goal of the method is to copy the complete data from src into this object.

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.

virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

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

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

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

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

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

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

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

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

Static Public Member Functions

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

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

Static Public Member Functions inherited from vtkPointSet
static vtkPointSet *	New ()
	Standard instantiation method.

static vtkPointSet *	ExtendedNew ()

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

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

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.

static vtkPointSet *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.

Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

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

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

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)

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.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

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

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

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

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

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

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

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

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

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

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

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

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

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

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

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

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkExplicitStructuredGrid ()

	~vtkExplicitStructuredGrid () override

void	ReportReferences (vtkGarbageCollector *) override

void	ComputeScalarRange () override
	Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).

virtual void	InternalCopy (vtkExplicitStructuredGrid *src)
	Internal method used by DeepCopy and ShallowCopy.

void	InternalCheckAndReorderFaces (bool swap)
	Internal method used by CheckAndReorderFaces.

int	FindConnectedFaces (int foundFaces[3])
	Find a connected face for each axis if any.

void	ReorderCellsPoints (const int *ptsMap, const int transformFlag[3])
	Reorder all cells points based on a transformFlag for each axis and a points map.

Protected Member Functions inherited from vtkPointSet
	vtkPointSet ()

	~vtkPointSet () override

void	ReportReferences (vtkGarbageCollector *) override

Protected Member Functions inherited from vtkDataSet
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataSet ()

	~vtkDataSet () override

vtkMTimeType	GetGhostCellsTime ()
	Return the MTime of the ghost cells array.

virtual void	ComputeScalarRange ()
	Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	CheckConnectedFaces (int &nFoundFaces, int foundFaces[3])
	Check a list of connected faces and remove invalid face or extrapolate missing faces.

static void	ComputeSwapFlag (int foundFaces[3], int swap[3])
	Compute a swap flag based if a face have been found.

static void	ComputeMirrorFlag (int foundFaces[3], int mirror[3])
	Compute a mirror flag based if a face have been found.

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkSmartPointer< vtkCellArray >	Cells

vtkSmartPointer< vtkAbstractCellLinks >	Links

int	Extent [6]

char *	FacesConnectivityFlagsArrayName

Protected Attributes inherited from vtkPointSet
bool	Editable

vtkPoints *	Points

vtkAbstractPointLocator *	PointLocator

vtkAbstractCellLocator *	CellLocator

Protected Attributes inherited from vtkDataSet
vtkNew< vtkGenericCell >	GenericCell

vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

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

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

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

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

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

typedef vtkPointSet	Superclass
	Standard methods for instantiation, type information, and printing.

static vtkExplicitStructuredGrid *	New ()
	Standard methods for instantiation, type information, and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, type information, and printing.

static vtkExplicitStructuredGrid *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, type information, and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, type information, and printing.

vtkExplicitStructuredGrid *	NewInstance () const
	Standard methods for instantiation, type information, and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, type information, and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, type information, and printing.

Additional Inherited Members
Public Types inherited from vtkPointSet
typedef vtkDataSet	Superclass
	Standard methods for type information and printing.

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

Detailed Description

structured grid with explicit topology and geometry

vtkExplicitStructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkExplicitStructuredGrid represents a geometric structure that is a topologically regular array of hexahedron. The topology is that of a cube that has been subdivided into a regular array of smaller cubes. Each cell can be addressed with i-j-k indices, however neighbor hexahedrons does not necessarily share a face and hexahedron can be blanked (turned-off).

Like unstructured grid, vtkExplicitStructuredGrid has explicit point coordinates and cell to point indexing. Unlike unstructured grid, vtkExplicitStructuredGrid does not keep a cell type list as all visible cells are known to be hexahedra. vtkExplicitStructuredGrid can take advantage of its layout to perform operations based on the i, j, k parameters, similar to structured grid. This makes some operations faster on this class, without losing the flexibility of the cell -> points mapping. The most common use of this class would be in situations where you have all hexahedra but the points used by the cells are not exactly defined by the i, j, k parameters. One example of this is a structured grid with a half voxel shift occurring in the middle of it such as with a geologic fault.

The order and number of points is arbitrary. The order and number of cells must match that specified by the dimensions of the grid minus 1, because in vtk structured datasets the dimensions correspond to the points. The cells order increases in i fastest (from 0 <= i <= dims[0] - 2), then j (0 <= j <= dims[1] - 2), then k ( 0 <= k <= dims[2] - 2) where dims[] are the dimensions of the grid in the i-j-k topological directions. The number of cells is (dims[0] - 1) * (dims[1] - 1) * (dims[2] - 1).

In order for an ESG to be usable by most other ESG specific filters, it is needed to call the ComputeFacesConnectivityFlagsArray method. It is also recommended to call CheckAndReorderFaces method to fix any faces issues in the dataset.

Online Examples:

CreateESGrid

LoadESGrid

Tests:: vtkExplicitStructuredGrid (Tests)

Definition at line 87 of file vtkExplicitStructuredGrid.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPointSet vtkExplicitStructuredGrid::Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 95 of file vtkExplicitStructuredGrid.h.

Constructor & Destructor Documentation

◆ vtkExplicitStructuredGrid()

vtkExplicitStructuredGrid::vtkExplicitStructuredGrid ( )

protected

◆ ~vtkExplicitStructuredGrid()

vtkExplicitStructuredGrid::~vtkExplicitStructuredGrid ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkExplicitStructuredGrid * vtkExplicitStructuredGrid::New ( )

static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

static

Standard methods for instantiation, type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkExplicitStructuredGrid::IsA ( const char * type )

virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPointSet.

◆ SafeDownCast()

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

static

Standard methods for instantiation, type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkExplicitStructuredGrid::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPointSet.

◆ NewInstance()

vtkExplicitStructuredGrid * vtkExplicitStructuredGrid::NewInstance ( ) const

Standard methods for instantiation, type information, and printing.

◆ PrintSelf()

void vtkExplicitStructuredGrid::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkDataSet.

◆ GetDataObjectType()

int vtkExplicitStructuredGrid::GetDataObjectType ( )

inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 102 of file vtkExplicitStructuredGrid.h.

◆ Initialize()

void vtkExplicitStructuredGrid::Initialize ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetCell() [1/5]

vtkCell * vtkExplicitStructuredGrid::GetCell ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetCell() [2/5]

void vtkExplicitStructuredGrid::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetCellBounds()

void vtkExplicitStructuredGrid::GetCellBounds	(	vtkIdType	cellId,
		double	bounds[6]
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetCellType()

int vtkExplicitStructuredGrid::GetCellType ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetCellSize()

vtkIdType vtkExplicitStructuredGrid::GetCellSize ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetNumberOfCells()

vtkIdType vtkExplicitStructuredGrid::GetNumberOfCells ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetCellPoints() [1/4]

void vtkExplicitStructuredGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetPointCells()

void vtkExplicitStructuredGrid::GetPointCells	(	vtkIdType	ptId,
		vtkIdList *	cellIds
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetMaxCellSize()

int vtkExplicitStructuredGrid::GetMaxCellSize ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 118 of file vtkExplicitStructuredGrid.h.

◆ GetMaxSpatialDimension()

int vtkExplicitStructuredGrid::GetMaxSpatialDimension ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 119 of file vtkExplicitStructuredGrid.h.

◆ GetCellNeighbors() [1/2]

void vtkExplicitStructuredGrid::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdList *	ptIds,
		vtkIdList *	cellIds
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ CopyStructure()

void vtkExplicitStructuredGrid::CopyStructure ( vtkDataSet * ds )

overridevirtual

Copy the geometric and topological structure of an input poly data object.

Implements vtkDataSet.

◆ ShallowCopy()

void vtkExplicitStructuredGrid::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

◆ DeepCopy()

void vtkExplicitStructuredGrid::DeepCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

◆ GetDataDimension()

int vtkExplicitStructuredGrid::GetDataDimension ( )

inline

Return the dimensionality of the data.

Definition at line 139 of file vtkExplicitStructuredGrid.h.

◆ SetDimensions() [1/2]

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

Set/Get the dimensions of this structured dataset in term of number of points along each direction.

This is just a convenience method which calls Set/GetExtent internally.

◆ SetDimensions() [2/2]

void vtkExplicitStructuredGrid::SetDimensions ( int dim[3] )

Set/Get the dimensions of this structured dataset in term of number of points along each direction.

This is just a convenience method which calls Set/GetExtent internally.

◆ GetDimensions()

void vtkExplicitStructuredGrid::GetDimensions ( int dim[3] )

inline

Set/Get the dimensions of this structured dataset in term of number of points along each direction.

This is just a convenience method which calls Set/GetExtent internally.

Definition at line 411 of file vtkExplicitStructuredGrid.h.

◆ GetCellDims()

void vtkExplicitStructuredGrid::GetCellDims ( int cellDims[3] )

inline

Computes the cell dimensions according to internal point dimensions.

The total number of cells can be achieved simply by cellDims[0] * cellDims[1] * cellDims[2].

Definition at line 417 of file vtkExplicitStructuredGrid.h.

◆ GetExtentType()

int vtkExplicitStructuredGrid::GetExtentType ( )

inlineoverridevirtual

The extent type is a 3D extent.

Reimplemented from vtkDataObject.

Definition at line 162 of file vtkExplicitStructuredGrid.h.

◆ SetExtent() [1/2]

void vtkExplicitStructuredGrid::SetExtent	(	int	x0,
		int	x1,
		int	y0,
		int	y1,
		int	z0,
		int	z1
	)

Set/Get the extent of this structured dataset in term of number of points along each direction.

Setting the extent will reset the internal CellArray and Links and a correctly sized cell array will be created. The Extent is stored in the order (X, Y, Z).

◆ SetExtent() [2/2]

void vtkExplicitStructuredGrid::SetExtent ( int extent[6] )

Set/Get the extent of this structured dataset in term of number of points along each direction.

Setting the extent will reset the internal CellArray and Links and a correctly sized cell array will be created. The Extent is stored in the order (X, Y, Z).

◆ GetExtent() [1/3]

virtual int * vtkExplicitStructuredGrid::GetExtent ( )

virtual

Set/Get the extent of this structured dataset in term of number of points along each direction.

Setting the extent will reset the internal CellArray and Links and a correctly sized cell array will be created. The Extent is stored in the order (X, Y, Z).

◆ GetExtent() [2/3]

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

virtual

Set/Get the extent of this structured dataset in term of number of points along each direction.

Setting the extent will reset the internal CellArray and Links and a correctly sized cell array will be created. The Extent is stored in the order (X, Y, Z).

◆ GetExtent() [3/3]

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

virtual

Set/Get the extent of this structured dataset in term of number of points along each direction.

Setting the extent will reset the internal CellArray and Links and a correctly sized cell array will be created. The Extent is stored in the order (X, Y, Z).

◆ vtkSetSmartPointerMacro() [1/2]

vtkExplicitStructuredGrid::vtkSetSmartPointerMacro	(	Cells	,
		vtkCellArray
	)

Set/Get the cell array defining hexahedron.

◆ vtkGetSmartPointerMacro() [1/2]

vtkExplicitStructuredGrid::vtkGetSmartPointerMacro	(	Cells	,
		vtkCellArray
	)

Set/Get the cell array defining hexahedron.

◆ BuildLinks()

void vtkExplicitStructuredGrid::BuildLinks ( )

Build topological links from points to lists of cells that use each point.

See vtkAbstractCellLinks for more information.

◆ vtkSetSmartPointerMacro() [2/2]

vtkExplicitStructuredGrid::vtkSetSmartPointerMacro	(	Links	,
		vtkAbstractCellLinks
	)

Set/Get the links that you created possibly without using BuildLinks.

◆ vtkGetSmartPointerMacro() [2/2]

vtkExplicitStructuredGrid::vtkGetSmartPointerMacro	(	Links	,
		vtkAbstractCellLinks
	)

Set/Get the links that you created possibly without using BuildLinks.

◆ GetCellPoints() [2/4]

vtkIdType * vtkExplicitStructuredGrid::GetCellPoints ( vtkIdType cellId )

Get direct raw pointer to the 8 points indices of an hexahedra.

Note: This method MAY NOT be thread-safe. (See GetCellAtId at vtkCellArray)

◆ GetCellPoints() [3/4]

void vtkExplicitStructuredGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdType &	npts,
		vtkIdType *&	pts
	)

More efficient method to obtain cell points.

Note: This method MAY NOT be thread-safe. (See GetCellAtId at vtkCellArray)

◆ GetCellPoints() [4/4]

void vtkExplicitStructuredGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdType &	npts,
		vtkIdType const *&	pts,
		vtkIdList *	ptIds
	)

overridevirtual

More efficient method to obtain cell points.

This function MAY use ptIds, which is an object that is created by each thread, to guarantee thread safety.

Note: This method is thread-safe. (See GetCellAtId at vtkCellArray)

Reimplemented from vtkDataSet.

◆ GetCellNeighbors() [2/2]

void vtkExplicitStructuredGrid::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdType	neighbors[6],
		int *	wholeExtent = `nullptr`
	)

Get cell neighbors of the cell for every faces.

◆ ComputeCellStructuredCoords()

void vtkExplicitStructuredGrid::ComputeCellStructuredCoords	(	vtkIdType	cellId,
		int &	i,
		int &	j,
		int &	k,
		bool	adjustForExtent = `true`
	)

inline

Given a cellId, get the structured coordinates (i-j-k).

If adjustForExtent is true, (i,j,k) is computed as a position relative to the beginning of the extent. If adjustForExtent is false, (i,j,k) is computed regardless of the extent beginning. The default adjustForExtent is true.

Definition at line 423 of file vtkExplicitStructuredGrid.h.

◆ ComputeCellId()

vtkIdType vtkExplicitStructuredGrid::ComputeCellId	(	int	i,
		int	j,
		int	k,
		bool	adjustForExtent = `true`
	)

inline

Given a location in structured coordinates (i-j-k), return the cell id.

If adjustForExtent is true, (i,j,k) is interpreted as a position relative to the beginning of the extent. If adjustForExtent is false, (i,j,k) is interpreted literally and the cell id is returned regardless of the extent beginning. The default adjustForExtent is true.

Definition at line 443 of file vtkExplicitStructuredGrid.h.

◆ ComputeFacesConnectivityFlagsArray()

void vtkExplicitStructuredGrid::ComputeFacesConnectivityFlagsArray ( )

Compute the faces connectivity flags array.

This method should be called after the construction if the ESG is to be used by other filters.

◆ SetFacesConnectivityFlagsArrayName()

virtual void vtkExplicitStructuredGrid::SetFacesConnectivityFlagsArrayName ( const char * )

virtual

Set/Get the name of the faces connectivity flags array.

◆ GetFacesConnectivityFlagsArrayName()

virtual char * vtkExplicitStructuredGrid::GetFacesConnectivityFlagsArrayName ( )

virtual

Set/Get the name of the faces connectivity flags array.

◆ BlankCell()

void vtkExplicitStructuredGrid::BlankCell ( vtkIdType cellId )

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankCell()

void vtkExplicitStructuredGrid::UnBlankCell ( vtkIdType cellId )

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ HasAnyBlankCells()

bool vtkExplicitStructuredGrid::HasAnyBlankCells ( )

overridevirtual

Returns true if one or more cells are blanked, false otherwise.

Reimplemented from vtkDataSet.

◆ IsCellVisible()

unsigned char vtkExplicitStructuredGrid::IsCellVisible ( vtkIdType cellId )

Return non-zero value if specified cell is visible.

These methods should be called only after the dimensions of the grid are set.

◆ IsCellGhost()

unsigned char vtkExplicitStructuredGrid::IsCellGhost ( vtkIdType cellId )

Return non-zero value if specified cell is a ghost cell.

These methods should be called only after the dimensions of the grid are set.

◆ HasAnyGhostCells()

bool vtkExplicitStructuredGrid::HasAnyGhostCells ( )

Returns true if one or more cells are ghost, false otherwise.

◆ Crop() [1/2]

void vtkExplicitStructuredGrid::Crop ( const int * updateExtent )

overridevirtual

Reallocates and copies to set the Extent to the UpdateExtent.

This is used internally when the exact extent is requested, and the source generated more than the update extent.

Reimplemented from vtkDataObject.

◆ Crop() [2/2]

virtual void vtkExplicitStructuredGrid::Crop	(	vtkExplicitStructuredGrid *	input,
		const int *	updateExtent,
		bool	generateOriginalCellIds
	)

virtual

Reallocates and copies to set the Extent to the UpdateExtent.

This is used internally when the exact extent is requested, and the source generated more than the update extent.

◆ GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetActualMemorySize()

unsigned long vtkExplicitStructuredGrid::GetActualMemorySize ( )

overridevirtual

Return the actual size of the data in kilobytes.

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.

◆ CheckAndReorderFaces()

void vtkExplicitStructuredGrid::CheckAndReorderFaces ( )

Check faces are numbered correctly regarding ijk numbering If not this will reorganize cell points order so face order is valid.

This is made in two pass, first it check that faces are on the correct axis and corrects it Then it check if faces are mirrored and corrects it. Make sure cells and extent have been set before calling this method and recompute face connectivity afterwards.

◆ GenerateGhostArray() [1/3]

void vtkExplicitStructuredGrid::GenerateGhostArray	(	int	zeroExt[6],
		bool	cellOnly
	)

overridevirtual

Normally called by pipeline executives or algorithms only.

This method computes the ghost arrays for a given dataset. The zeroExt argument specifies the extent of the region which ghost type = 0.

Reimplemented from vtkDataSet.

◆ ReportReferences()

void vtkExplicitStructuredGrid::ReportReferences ( vtkGarbageCollector * )

overrideprotectedvirtual

Reimplemented from vtkObjectBase.

◆ ComputeScalarRange()

void vtkExplicitStructuredGrid::ComputeScalarRange ( )

overrideprotectedvirtual

Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).

Reimplemented from vtkDataSet.

◆ InternalCopy()

virtual void vtkExplicitStructuredGrid::InternalCopy ( vtkExplicitStructuredGrid * src )

protectedvirtual

Internal method used by DeepCopy and ShallowCopy.

◆ InternalCheckAndReorderFaces()

void vtkExplicitStructuredGrid::InternalCheckAndReorderFaces ( bool swap )

protected

Internal method used by CheckAndReorderFaces.

◆ FindConnectedFaces()

int vtkExplicitStructuredGrid::FindConnectedFaces ( int foundFaces[3] )

protected

Find a connected face for each axis if any.

Return the number of found connected faces

◆ CheckConnectedFaces()

static void vtkExplicitStructuredGrid::CheckConnectedFaces	(	int &	nFoundFaces,
		int	foundFaces[3]
	)

staticprotected

Check a list of connected faces and remove invalid face or extrapolate missing faces.

◆ ComputeSwapFlag()

static void vtkExplicitStructuredGrid::ComputeSwapFlag	(	int	foundFaces[3],
		int	swap[3]
	)

staticprotected

Compute a swap flag based if a face have been found.

◆ ComputeMirrorFlag()

static void vtkExplicitStructuredGrid::ComputeMirrorFlag	(	int	foundFaces[3],
		int	mirror[3]
	)

staticprotected

Compute a mirror flag based if a face have been found.

◆ ReorderCellsPoints()

void vtkExplicitStructuredGrid::ReorderCellsPoints	(	const int *	ptsMap,
		const int	transformFlag[3]
	)

protected

Reorder all cells points based on a transformFlag for each axis and a points map.

◆ GetCell() [3/5]

virtual vtkCell * vtkDataSet::GetCell ( vtkIdType cellId )

virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.

Warning: Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.; THIS METHOD IS NOT THREAD SAFE. For a thread-safe version, please use void GetCell(vtkIdType cellId, vtkGenericCell* cell).

Implements vtkDataSet.

◆ GetCell() [4/5]

virtual vtkCell * vtkDataSet::GetCell	(	int	vtkNotUsedi,
		int	vtkNotUsedj,
		int	vtkNotUsedk
	)

inlinevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 239 of file vtkDataSet.h.

◆ GetCell() [5/5]

virtual void vtkDataSet::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)

virtual

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.

◆ GenerateGhostArray() [2/3]

virtual void vtkDataSet::GenerateGhostArray ( int zeroExt[6] )

inlinevirtual

Normally called by pipeline executives or algorithms only.

This method computes the ghost arrays for a given dataset. The zeroExt argument specifies the extent of the region which ghost type = 0.

Reimplemented from vtkDataSet.

Definition at line 563 of file vtkDataSet.h.

◆ GenerateGhostArray() [3/3]

virtual void vtkDataSet::GenerateGhostArray	(	int	zeroExt[6],
		bool	cellOnly
	)

virtual

Normally called by pipeline executives or algorithms only.

This method computes the ghost arrays for a given dataset. The zeroExt argument specifies the extent of the region which ghost type = 0.

Reimplemented from vtkDataSet.

Member Data Documentation

◆ Cells

vtkSmartPointer<vtkCellArray> vtkExplicitStructuredGrid::Cells

protected

Definition at line 400 of file vtkExplicitStructuredGrid.h.

◆ Links

vtkSmartPointer<vtkAbstractCellLinks> vtkExplicitStructuredGrid::Links

protected

Definition at line 401 of file vtkExplicitStructuredGrid.h.

◆ Extent

int vtkExplicitStructuredGrid::Extent[6]

protected

Definition at line 402 of file vtkExplicitStructuredGrid.h.

◆ FacesConnectivityFlagsArrayName

char* vtkExplicitStructuredGrid::FacesConnectivityFlagsArrayName

protected

Definition at line 403 of file vtkExplicitStructuredGrid.h.

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

Common/DataModel/vtkExplicitStructuredGrid.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkExplicitStructuredGrid()

◆ ~vtkExplicitStructuredGrid()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetDataObjectType()

◆ Initialize()

◆ GetCell() [1/5]

◆ GetCell() [2/5]

◆ GetCellBounds()

◆ GetCellType()

◆ GetCellSize()

◆ GetNumberOfCells()

◆ GetCellPoints() [1/4]

◆ GetPointCells()

◆ GetMaxCellSize()

◆ GetMaxSpatialDimension()

◆ GetCellNeighbors() [1/2]

◆ CopyStructure()

◆ ShallowCopy()

◆ DeepCopy()

◆ GetDataDimension()

◆ SetDimensions() [1/2]

◆ SetDimensions() [2/2]

◆ GetDimensions()

◆ GetCellDims()

◆ GetExtentType()

◆ SetExtent() [1/2]

◆ SetExtent() [2/2]

◆ GetExtent() [1/3]

◆ GetExtent() [2/3]

◆ GetExtent() [3/3]

◆ vtkSetSmartPointerMacro() [1/2]

◆ vtkGetSmartPointerMacro() [1/2]

◆ BuildLinks()

◆ vtkSetSmartPointerMacro() [2/2]

◆ vtkGetSmartPointerMacro() [2/2]

◆ GetCellPoints() [2/4]

◆ GetCellPoints() [3/4]

◆ GetCellPoints() [4/4]

◆ GetCellNeighbors() [2/2]

◆ ComputeCellStructuredCoords()

◆ ComputeCellId()

◆ ComputeFacesConnectivityFlagsArray()

◆ SetFacesConnectivityFlagsArrayName()

◆ GetFacesConnectivityFlagsArrayName()

◆ BlankCell()

◆ UnBlankCell()

◆ HasAnyBlankCells()

◆ IsCellVisible()

◆ IsCellGhost()

◆ HasAnyGhostCells()

◆ Crop() [1/2]

◆ Crop() [2/2]

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetActualMemorySize()

◆ CheckAndReorderFaces()

◆ GenerateGhostArray() [1/3]

◆ ReportReferences()

◆ ComputeScalarRange()

◆ InternalCopy()

◆ InternalCheckAndReorderFaces()

◆ FindConnectedFaces()

◆ CheckConnectedFaces()