VTK
9.3.20240831
|
topologically regular array of data More...
#include <vtkStructuredGrid.h>
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for type information and printing. | |
vtkStructuredGrid * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for type information and printing. | |
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. | |
void | Initialize () override |
Restore object to initial state. | |
vtkStructuredCellArray * | GetCells () |
Return the structured grid connectivity array. | |
vtkConstantArray< int > * | GetCellTypesArray () |
Get the array of all cell types in the structured grid. | |
unsigned char | IsPointVisible (vtkIdType ptId) |
Return non-zero value if specified point is visible. | |
unsigned char | IsCellVisible (vtkIdType cellId) |
Return non-zero value if specified point is visible. | |
bool | HasAnyBlankPoints () override |
Returns 1 if there is any visibility constraint on the points, 0 otherwise. | |
bool | HasAnyBlankCells () override |
Returns 1 if there is any visibility constraint on the cells, 0 otherwise. | |
virtual int | GetDataDescription () |
Get the data description of the structured grid. | |
void | GetCellDims (int cellDims[3]) |
Given the node dimensions of this grid instance, this method computes the node dimensions. | |
int | GetDataDimension () |
Return the dimensionality of the data. | |
unsigned long | GetActualMemorySize () override |
Return the actual size of the data in kibibytes (1024 bytes). | |
int | GetExtentType () override |
The extent type is a 3D extent. | |
void | Crop (const int *updateExtent) override |
Reallocates and copies to set the Extent to the UpdateExtent. | |
void | GetPoint (int i, int j, int k, double p[3], bool adjustForExtent=true) |
Get a point in the grid. | |
vtkIdType | GetNumberOfCells () override |
Standard vtkDataSet API methods. | |
vtkIdType | GetNumberOfPoints () override |
Standard vtkDataSet API methods. | |
double * | GetPoint (vtkIdType ptId) override |
Standard vtkDataSet API methods. | |
void | GetPoint (vtkIdType ptId, double p[3]) override |
Standard vtkDataSet API methods. | |
vtkCell * | GetCell (vtkIdType cellId) override |
Standard vtkDataSet API methods. | |
vtkCell * | GetCell (int i, int j, int k) 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. | |
void | GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts, vtkIdList *ptIds) 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. | |
void | GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int *seedLoc) |
Standard vtkDataSet API methods. | |
void | BlankPoint (vtkIdType ptId) |
Methods for supporting blanking of cells. | |
void | UnBlankPoint (vtkIdType ptId) |
Methods for supporting blanking of cells. | |
void | BlankCell (vtkIdType ptId) |
Methods for supporting blanking of cells. | |
void | UnBlankCell (vtkIdType ptId) |
Methods for supporting blanking of cells. | |
void | SetDimensions (int i, int j, int k) |
Sets the extent to be 0 to i-1, 0 to j-1, and 0 to k-1. | |
void | SetDimensions (const int dims[3]) |
Sets the extent to be 0 to dim[i]-1 in all 3 dimensions. | |
virtual int * | GetDimensions () |
Get dimensions of this structured grid. | |
virtual void | GetDimensions (int dims[3]) |
Get dimensions of this structured grid based on its extent. | |
void | SetExtent (VTK_FUTURE_CONST int extent[6]) |
Different ways to set the extent of the data array. | |
void | SetExtent (int xMin, int xMax, int yMin, int yMax, int zMin, int zMax) |
Different ways to set the extent of the data array. | |
virtual int * | GetExtent () |
Different ways to set the extent of the data array. | |
virtual void | GetExtent (int &, int &, int &, int &, int &, int &) |
Different ways to set the extent of the data array. | |
virtual void | GetExtent (int[6]) |
Different ways to set the extent of the data array. | |
void | ShallowCopy (vtkDataObject *src) override |
Shallow and Deep copy. | |
void | DeepCopy (vtkDataObject *src) override |
Shallow and Deep copy. | |
![]() | |
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 | 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. | |
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. | |
bool | UsesGarbageCollector () const override |
Overwritten to handle the data/locator loop. | |
vtkPointSet * | NewInstance () const |
Standard methods for type information and printing. | |
![]() | |
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.). | |
virtual vtkMTimeType | GetMeshMTime () |
Abstract method which return the mesh (geometry/topology) modification time. | |
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. | |
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. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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 vtkStructuredGrid * | New () |
static vtkStructuredGrid * | ExtendedNew () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkStructuredGrid * | SafeDownCast (vtkObjectBase *o) |
static vtkStructuredGrid * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. | |
static vtkStructuredGrid * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. | |
![]() | |
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 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 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 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 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 | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for type information and printing. | |
vtkStructuredGrid () | |
~vtkStructuredGrid () override | |
void | ComputeScalarRange () override |
Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). | |
void | BuildImplicitStructures () |
void | BuildCells () |
void | BuildCellTypes () |
![]() | |
vtkPointSet () | |
~vtkPointSet () override | |
void | ReportReferences (vtkGarbageCollector *) override |
![]() | |
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). | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkDataObject () | |
~vtkDataObject () override | |
![]() | |
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. | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
int | Dimensions [3] |
int | DataDescription |
int | Extent [6] |
vtkSmartPointer< vtkStructuredCellArray > | StructuredCells |
vtkSmartPointer< vtkConstantArray< int > > | StructuredCellTypes |
![]() | |
bool | Editable |
vtkPoints * | Points |
vtkAbstractPointLocator * | PointLocator |
vtkAbstractCellLocator * | CellLocator |
![]() | |
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)) | |
![]() | |
vtkFieldData * | FieldData |
vtkTypeBool | DataReleased |
vtkTimeStamp | UpdateTime |
vtkInformation * | Information |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
topologically regular array of data
vtkStructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkStructuredGrid represents a geometric structure that is a topologically regular array of points. The topology is that of a cube that has been subdivided into a regular array of smaller cubes. Each point/cell can be addressed with i-j-k indices. Examples include finite difference grids.
The order and number of points must match that specified by the dimensions of the grid. The point order increases in i fastest (from 0<=i<dims[0]), then j (0<=j<dims[1]), then k (0<=k<dims[2]) where dims[] are the dimensions of the grid in the i-j-k topological directions. The number of points is dims[0]*dims[1]*dims[2]. The same is true for the cells of the grid. The order and number of cells must match that specified by the dimensions of the grid. The cell order increases in i fastest (from 0<=i<(dims[0]-1)), then j (0<=j<(dims[1]-1)), then k (0<=k<(dims[2]-1)) The number of cells is (dims[0]-1)*(dims[1]-1)*(dims[2]-1).
vtkStructuredGrid has the ability to blank, or "turn-off" points and cells in the dataset. This is done by setting vtkDataSetAttributes::HIDDENPOINT or vtkDataSetAttributes::HIDDENCELL in the ghost array for each point / cell that needs to be blanked.
Definition at line 162 of file vtkStructuredGrid.h.
Definition at line 168 of file vtkStructuredGrid.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
static |
|
virtual |
Standard methods for type information and printing.
Reimplemented from vtkPointSet.
|
static |
|
protectedvirtual |
Standard methods for type information and printing.
Reimplemented from vtkPointSet.
vtkStructuredGrid * vtkStructuredGrid::NewInstance | ( | ) | const |
|
overridevirtual |
Standard methods for type information and printing.
Reimplemented from vtkPointSet.
|
inlineoverridevirtual |
Return what type of dataset this is.
Reimplemented from vtkPointSet.
Definition at line 174 of file vtkStructuredGrid.h.
|
overridevirtual |
Copy the geometric and topological structure of an input poly data object.
Reimplemented from vtkPointSet.
|
overridevirtual |
|
inlineoverridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 421 of file vtkStructuredGrid.h.
|
inlineoverridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 191 of file vtkStructuredGrid.h.
|
inlineoverridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 192 of file vtkStructuredGrid.h.
|
inlineoverridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 196 of file vtkStructuredGrid.h.
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
|
override |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
|
overridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
|
overridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkDataSet.
|
overridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
|
overridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 206 of file vtkStructuredGrid.h.
|
inlineoverridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 212 of file vtkStructuredGrid.h.
|
inlineoverridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkDataSet.
Definition at line 426 of file vtkStructuredGrid.h.
|
overridevirtual |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
Reimplemented from vtkDataSet.
void vtkStructuredGrid::GetCellNeighbors | ( | vtkIdType | cellId, |
vtkIdList * | ptIds, | ||
vtkIdList * | cellIds, | ||
int * | seedLoc | ||
) |
Standard vtkDataSet API methods.
See vtkDataSet for more information.
vtkStructuredCellArray * vtkStructuredGrid::GetCells | ( | ) |
Return the structured grid connectivity array.
NOTE: the returned object should not be modified.
vtkConstantArray< int > * vtkStructuredGrid::GetCellTypesArray | ( | ) |
Get the array of all cell types in the structured grid.
Each single-component integer value is the same. The array is of size GetNumberOfCells().
NOTE: the returned object should not be modified.
void vtkStructuredGrid::BlankPoint | ( | vtkIdType | ptId | ) |
Methods for supporting blanking of cells.
Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.
void vtkStructuredGrid::UnBlankPoint | ( | vtkIdType | ptId | ) |
Methods for supporting blanking of cells.
Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.
void vtkStructuredGrid::BlankCell | ( | vtkIdType | ptId | ) |
Methods for supporting blanking of cells.
Blanking turns on or off cells in the structured grid, and hence the points connected to them. These methods should be called only after the dimensions of the grid are set.
void vtkStructuredGrid::UnBlankCell | ( | vtkIdType | ptId | ) |
Methods for supporting blanking of cells.
Blanking turns on or off cells in the structured grid, and hence the points connected to them. These methods should be called only after the dimensions of the grid are set.
unsigned char vtkStructuredGrid::IsPointVisible | ( | vtkIdType | ptId | ) |
Return non-zero value if specified point is visible.
These methods should be called only after the dimensions of the grid are set.
unsigned char vtkStructuredGrid::IsCellVisible | ( | vtkIdType | cellId | ) |
Return non-zero value if specified point is visible.
These methods should be called only after the dimensions of the grid are set.
|
overridevirtual |
Returns 1 if there is any visibility constraint on the points, 0 otherwise.
Reimplemented from vtkDataSet.
|
overridevirtual |
Returns 1 if there is any visibility constraint on the cells, 0 otherwise.
Reimplemented from vtkDataSet.
|
virtual |
Get the data description of the structured grid.
void vtkStructuredGrid::GetCellDims | ( | int | cellDims[3] | ) |
Given the node dimensions of this grid instance, this method computes the node dimensions.
The value in each dimension can will have a lowest value of "1" such that computing the total number of cells can be achieved by simply by cellDims[0]*cellDims[1]*cellDims[2].
void vtkStructuredGrid::SetDimensions | ( | int | i, |
int | j, | ||
int | k | ||
) |
Sets the extent to be 0 to i-1, 0 to j-1, and 0 to k-1.
void vtkStructuredGrid::SetDimensions | ( | const int | dims[3] | ) |
Sets the extent to be 0 to dim[i]-1 in all 3 dimensions.
|
virtual |
Get dimensions of this structured grid.
|
virtual |
Get dimensions of this structured grid based on its extent.
|
inline |
Return the dimensionality of the data.
Definition at line 415 of file vtkStructuredGrid.h.
void vtkStructuredGrid::SetExtent | ( | VTK_FUTURE_CONST int | extent[6] | ) |
Different ways to set the extent of the data array.
The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
void vtkStructuredGrid::SetExtent | ( | int | xMin, |
int | xMax, | ||
int | yMin, | ||
int | yMax, | ||
int | zMin, | ||
int | zMax | ||
) |
Different ways to set the extent of the data array.
The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
|
virtual |
Different ways to set the extent of the data array.
The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
|
virtual |
Different ways to set the extent of the data array.
The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
|
virtual |
Different ways to set the extent of the data array.
The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).
|
overridevirtual |
Return the actual size of the data in kibibytes (1024 bytes).
This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.
Reimplemented from vtkPointSet.
|
overridevirtual |
Shallow and Deep copy.
Reimplemented from vtkPointSet.
|
overridevirtual |
Shallow and Deep copy.
Reimplemented from vtkPointSet.
|
inlineoverridevirtual |
The extent type is a 3D extent.
Reimplemented from vtkDataObject.
Definition at line 355 of file vtkStructuredGrid.h.
|
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.
|
static |
Retrieve an instance of this class from an information object.
|
static |
Retrieve an instance of this class from an information object.
void vtkStructuredGrid::GetPoint | ( | int | i, |
int | j, | ||
int | k, | ||
double | p[3], | ||
bool | adjustForExtent = true |
||
) |
Get a point in the grid.
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 (i,j,k) point of the grid is returned regardless of the extent beginning. The point coordinate is returned in 'p'. The default adjustForExtent is true.
|
overrideprotectedvirtual |
Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).
Reimplemented from vtkDataSet.
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 387 of file vtkStructuredGrid.h.
|
protected |
Definition at line 389 of file vtkStructuredGrid.h.
|
protected |
Definition at line 391 of file vtkStructuredGrid.h.
|
protected |
Definition at line 393 of file vtkStructuredGrid.h.
|
protected |
Definition at line 394 of file vtkStructuredGrid.h.