vtkStructuredData Class Reference

#include <vtkStructuredData.h>

Inheritance diagram for vtkStructuredData:

[legend]Collaboration diagram for vtkStructuredData:

[legend]List of all members.

---

Detailed Description

abstract class for topologically regular data

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.

Definition at line 42 of file vtkStructuredData.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkStructuredData *	SafeDownCast (vtkObject *o)
static int	SetDimensions (int inDim[3], int dim[3])
static int	SetExtent (int inExt[6], int ext[6])
static int	GetDataDimension (int dataDescription)
static void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
static void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds, int dim[3])
static void	GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3])
static vtkIdType	ComputePointId (int dim[3], int ijk[3])
static vtkIdType	ComputeCellId (int dim[3], int ijk[3])
Protected Member Functions
	vtkStructuredData ()
	~vtkStructuredData ()

---

Member Typedef Documentation

typedef vtkObject vtkStructuredData::Superclass

Reimplemented from vtkObject. Definition at line 45 of file vtkStructuredData.h.

---

Constructor & Destructor Documentation

vtkStructuredData::vtkStructuredData (   )  [inline, protected]

Definition at line 91 of file vtkStructuredData.h.

vtkStructuredData::~vtkStructuredData (   )  [inline, protected]

Definition at line 92 of file vtkStructuredData.h.

---

Member Function Documentation

virtual const char* vtkStructuredData::GetClassName (   )  [virtual]

Reimplemented from vtkObject.

static int vtkStructuredData::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject.

virtual int vtkStructuredData::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject.

static vtkStructuredData* vtkStructuredData::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkObject.

static int vtkStructuredData::SetDimensions (  int  inDim[3], int  dim[3] )  [static]

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 vtkStructuredData::SetExtent (  int  inExt[6], int  ext[6] )  [static]

static int vtkStructuredData::GetDataDimension (  int  dataDescription  )  [static]

Return the topological dimension of the data (e.g., 0, 1, 2, or 3D). Referenced by vtkStructuredGrid::GetDataDimension(), vtkRectilinearGrid::GetDataDimension(), and vtkImageData::GetDataDimension().

static void vtkStructuredData::GetCellPoints (  vtkIdType  cellId, vtkIdList *  ptIds, int  dataDescription, int  dim[3] )  [static]

Get the points defining a cell. (See vtkDataSet for more info.) Referenced by vtkUniformGrid::GetCellPoints(), vtkRectilinearGrid::GetCellPoints(), and vtkImageData::GetCellPoints().

static void vtkStructuredData::GetPointCells (  vtkIdType  ptId, vtkIdList *  cellIds, int  dim[3] )  [static]

Get the cells using a point. (See vtkDataSet for more info.) Referenced by vtkUniformGrid::GetPointCells(), vtkStructuredGrid::GetPointCells(), vtkRectilinearGrid::GetPointCells(), and vtkImageData::GetPointCells().

static void vtkStructuredData::GetCellNeighbors (  vtkIdType  cellId, vtkIdList *  ptIds, vtkIdList *  cellIds, int  dim[3] )  [static]

Get the cells using the points ptIds, exclusive of the cell cellId. (See vtkDataSet for more info.)

static vtkIdType vtkStructuredData::ComputePointId (  int  dim[3], int  ijk[3] )  [inline, static]

Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the point id. Definition at line 79 of file vtkStructuredData.h. Referenced by vtkRectilinearGrid::ComputePointId(), and vtkImageData::ComputePointId().

static vtkIdType vtkStructuredData::ComputeCellId (  int  dim[3], int  ijk[3] )  [inline, static]

Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the cell id. Definition at line 86 of file vtkStructuredData.h. Referenced by vtkRectilinearGrid::ComputeCellId(), and vtkImageData::ComputeCellId().

---

The documentation for this class was generated from the following file:

• dox/Common/vtkStructuredData.h

---