vtkStructuredGrid Class Reference
#include <vtkStructuredGrid.h>
Detailed Description
topologically regular array of datavtkStructuredGrid 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).
A unusual feature of vtkStructuredGrid is the ability to blank, or "turn-off" points and cells in the dataset. This is controlled by defining a "blanking array" whose values (0,1) specify whether a point should be blanked or not.
- Examples:
- vtkStructuredGrid (Examples)
Definition at line 62 of file vtkStructuredGrid.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkStructuredGrid::vtkStructuredGrid | ( | ) | [protected] |
| vtkStructuredGrid::~vtkStructuredGrid | ( | ) | [protected] |
Member Function Documentation
| static vtkStructuredGrid* vtkStructuredGrid::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObject.
| virtual const char* vtkStructuredGrid::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkPointSet.
| static int vtkStructuredGrid::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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.
| virtual int vtkStructuredGrid::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 vtkStructuredGrid* vtkStructuredGrid::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkPointSet.
| void vtkStructuredGrid::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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 vtkPointSet.
| int vtkStructuredGrid::GetDataObjectType | ( | ) | [inline, virtual] |
Return what type of dataset this is.
Reimplemented from vtkDataSet.
Definition at line 71 of file vtkStructuredGrid.h.
| void vtkStructuredGrid::CopyStructure | ( | vtkDataSet * | ds | ) | [virtual] |
Copy the geometric and topological structure of an input poly data object.
Reimplemented from vtkPointSet.
| vtkIdType vtkStructuredGrid::GetNumberOfPoints | ( | ) | [inline, virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 79 of file vtkStructuredGrid.h.
| double* vtkStructuredGrid::GetPoint | ( | vtkIdType | ptId | ) | [inline, virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 80 of file vtkStructuredGrid.h.
| void vtkStructuredGrid::GetPoint | ( | vtkIdType | ptId, | |
| double | p[3] | |||
| ) | [inline, virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 81 of file vtkStructuredGrid.h.
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
| void vtkStructuredGrid::GetCell | ( | vtkIdType | cellId, | |
| vtkGenericCell * | cell | |||
| ) | [virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
| void vtkStructuredGrid::GetCellBounds | ( | vtkIdType | cellId, | |
| double | bounds[6] | |||
| ) | [virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
| int vtkStructuredGrid::GetCellType | ( | vtkIdType | cellId | ) | [virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
| vtkIdType vtkStructuredGrid::GetNumberOfCells | ( | ) | [inline, virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
Definition at line 254 of file vtkStructuredGrid.h.
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
Definition at line 89 of file vtkStructuredGrid.h.
| void vtkStructuredGrid::Initialize | ( | ) | [virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
| int vtkStructuredGrid::GetMaxCellSize | ( | ) | [inline, virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
Definition at line 94 of file vtkStructuredGrid.h.
| void vtkStructuredGrid::GetCellNeighbors | ( | vtkIdType | cellId, | |
| vtkIdList * | ptIds, | |||
| vtkIdList * | cellIds | |||
| ) | [virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
| virtual void vtkStructuredGrid::GetScalarRange | ( | double | range[2] | ) | [virtual] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
| double* vtkStructuredGrid::GetScalarRange | ( | ) | [inline] |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
Definition at line 98 of file vtkStructuredGrid.h.
| void vtkStructuredGrid::SetDimensions | ( | int | i, | |
| int | j, | |||
| int | k | |||
| ) |
following methods are specific to structured grid
| void vtkStructuredGrid::SetDimensions | ( | int | dim[3] | ) |
following methods are specific to structured grid
| virtual int* vtkStructuredGrid::GetDimensions | ( | ) | [virtual] |
Get dimensions of this structured points dataset.
| virtual void vtkStructuredGrid::GetDimensions | ( | int | dim[3] | ) | [virtual] |
Get dimensions of this structured points dataset.
| int vtkStructuredGrid::GetDataDimension | ( | ) | [inline] |
Return the dimensionality of the data.
Definition at line 276 of file vtkStructuredGrid.h.
| void vtkStructuredGrid::SetExtent | ( | 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 | x1, | |
| int | x2, | |||
| int | y1, | |||
| int | y2, | |||
| int | z1, | |||
| int | z2 | |||
| ) |
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 int* vtkStructuredGrid::GetExtent | ( | ) | [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 void vtkStructuredGrid::GetExtent | ( | int & | , | |
| int & | , | |||
| int & | , | |||
| int & | , | |||
| int & | , | |||
| int & | ||||
| ) | [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 void vtkStructuredGrid::GetExtent | ( | int | [6] | ) | [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).
| unsigned long vtkStructuredGrid::GetActualMemorySize | ( | ) | [virtual] |
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 vtkPointSet.
| void vtkStructuredGrid::ShallowCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkPointSet.
| void vtkStructuredGrid::DeepCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkPointSet.
| int vtkStructuredGrid::GetExtentType | ( | ) | [inline, virtual] |
The extent type is a 3D extent
Reimplemented from vtkDataObject.
Definition at line 139 of file vtkStructuredGrid.h.
| 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 cells 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 cells connected to them. These methods should be called only after the dimensions of the grid are set.
| vtkUnsignedCharArray* vtkStructuredGrid::GetPointVisibilityArray | ( | ) |
Get the array that defines the blanking (visibility) of each point.
| void vtkStructuredGrid::SetPointVisibilityArray | ( | vtkUnsignedCharArray * | pointVisibility | ) |
Set an array that defines the (blanking) visibility of the points in the grid. Make sure that length of the visibility array matches the number of points in the grid.
| vtkUnsignedCharArray* vtkStructuredGrid::GetCellVisibilityArray | ( | ) |
Get the array that defines the blanking (visibility) of each cell.
| void vtkStructuredGrid::SetCellVisibilityArray | ( | vtkUnsignedCharArray * | pointVisibility | ) |
Set an array that defines the (blanking) visibility of the cells in the grid. Make sure that length of the visibility array matches the number of points in the grid.
| 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.
| unsigned char vtkStructuredGrid::GetPointBlanking | ( | ) |
Returns 1 if there is any visibility constraint on the points, 0 otherwise.
| unsigned char vtkStructuredGrid::GetCellBlanking | ( | ) |
Returns 1 if there is any visibility constraint on the cells, 0 otherwise.
| virtual void vtkStructuredGrid::Crop | ( | ) | [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.
Reimplemented from vtkDataObject.
| static vtkStructuredGrid* vtkStructuredGrid::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkPointSet.
| static vtkStructuredGrid* vtkStructuredGrid::GetData | ( | vtkInformationVector * | v, | |
| int | i = 0 | |||
| ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkPointSet.
| 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.
| void vtkStructuredGrid::SetPointVisibility | ( | vtkStructuredVisibilityConstraint * | pointVisibility | ) | [protected] |
| virtual vtkStructuredVisibilityConstraint* vtkStructuredGrid::GetPointVisibility | ( | ) | [protected, virtual] |
| void vtkStructuredGrid::SetCellVisibility | ( | vtkStructuredVisibilityConstraint * | cellVisibility | ) | [protected] |
| virtual vtkStructuredVisibilityConstraint* vtkStructuredGrid::GetCellVisibility | ( | ) | [protected, virtual] |
Member Data Documentation
vtkVertex* vtkStructuredGrid::Vertex [protected] |
Definition at line 217 of file vtkStructuredGrid.h.
vtkLine* vtkStructuredGrid::Line [protected] |
Definition at line 218 of file vtkStructuredGrid.h.
vtkQuad* vtkStructuredGrid::Quad [protected] |
Definition at line 219 of file vtkStructuredGrid.h.
vtkHexahedron* vtkStructuredGrid::Hexahedron [protected] |
Definition at line 220 of file vtkStructuredGrid.h.
vtkEmptyCell* vtkStructuredGrid::EmptyCell [protected] |
Definition at line 221 of file vtkStructuredGrid.h.
int vtkStructuredGrid::Dimensions[3] [protected] |
Definition at line 223 of file vtkStructuredGrid.h.
int vtkStructuredGrid::DataDescription [protected] |
Definition at line 224 of file vtkStructuredGrid.h.
int vtkStructuredGrid::Extent[6] [protected] |
Definition at line 226 of file vtkStructuredGrid.h.
Definition at line 228 of file vtkStructuredGrid.h.
Definition at line 231 of file vtkStructuredGrid.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkStructuredGrid.h
