---

vtkStructuredData Class Reference

abstract class for topologically regular data. More...

#include <vtkStructuredData.h>

Inheritance diagram for vtkStructuredData:

[legend]Collaboration diagram for vtkStructuredData:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	GetCellPoints (int cellId, vtkIdList &ptIds, int dataDescription, int dim[3])
void	GetPointCells (int ptId, vtkIdList &cellIds, int dim[3])
Static Public Methods
vtkStructuredData *	New ()
int	IsTypeOf (const char *type)
vtkStructuredData *	SafeDownCast (vtkObject *o)
int	SetDimensions (int inDim[3], int dim[3])
int	SetExtent (int inExt[3], int ext[3])
int	GetDataDimension (int dataDescription)
void	GetCellPoints (int cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
void	GetPointCells (int ptId, vtkIdList *cellIds, int dim[3])
void	GetCellNeigbors (int cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3])
int	ComputePointId (int dim[3], int ijk[3])
int	ComputeCellId (int dim[3], int ijk[3])
Protected Methods
	vtkStructuredData ()
	~vtkStructuredData ()
	vtkStructuredData (const vtkStructuredData &)
void	operator= (const vtkStructuredData &)

---

Detailed Description

abstract class for topologically regular data.

Date:

2000/12/10 20:08:18

Revision:

1.46

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 68 of file vtkStructuredData.h.

---

Constructor & Destructor Documentation

vtkStructuredData::vtkStructuredData (    )  [inline, protected]

Definition at line 116 of file vtkStructuredData.h.

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

Definition at line 117 of file vtkStructuredData.h.

vtkStructuredData::vtkStructuredData (  const vtkStructuredData &    )  [inline, protected]

Definition at line 118 of file vtkStructuredData.h.

---

Member Function Documentation

vtkStructuredData* vtkStructuredData::New (    )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject.

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.

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

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

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

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

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

void vtkStructuredData::GetCellNeigbors (  int    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.)

int 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 99 of file vtkStructuredData.h. Referenced by vtkRectilinearGrid::ComputePointId(), and vtkImageData::ComputePointId().

int 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 104 of file vtkStructuredData.h. Referenced by vtkRectilinearGrid::ComputeCellId(), and vtkImageData::ComputeCellId().

void vtkStructuredData::GetCellPoints (  int    cellId, vtkIdList &    ptIds, int    dataDescription, int    dim[3] )  [inline]

For legacy compatibility. Do not use. Definition at line 109 of file vtkStructuredData.h.

void vtkStructuredData::GetPointCells (  int    ptId, vtkIdList &    cellIds, int    dim[3] )  [inline]

Definition at line 111 of file vtkStructuredData.h.

void vtkStructuredData::operator= (  const vtkStructuredData &    )  [inline, protected]

Definition at line 119 of file vtkStructuredData.h.

---

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

• common/vtkStructuredData.h

---