VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkExplicitStructuredGrid Class Reference

structured grid with explicit topology and geometry More...

#include <vtkExplicitStructuredGrid.h>

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

Public Types

typedef vtkPointSet Superclass
 
- Public Types inherited from vtkPointSet
typedef vtkDataSet Superclass
 
- Public Types inherited from vtkDataSet
enum  FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }
 
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkExplicitStructuredGridNewInstance () 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 (vtkDataSet *ds) override
 Copy the geometric and topological structure of an input poly data object. More...
 
int GetDataDimension ()
 Return the dimensionality of the data. More...
 
void GetCellDims (int cellDims[3])
 Computes the cell dimensions according to internal point dimensions. More...
 
int GetExtentType () override
 The extent type is a 3D extent. More...
 
vtkIdTypeGetCellPoints (vtkIdType cellId)
 Get direct raw pointer to the 8 points indices of an hexahedra. More...
 
void GetCellNeighbors (vtkIdType cellId, vtkIdType neighbors[6], int *wholeExtent=nullptr)
 Get cell neighbors of the cell for every faces. More...
 
void ComputeCellStructuredCoords (vtkIdType cellId, int &i, int &j, int &k, bool adjustForExtent=true)
 Given a cellId, get the structured coordinates (i-j-k). More...
 
vtkIdType ComputeCellId (int i, int j, int k, bool adjustForExtent=true)
 Given a location in structured coordinates (i-j-k), return the cell id. More...
 
void ComputeFacesConnectivityFlagsArray ()
 Compute the faces connectivity flags array. More...
 
bool HasAnyBlankCells () override
 Returns true if one or more cells are blanked, false otherwise. More...
 
unsigned char IsCellVisible (vtkIdType cellId)
 Return non-zero value if specified cell is visible. More...
 
unsigned char IsCellGhost (vtkIdType cellId)
 Return non-zero value if specified cell is a ghost cell. More...
 
bool HasAnyGhostCells ()
 Returns true if one or more cells are ghost, false otherwise. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kilobytes. More...
 
void CheckAndReorderFaces ()
 Check faces are numbered correctly regarding ijk numbering If not this will reorganize cell points order so face order is valid. More...
 
void Initialize () override
 Standard vtkDataSet API methods. More...
 
vtkCellGetCell (vtkIdType cellId) override
 Standard vtkDataSet API methods. More...
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell) override
 Standard vtkDataSet API methods. More...
 
void GetCellBounds (vtkIdType cellId, double bounds[6]) override
 Standard vtkDataSet API methods. More...
 
int GetCellType (vtkIdType cellId) override
 Standard vtkDataSet API methods. More...
 
vtkIdType GetNumberOfCells () override
 Standard vtkDataSet API methods. More...
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
 Standard vtkDataSet API methods. More...
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 Standard vtkDataSet API methods. More...
 
void GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType *&pts)
 Standard vtkDataSet API methods. More...
 
int GetMaxCellSize () override
 Standard vtkDataSet API methods. More...
 
void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) override
 Standard vtkDataSet API methods. More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
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. More...
 
void SetDimensions (int dim[3])
 Set/Get the dimensions of this structured dataset in term of number of points along each direction. More...
 
void GetDimensions (int dim[3])
 Set/Get the dimensions of this structured dataset in term of number of points along each direction. More...
 
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. More...
 
void SetExtent (int extent[6])
 Set/Get the extent of this structured dataset in term of number of points along each direction. More...
 
virtual intGetExtent ()
 Set/Get the extent of this structured dataset in term of number of points along each direction. More...
 
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. More...
 
virtual void GetExtent (int[6])
 Set/Get the extent of this structured dataset in term of number of points along each direction. More...
 
void SetCells (vtkCellArray *cells)
 Set/Get the cell array defining hexahedron. More...
 
virtual vtkCellArrayGetCells ()
 Set/Get the cell array defining hexahedron. More...
 
void BuildLinks ()
 Create/Get upward links from points to cells that use each point. More...
 
virtual vtkCellLinksGetLinks ()
 Create/Get upward links from points to cells that use each point. More...
 
virtual void SetFacesConnectivityFlagsArrayName (const char *)
 Set/Get the name of the faces connectivity flags array. More...
 
virtual char * GetFacesConnectivityFlagsArrayName ()
 Set/Get the name of the faces connectivity flags array. More...
 
void BlankCell (vtkIdType cellId)
 Methods for supporting blanking of cells. More...
 
void UnBlankCell (vtkIdType cellId)
 Methods for supporting blanking of cells. More...
 
void Crop (const int *updateExtent) override
 Reallocates and copies to set the Extent to the UpdateExtent. More...
 
virtual void Crop (const int *updateExtent, bool generateOriginalCellIds)
 Reallocates and copies to set the Extent to the UpdateExtent. More...
 
void GenerateGhostArray (int zeroExt[6], bool cellOnly) override
 Normally called by pipeline executives or algorithms only. More...
 
- Public Member Functions inherited from vtkPointSet
vtkPointSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize () override
 Reset to an empty state and free any memory. More...
 
void CopyStructure (vtkDataSet *pd) override
 Copy the geometric structure of an input point set object. More...
 
doubleGetPoint (vtkIdType ptId) override
 See vtkDataSet for additional information. More...
 
vtkCellIteratorNewCellIterator () override
 Return an iterator that traverses the cells in this data set. More...
 
vtkMTimeType GetMTime () override
 Get MTime which also considers its vtkPoints MTime. More...
 
void ComputeBounds () override
 Compute the (X, Y, Z) bounds of the data. More...
 
void Squeeze () override
 Reclaim any unused memory. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
vtkIdType GetNumberOfPoints () override
 See vtkDataSet for additional information. More...
 
void GetPoint (vtkIdType ptId, double x[3]) override
 See vtkDataSet for additional information. More...
 
vtkIdType FindPoint (double x[3]) override
 See vtkDataSet for additional information. More...
 
vtkIdType FindPoint (double x, double y, double z)
 See vtkDataSet for additional information. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 See vtkDataSet for additional information. More...
 
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. More...
 
virtual void SetPoints (vtkPoints *)
 Specify point array to define point coordinates. More...
 
virtual vtkPointsGetPoints ()
 Specify point array to define point coordinates. More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void Register (vtkObjectBase *o) override
 Overwritten to handle the data/locator loop. More...
 
void UnRegister (vtkObjectBase *o) override
 Overwritten to handle the data/locator loop. More...
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset. More...
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 Locate the cell that contains a point and return the cell. More...
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data. More...
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data. More...
 
doubleGetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
doubleGetCenter ()
 Get the center of the bounding box. More...
 
void GetCenter (double center[3])
 Get the center of the bounding box. More...
 
double GetLength ()
 Return the length of the diagonal of the bounding box. More...
 
virtual void GetScalarRange (double range[2])
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
doubleGetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. More...
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise. More...
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise. More...
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise. More...
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point. More...
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array. More...
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points. More...
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell. More...
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array. More...
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells. More...
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x. More...
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
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 vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
virtual vtkInformationGetInformation ()
 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 int 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 vtkFieldDataGetFieldData ()
 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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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...
 
vtkCommandGetCommand (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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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...
 

Static Public Member Functions

static vtkExplicitStructuredGridNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExplicitStructuredGridSafeDownCast (vtkObjectBase *o)
 
static vtkExplicitStructuredGridGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkExplicitStructuredGridGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
- Static Public Member Functions inherited from vtkPointSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPointSetSafeDownCast (vtkObjectBase *o)
 
static vtkPointSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkPointSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 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 vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 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 int 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExplicitStructuredGrid ()
 
 ~vtkExplicitStructuredGrid () override
 
virtual void ComputeScalarRange () override
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...
 
virtual void InternalCopy (vtkExplicitStructuredGrid *src)
 Internal method used by DeepCopy and ShallowCopy. More...
 
void GetCell (vtkIdType, vtkCell *)
 Internal method used by GetCell. More...
 
void InternalCheckAndReorderFaces (bool swap)
 Internal method used by CheckAndReorderFaces. More...
 
int FindConnectedFaces (int foundFaces[3])
 Find a connected face for each axis if any. More...
 
void ReorderCellsPoints (const int *ptsMap, const int transformFlag[3])
 Reorder all cells points based on a transformFlag for each axis and a points map. More...
 
- Protected Member Functions inherited from vtkPointSet
 vtkPointSet ()
 
 ~vtkPointSet () override
 
void ReportReferences (vtkGarbageCollector *) override
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet () override
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set. More...
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 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. More...
 
static void ComputeSwapFlag (int foundFaces[3], int swap[3])
 Compute a swap flag based if a face have been found. More...
 
static void ComputeMirrorFlag (int foundFaces[3], int mirror[3])
 Compute a mirror flag based if a face have been found. More...
 

Protected Attributes

vtkNew< vtkHexahedronHexahedron
 
vtkNew< vtkEmptyCellEmptyCell
 
vtkCellArrayCells
 
vtkCellLinksLinks
 
int Extent [6]
 
char * FacesConnectivityFlagsArrayName
 
- Protected Attributes inherited from vtkPointSet
vtkPointsPoints
 
vtkPointLocatorLocator
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
vtkUnsignedCharArrayCellGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
bool PointGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
bool CellGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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

Definition at line 62 of file vtkExplicitStructuredGrid.h.

Member Typedef Documentation

Definition at line 66 of file vtkExplicitStructuredGrid.h.

Constructor & Destructor Documentation

vtkExplicitStructuredGrid::vtkExplicitStructuredGrid ( )
protected
vtkExplicitStructuredGrid::~vtkExplicitStructuredGrid ( )
overrideprotected

Member Function Documentation

static vtkExplicitStructuredGrid* vtkExplicitStructuredGrid::New ( )
static
static vtkTypeBool vtkExplicitStructuredGrid::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkExplicitStructuredGrid::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 vtkPointSet.

static vtkExplicitStructuredGrid* vtkExplicitStructuredGrid::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkExplicitStructuredGrid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointSet.

vtkExplicitStructuredGrid* vtkExplicitStructuredGrid::NewInstance ( ) const
void vtkExplicitStructuredGrid::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSet.

int vtkExplicitStructuredGrid::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 72 of file vtkExplicitStructuredGrid.h.

void vtkExplicitStructuredGrid::Initialize ( )
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

vtkCell* vtkExplicitStructuredGrid::GetCell ( vtkIdType  cellId)
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

int vtkExplicitStructuredGrid::GetCellType ( vtkIdType  cellId)
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkExplicitStructuredGrid::GetNumberOfCells ( )
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

int vtkExplicitStructuredGrid::GetMaxCellSize ( )
inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 88 of file vtkExplicitStructuredGrid.h.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

void vtkExplicitStructuredGrid::CopyStructure ( vtkDataSet ds)
overridevirtual

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

Implements vtkDataSet.

void vtkExplicitStructuredGrid::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

void vtkExplicitStructuredGrid::DeepCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

int vtkExplicitStructuredGrid::GetDataDimension ( )
inline

Return the dimensionality of the data.

Definition at line 108 of file vtkExplicitStructuredGrid.h.

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.

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.

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 362 of file vtkExplicitStructuredGrid.h.

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 368 of file vtkExplicitStructuredGrid.h.

int vtkExplicitStructuredGrid::GetExtentType ( )
inlineoverridevirtual

The extent type is a 3D extent.

Reimplemented from vtkDataObject.

Definition at line 131 of file vtkExplicitStructuredGrid.h.

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

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

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

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

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

void vtkExplicitStructuredGrid::SetCells ( vtkCellArray cells)

Set/Get the cell array defining hexahedron.

virtual vtkCellArray* vtkExplicitStructuredGrid::GetCells ( )
virtual

Set/Get the cell array defining hexahedron.

void vtkExplicitStructuredGrid::BuildLinks ( )

Create/Get upward links from points to cells that use each point.

Enables topologically complex queries.

virtual vtkCellLinks* vtkExplicitStructuredGrid::GetLinks ( )
virtual

Create/Get upward links from points to cells that use each point.

Enables topologically complex queries.

vtkIdType* vtkExplicitStructuredGrid::GetCellPoints ( vtkIdType  cellId)

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

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

Get cell neighbors of the cell for every faces.

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 374 of file vtkExplicitStructuredGrid.h.

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 397 of file vtkExplicitStructuredGrid.h.

void vtkExplicitStructuredGrid::ComputeFacesConnectivityFlagsArray ( )

Compute the faces connectivity flags array.

virtual void vtkExplicitStructuredGrid::SetFacesConnectivityFlagsArrayName ( const char *  )
virtual

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

virtual char* vtkExplicitStructuredGrid::GetFacesConnectivityFlagsArrayName ( )
virtual

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

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.

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.

bool vtkExplicitStructuredGrid::HasAnyBlankCells ( )
overridevirtual

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

Reimplemented from vtkDataSet.

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.

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.

bool vtkExplicitStructuredGrid::HasAnyGhostCells ( )

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

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.

virtual void vtkExplicitStructuredGrid::Crop ( 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.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

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.

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.

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.

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

virtual void vtkExplicitStructuredGrid::InternalCopy ( vtkExplicitStructuredGrid src)
protectedvirtual

Internal method used by DeepCopy and ShallowCopy.

void vtkExplicitStructuredGrid::GetCell ( vtkIdType  ,
vtkCell  
)
protected

Internal method used by GetCell.

void vtkExplicitStructuredGrid::InternalCheckAndReorderFaces ( bool  swap)
protected

Internal method used by CheckAndReorderFaces.

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

Find a connected face for each axis if any.

Return the number of found connected faces

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

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

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

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

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

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

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.

Member Data Documentation

vtkNew<vtkHexahedron> vtkExplicitStructuredGrid::Hexahedron
protected

Definition at line 348 of file vtkExplicitStructuredGrid.h.

vtkNew<vtkEmptyCell> vtkExplicitStructuredGrid::EmptyCell
protected

Definition at line 349 of file vtkExplicitStructuredGrid.h.

vtkCellArray* vtkExplicitStructuredGrid::Cells
protected

Definition at line 351 of file vtkExplicitStructuredGrid.h.

vtkCellLinks* vtkExplicitStructuredGrid::Links
protected

Definition at line 352 of file vtkExplicitStructuredGrid.h.

int vtkExplicitStructuredGrid::Extent[6]
protected

Definition at line 353 of file vtkExplicitStructuredGrid.h.

char* vtkExplicitStructuredGrid::FacesConnectivityFlagsArrayName
protected

Definition at line 354 of file vtkExplicitStructuredGrid.h.


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