Documentation for vtkStructuredData

vtkStructuredData - abstract class for topologically regular data

Description:

vtkStructuredData is an abstract class that specifies an interface for topologically regular data. Regular data is data that can be accessed in rectangular fashion using an i-j-k index. A finite difference grid, a volume, or a pixmap are all considered regular.

Methods:

	static vtkStructuredData *New ()
	const char *GetClassName ()
	static int SetDimensions (int ,int )
	static int GetDataDimension (int )
	static void GetCellPoints (int ,vtkIdList * ,int ,int )
	static void GetPointCells (int ,vtkIdList * ,int )
	static int ComputePointId (int ,int )
	static int ComputeCellId (int ,int )
	void GetCellPoints (int ,vtkIdList & ,int ,int )
	void GetPointCells (int ,vtkIdList & ,int )

Detailed Method Descriptions:

Specify the dimensions of a regular, rectangular dataset. The input is the new dimensions (inDim) and the current dimensions (dim). The function returns the dimension of the dataset (0-3D). If the dimensions are improperly specified a -1 is returned. If the dimensions are unchanged, a value of 100 is returned.

static int SetDimensions (int ,int )

Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).

static int GetDataDimension (int )

Get the points defining a cell. (See vtkDataSet for more info.)

static void GetCellPoints (int ,vtkIdList * ,int ,int )

Get the cells using a point. (See vtkDataSet for more info.)

static void GetPointCells (int ,vtkIdList * ,int )

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

	static int ComputePointId (int ,int )
	static int ComputeCellId (int ,int )

For legacy compatibility. Do not use.

void GetCellPoints (int ,vtkIdList & ,int ,int )