VTK
|
topologically regular array of data More...
#include <vtkStructuredGrid.h>
Public Types | |
typedef vtkPointSet | Superclass |
![]() | |
typedef vtkDataSet | Superclass |
![]() | |
enum | FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 } |
typedef vtkDataObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
int | GetDataObjectType () |
void | CopyStructure (vtkDataSet *ds) |
int | GetDataDimension () |
unsigned long | GetActualMemorySize () |
int | GetExtentType () |
vtkUnsignedCharArray * | GetPointVisibilityArray () |
void | SetPointVisibilityArray (vtkUnsignedCharArray *pointVisibility) |
vtkUnsignedCharArray * | GetCellVisibilityArray () |
void | SetCellVisibilityArray (vtkUnsignedCharArray *pointVisibility) |
unsigned char | IsPointVisible (vtkIdType ptId) |
unsigned char | IsCellVisible (vtkIdType cellId) |
unsigned char | GetPointBlanking () |
unsigned char | GetCellBlanking () |
virtual void | Crop () |
void | GetPoint (int i, int j, int k, double p[3], bool adjustForExtent=true) |
vtkIdType | GetNumberOfPoints () |
double * | GetPoint (vtkIdType ptId) |
void | GetPoint (vtkIdType ptId, double p[3]) |
vtkCell * | GetCell (vtkIdType cellId) |
void | GetCell (vtkIdType cellId, vtkGenericCell *cell) |
void | GetCellBounds (vtkIdType cellId, double bounds[6]) |
int | GetCellType (vtkIdType cellId) |
vtkIdType | GetNumberOfCells () |
void | GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) |
void | GetPointCells (vtkIdType ptId, vtkIdList *cellIds) |
void | Initialize () |
int | GetMaxCellSize () |
void | GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) |
virtual void | GetScalarRange (double range[2]) |
double * | GetScalarRange () |
void | SetDimensions (int i, int j, int k) |
void | SetDimensions (int dim[3]) |
virtual int * | GetDimensions () |
virtual void | GetDimensions (int dim[3]) |
void | SetExtent (int extent[6]) |
void | SetExtent (int x1, int x2, int y1, int y2, int z1, int z2) |
virtual int * | GetExtent () |
virtual void | GetExtent (int &, int &, int &, int &, int &, int &) |
virtual void | GetExtent (int[6]) |
void | ShallowCopy (vtkDataObject *src) |
void | DeepCopy (vtkDataObject *src) |
void | BlankPoint (vtkIdType ptId) |
void | UnBlankPoint (vtkIdType ptId) |
void | BlankCell (vtkIdType ptId) |
void | UnBlankCell (vtkIdType ptId) |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | Initialize () |
unsigned long | GetMTime () |
void | ComputeBounds () |
void | Squeeze () |
unsigned long | GetActualMemorySize () |
virtual vtkIdType | FindPoint (double x[3]) |
vtkIdType | FindPoint (double x, double y, double z) |
virtual vtkIdType | FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) |
virtual vtkIdType | FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) |
virtual void | SetPoints (vtkPoints *) |
virtual vtkPoints * | GetPoints () |
void | ShallowCopy (vtkDataObject *src) |
void | DeepCopy (vtkDataObject *src) |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | CopyAttributes (vtkDataSet *ds) |
virtual void | GetCellTypes (vtkCellTypes *types) |
unsigned long int | GetMTime () |
vtkCellData * | GetCellData () |
vtkPointData * | GetPointData () |
double * | GetBounds () |
void | GetBounds (double bounds[6]) |
double * | GetCenter () |
void | GetCenter (double center[3]) |
double | GetLength () |
void | Initialize () |
double * | GetScalarRange () |
unsigned long | GetActualMemorySize () |
int | CheckAttributes () |
virtual void | GenerateGhostLevelArray () |
virtual vtkFieldData * | GetAttributesAsFieldData (int type) |
virtual vtkIdType | GetNumberOfElements (int type) |
vtkIdType | FindPoint (double x, double y, double z) |
virtual vtkCell * | FindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) |
int | GetDataObjectType () |
void | ShallowCopy (vtkDataObject *src) |
void | DeepCopy (vtkDataObject *src) |
Static Public Member Functions | |
static vtkStructuredGrid * | New () |
static int | IsTypeOf (const char *type) |
static vtkStructuredGrid * | SafeDownCast (vtkObject *o) |
static vtkStructuredGrid * | GetData (vtkInformation *info) |
static vtkStructuredGrid * | GetData (vtkInformationVector *v, int i=0) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkPointSet * | SafeDownCast (vtkObject *o) |
static vtkPointSet * | GetData (vtkInformation *info) |
static vtkPointSet * | GetData (vtkInformationVector *v, int i=0) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkDataSet * | SafeDownCast (vtkObject *o) |
static vtkDataSet * | GetData (vtkInformation *info) |
static vtkDataSet * | GetData (vtkInformationVector *v, int i=0) |
Protected Member Functions | |
vtkStructuredGrid () | |
~vtkStructuredGrid () | |
void | SetPointVisibility (vtkStructuredVisibilityConstraint *pointVisibility) |
virtual vtkStructuredVisibilityConstraint * | GetPointVisibility () |
void | SetCellVisibility (vtkStructuredVisibilityConstraint *cellVisibility) |
virtual vtkStructuredVisibilityConstraint * | GetCellVisibility () |
![]() | |
vtkPointSet () | |
~vtkPointSet () | |
virtual void | ReportReferences (vtkGarbageCollector *) |
![]() | |
vtkDataSet () | |
~vtkDataSet () | |
virtual void | ComputeScalarRange () |
Protected Attributes | |
vtkVertex * | Vertex |
vtkLine * | Line |
vtkQuad * | Quad |
vtkHexahedron * | Hexahedron |
vtkEmptyCell * | EmptyCell |
int | Dimensions [3] |
int | DataDescription |
int | Extent [6] |
vtkStructuredVisibilityConstraint * | PointVisibility |
vtkStructuredVisibilityConstraint * | CellVisibility |
![]() | |
vtkPoints * | Points |
vtkPointLocator * | Locator |
![]() | |
vtkCellData * | CellData |
vtkPointData * | PointData |
vtkTimeStamp | ComputeTime |
double | Bounds [6] |
double | Center [3] |
double | ScalarRange [2] |
vtkTimeStamp | ScalarRangeComputeTime |
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).
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.
Definition at line 62 of file vtkStructuredGrid.h.
Definition at line 67 of file vtkStructuredGrid.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkPointSet.
|
static |
|
virtual |
Reimplemented from vtkPointSet.
|
static |
void vtkStructuredGrid::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
inline |
Return what type of dataset this is.
Definition at line 71 of file vtkStructuredGrid.h.
|
virtual |
Copy the geometric and topological structure of an input poly data object.
Reimplemented from vtkPointSet.
|
inlinevirtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 79 of file vtkStructuredGrid.h.
|
inlinevirtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 80 of file vtkStructuredGrid.h.
|
inlinevirtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkPointSet.
Definition at line 81 of file vtkStructuredGrid.h.
|
virtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
|
virtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
|
virtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
|
virtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
|
inlinevirtual |
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 | ( | ) |
Standard vtkDataSet API methods. See vtkDataSet for more information.
|
inlinevirtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Implements vtkDataSet.
Definition at line 94 of file vtkStructuredGrid.h.
|
virtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
|
virtual |
Standard vtkDataSet API methods. See vtkDataSet for more information.
Reimplemented from vtkDataSet.
|
inline |
Standard vtkDataSet API methods. See vtkDataSet for more information.
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 |
Get dimensions of this structured points dataset.
|
virtual |
Get dimensions of this structured points dataset.
|
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 |
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).
unsigned long vtkStructuredGrid::GetActualMemorySize | ( | ) |
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.
void vtkStructuredGrid::ShallowCopy | ( | vtkDataObject * | src | ) |
Shallow and Deep copy.
void vtkStructuredGrid::DeepCopy | ( | vtkDataObject * | src | ) |
Shallow and Deep copy.
|
inline |
The extent type is a 3D extent
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 |
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 |
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.
|
protected |
|
protectedvirtual |
|
protected |
|
protectedvirtual |
|
protected |
Definition at line 217 of file vtkStructuredGrid.h.
|
protected |
Definition at line 218 of file vtkStructuredGrid.h.
|
protected |
Definition at line 219 of file vtkStructuredGrid.h.
|
protected |
Definition at line 220 of file vtkStructuredGrid.h.
|
protected |
Definition at line 221 of file vtkStructuredGrid.h.
|
protected |
Definition at line 223 of file vtkStructuredGrid.h.
|
protected |
Definition at line 224 of file vtkStructuredGrid.h.
|
protected |
Definition at line 226 of file vtkStructuredGrid.h.
|
protected |
Definition at line 228 of file vtkStructuredGrid.h.
|
protected |
Definition at line 231 of file vtkStructuredGrid.h.