vtkRectilinearGrid Class Reference

#include <vtkRectilinearGrid.h>

Inheritance diagram for vtkRectilinearGrid:

[legend]

Collaboration diagram for vtkRectilinearGrid:

[legend]

List of all members.

Detailed Description

a dataset that is topologically regular with variable spacing in the three coordinate directions

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 vtkDataArray objects (one for x, one for y, one for z).

Warning:: 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.

Examples:: vtkRectilinearGrid (Examples)

Tests:: vtkRectilinearGrid (Tests)

Definition at line 53 of file vtkRectilinearGrid.h.


Public Types
typedef vtkDataSet	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)
void	Initialize ()
int	GetDataDimension ()
int	ComputeStructuredCoordinates (double x[3], int ijk[3], double pcoords[3])
vtkIdType	ComputePointId (int ijk[3])
vtkIdType	ComputeCellId (int ijk[3])
unsigned long	GetActualMemorySize ()
int	GetExtentType ()
virtual void	Crop ()

vtkIdType	GetNumberOfCells ()
vtkIdType	GetNumberOfPoints ()
double *	GetPoint (vtkIdType ptId)
void	GetPoint (vtkIdType id, double x[3])
vtkCell *	GetCell (vtkIdType cellId)
void	GetCell (vtkIdType cellId, vtkGenericCell *cell)
void	GetCellBounds (vtkIdType cellId, double bounds[6])
vtkIdType	FindPoint (double x, double y, double z)
vtkIdType	FindPoint (double x[3])
vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)
vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)
int	GetCellType (vtkIdType cellId)
void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
void	ComputeBounds ()
int	GetMaxCellSize ()
void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)

void	SetDimensions (int i, int j, int k)
void	SetDimensions (int dim[3])

virtual int *	GetDimensions ()
virtual void	GetDimensions (int data[3])

virtual void	SetXCoordinates (vtkDataArray *)
virtual vtkDataArray *	GetXCoordinates ()

virtual void	SetYCoordinates (vtkDataArray *)
virtual vtkDataArray *	GetYCoordinates ()

virtual void	SetZCoordinates (vtkDataArray *)
virtual vtkDataArray *	GetZCoordinates ()

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)
Static Public Member Functions
static vtkRectilinearGrid *	New ()
static int	IsTypeOf (const char *type)
static vtkRectilinearGrid *	SafeDownCast (vtkObject *o)

static vtkRectilinearGrid *	GetData (vtkInformation *info)
static vtkRectilinearGrid *	GetData (vtkInformationVector *v, int i=0)
Protected Member Functions
	vtkRectilinearGrid ()
	~vtkRectilinearGrid ()
Protected Attributes
vtkVertex *	Vertex
vtkLine *	Line
vtkPixel *	Pixel
vtkVoxel *	Voxel
int	Dimensions [3]
int	DataDescription
int	Extent [6]
vtkDataArray *	XCoordinates
vtkDataArray *	YCoordinates
vtkDataArray *	ZCoordinates
double	PointReturn [3]

Member Typedef Documentation

typedef vtkDataSet vtkRectilinearGrid::Superclass

Reimplemented from vtkDataSet.

Definition at line 58 of file vtkRectilinearGrid.h.

Constructor & Destructor Documentation

vtkRectilinearGrid::vtkRectilinearGrid ( ) [protected]

vtkRectilinearGrid::~vtkRectilinearGrid ( ) [protected]

Member Function Documentation

static vtkRectilinearGrid* vtkRectilinearGrid::New ( ) [static]

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

Reimplemented from vtkDataObject.

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

Reimplemented from vtkDataSet.

static int vtkRectilinearGrid::IsTypeOf ( const char * name ) [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 vtkDataSet.

virtual int vtkRectilinearGrid::IsA ( const char * name ) [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 vtkDataSet.

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

Reimplemented from vtkDataSet.

void vtkRectilinearGrid::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSet.

int vtkRectilinearGrid::GetDataObjectType ( ) [inline, virtual]

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 62 of file vtkRectilinearGrid.h.

void vtkRectilinearGrid::CopyStructure ( vtkDataSet * ds ) [virtual]

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

Implements vtkDataSet.

void vtkRectilinearGrid::Initialize ( ) [virtual]

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

Reimplemented from vtkDataSet.

vtkIdType vtkRectilinearGrid::GetNumberOfCells ( ) [inline, virtual]