Documentation for vtkRectilinearGrid

vtkRectilinearGrid - a datset that is topologically regular with variable spacing in the three coordinate directions

Super Class: vtkDataSet

Description:

vtkRectilinearGrid is a data object that is a concrete implementation of vtkDataSet. vtkRectilinearGrid represents a geometric structure that is topologically regular with variable spacing in the three coordinate directions x-y-z. To define a vtkRectilinearGrid, you must specify the dimensions of the data and provide three arrays of values specifying the coordinates along the x-y-z axes. The coordinate arrays are specified using three vtkScalars objects (one for x, one for y, one for z).

 

Caveats:

Make sure that the dimensions of the grid match the number of coordinates in the x-y-z directions. If not, unpredictable results (including program failure) may result. Also, you must supply coordinates in all three directions, even if the dataset topology is 2D, 1D, or 0D. Finally, the coordinates values in each direction must be montonically increasing.

 

Methods:

void vtkRectilinearGrid ()
void vtkRectilinearGrid (const vtkRectilinearGrid &)
void vtkRectilinearGrid ()
static vtkRectilinearGrid *New ()
const char *GetClassName ()
int GetDataSetType ()
void PrintSelf (unknown & ,vtkIndent )
vtkDataObject *MakeObject ()
void CopyStructure (vtkDataSet *)
void Initialize ()
int GetNumberOfCells ()
int GetNumberOfPoints ()
float *GetPoint (int )
void GetPoint (int ,float )
vtkCell *GetCell (int )
int FindPoint (float )
int FindCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
vtkCell *FindAndGetCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
int GetCellType (int )
void GetCellPoints (int ,vtkIdList *)
void GetPointCells (int ,vtkIdList *)
void ComputeBounds ()
int GetMaxCellSize ()
void SetDimensions (int ,int ,int )
void SetDimensions (int )
int *GetDimensions ()
int GetDataDimension ()
int ComputeStructuredCoordinates (float ,int ,float )
int ComputePointId (int )
int ComputeCellId (int )
void SetXCoordinates (vtkScalars *)
vtkScalars *GetXCoordinates ()
void SetYCoordinates (vtkScalars *)
vtkScalars *GetYCoordinates ()
void SetZCoordinates (vtkScalars *)
vtkScalars *GetZCoordinates ()
void GetCellPoints (int ,vtkIdList &)
void GetPointCells (int ,vtkIdList &)

 

Detailed Method Descriptions:

Create a similar type object

vtkDataObject *MakeObject ()

Copy the geometric and topological structure of an input rectilinear grid object.

void CopyStructure (vtkDataSet *)

Restore object to initial state. Release memory back to system.

void Initialize ()

Standard vtkDataSet API methods. See vtkDataSet for more information.

int GetNumberOfCells ()
int GetNumberOfPoints ()
float *GetPoint (int )
void GetPoint (int ,float )
vtkCell *GetCell (int )
int FindPoint (float )
int FindCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
vtkCell *FindAndGetCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
int GetCellType (int )
void GetCellPoints (int ,vtkIdList *)
void GetPointCells (int ,vtkIdList *)
void ComputeBounds ()
int GetMaxCellSize ()

Set dimensions of rectilinear grid dataset.

void SetDimensions (int ,int ,int )
void SetDimensions (int )

Get dimensions of this rectilinear grid dataset.

int *GetDimensions ()

Return the dimensionality of the data.

int GetDataDimension ()

Convenience function computes the structured coordinates for a point x[3]. The cell is specified by the array ijk[3], and the parametric coordinates in the cell are specified with pcoords[3]. The function returns a 0 if the point x is outside of the grid, and a 1 if inside the grid.

int ComputeStructuredCoordinates (float ,int ,float )

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

int ComputePointId (int )

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

int ComputeCellId (int )

Specify the grid coordinates in the x-direction.

void SetXCoordinates (vtkScalars *)
vtkScalars *GetXCoordinates ()

Specify the grid coordinates in the y-direction.

void SetYCoordinates (vtkScalars *)
vtkScalars *GetYCoordinates ()

Specify the grid coordinates in the z-direction.

void SetZCoordinates (vtkScalars *)
vtkScalars *GetZCoordinates ()

For legacy compatibility. Do not use.

void GetCellPoints (int ,vtkIdList &)