Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkStructuredGrid Class Reference

topologically regular array of data. More...

#include <vtkStructuredGrid.h>

Inheritance diagram for vtkStructuredGrid:

Inheritance graph
[legend]
Collaboration diagram for vtkStructuredGrid:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int GetDataObjectType ()
vtkDataObjectMakeObject ()
void CopyStructure (vtkDataSet *ds)
int GetNumberOfPoints ()
float * GetPoint (int ptId)
void GetPoint (int ptId, float p[3])
vtkCellGetCell (int cellId)
void GetCell (int cellId, vtkGenericCell *cell)
void GetCellBounds (int cellId, float bounds[6])
int GetCellType (int cellId)
int GetNumberOfCells ()
void GetCellPoints (int cellId, vtkIdList *ptIds)
void GetPointCells (int ptId, vtkIdList *cellIds)
void Initialize ()
int GetMaxCellSize ()
void GetCellNeighbors (int 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])
int GetDataDimension ()
void BlankingOn ()
void BlankingOff ()
int GetBlanking ()
void BlankPoint (int ptId)
void UnBlankPoint (int ptId)
int IsPointVisible (int ptId)
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void SetUpdateExtent (int piece, int numPieces)
void SetUpdateExtent (int x1, int x2, int y1, int y2, int z1, int z2)
void SetUpdateExtent (int ext[6])
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])
unsigned long GetActualMemorySize ()
void ShallowCopy (vtkDataObject *src)
void DeepCopy (vtkDataObject *src)
void GetCellPoints (int cellId, vtkIdList &ptIds)
void GetPointCells (int ptId, vtkIdList &cellIds)

Static Public Methods

vtkStructuredGrid * New ()
int IsTypeOf (const char *type)
vtkStructuredGrid * SafeDownCast (vtkObject *o)

Protected Methods

 vtkStructuredGrid ()
 ~vtkStructuredGrid ()
 vtkStructuredGrid (const vtkStructuredGrid &)
void operator= (const vtkStructuredGrid &)
int GetExtentType ()
void AllocatePointVisibility ()

Protected Attributes

vtkVertexVertex
vtkLineLine
vtkQuadQuad
vtkHexahedronHexahedron
int Dimensions [3]
int DataDescription
int Blanking
vtkScalarsPointVisibility

Detailed Description

topologically regular array of data.

Date:
2000/12/10 20:08:18
Revision:
1.75

vtkStructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkStructuredGrid represents a geometric structure that is a topologically regular array of points. The topology is that of a cube that has been subdivided into a regular array of smaller cubes. Each point/cell can be addressed with i-j-k indices. Examples include finite difference grids.

Examples:
vtkStructuredGrid (examples)

Definition at line 68 of file vtkStructuredGrid.h.


Constructor & Destructor Documentation

vtkStructuredGrid::vtkStructuredGrid   [protected]
 

vtkStructuredGrid::~vtkStructuredGrid   [protected]
 

vtkStructuredGrid::vtkStructuredGrid const vtkStructuredGrid &    [inline, protected]
 

Definition at line 163 of file vtkStructuredGrid.h.


Member Function Documentation

vtkStructuredGrid* vtkStructuredGrid::New   [static]
 

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

Reimplemented from vtkDataObject.

Referenced by MakeObject().

virtual const char* vtkStructuredGrid::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 vtkPointSet.

int vtkStructuredGrid::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 vtkPointSet.

virtual int vtkStructuredGrid::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 vtkPointSet.

vtkStructuredGrid* vtkStructuredGrid::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 vtkPointSet.

void vtkStructuredGrid::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 vtkPointSet.

int vtkStructuredGrid::GetDataObjectType   [inline, virtual]
 

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 76 of file vtkStructuredGrid.h.

vtkDataObject* vtkStructuredGrid::MakeObject   [inline, virtual]
 

Create a similar type object

Reimplemented from vtkDataObject.

Definition at line 79 of file vtkStructuredGrid.h.

void vtkStructuredGrid::CopyStructure vtkDataSet   ds [virtual]
 

Copy the geometric and topological structure of an input poly data object.

Reimplemented from vtkPointSet.

int vtkStructuredGrid::GetNumberOfPoints   [inline, virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkPointSet.

Definition at line 86 of file vtkStructuredGrid.h.

float* vtkStructuredGrid::GetPoint int    ptId [inline, virtual]
 

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkPointSet.

Definition at line 87 of file vtkStructuredGrid.h.

void vtkStructuredGrid::GetPoint int    ptId,
float    p[3]
[inline, virtual]
 

Copy point coordinates into user provided array x[3] for specified point id. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkPointSet.

Definition at line 88 of file vtkStructuredGrid.h.

vtkCell* vtkStructuredGrid::GetCell int    cellId [virtual]
 

Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataSet.

void vtkStructuredGrid::GetCell int    cellId,
vtkGenericCell   cell
[virtual]
 

Get cell with cellId such that: 0 <= cellId < NumberOfCells. This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

void vtkStructuredGrid::GetCellBounds int    cellId,
float    bounds[6]
[virtual]
 

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

int vtkStructuredGrid::GetCellType int    cellId [virtual]
 

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

int vtkStructuredGrid::GetNumberOfCells   [inline, virtual]
 

Determine the number of cells composing the dataset. THIS METHOD IS THREAD SAFE

Reimplemented from vtkDataSet.

Definition at line 193 of file vtkStructuredGrid.h.

void vtkStructuredGrid::GetCellPoints int    cellId,
vtkIdList   ptIds
[virtual]
 

Topological inquiry to get points defining cell. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

void vtkStructuredGrid::GetPointCells int    ptId,
vtkIdList   cellIds
[inline, virtual]
 

Topological inquiry to get cells using point. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

Definition at line 95 of file vtkStructuredGrid.h.

void vtkStructuredGrid::Initialize   [virtual]
 

Reset to an empty state and free any memory.

Reimplemented from vtkPointSet.

int vtkStructuredGrid::GetMaxCellSize   [inline, virtual]
 

Convenience method returns largest cell size in dataset. This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE

Reimplemented from vtkDataSet.

Definition at line 98 of file vtkStructuredGrid.h.

void vtkStructuredGrid::GetCellNeighbors int    cellId,
vtkIdList   ptIds,
vtkIdList   cellIds
[virtual]
 

Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

void vtkStructuredGrid::SetDimensions int    i,
int    j,
int    k
 

following methods are specific to structured grid

void vtkStructuredGrid::SetDimensions int    dim[3]
 

virtual int* vtkStructuredGrid::GetDimensions   [virtual]
 

Get dimensions of this structured points dataset.

virtual void vtkStructuredGrid::GetDimensions int    data[3] [virtual]
 

int vtkStructuredGrid::GetDataDimension   [inline]
 

Return the dimensionality of the data.

Definition at line 209 of file vtkStructuredGrid.h.

void vtkStructuredGrid::BlankingOn  
 

Methods for supporting blanking of cells.

void vtkStructuredGrid::BlankingOff  
 

int vtkStructuredGrid::GetBlanking   [inline]
 

Definition at line 114 of file vtkStructuredGrid.h.

void vtkStructuredGrid::BlankPoint int    ptId
 

void vtkStructuredGrid::UnBlankPoint int    ptId
 

int vtkStructuredGrid::IsPointVisible int    ptId [inline]
 

Return non-zero value if specified point is visible.

Definition at line 215 of file vtkStructuredGrid.h.

void vtkStructuredGrid::SetUpdateExtent int    piece,
int    numPieces,
int    ghostLevel
 

Required for the lowest common denominator for setting the UpdateExtent (i.e. vtkDataSetToStructuredPointsFilter). This assumes that WholeExtent is valid (UpdateInformation has been called).

void vtkStructuredGrid::SetUpdateExtent int    piece,
int    numPieces
[inline]
 

Reimplemented from vtkDataObject.

Definition at line 125 of file vtkStructuredGrid.h.

void vtkStructuredGrid::SetUpdateExtent int    x1,
int    x2,
int    y1,
int    y2,
int    z1,
int    z2
[inline, virtual]
 

Call superclass method to avoid hiding

Reimplemented from vtkDataObject.

Definition at line 129 of file vtkStructuredGrid.h.

void vtkStructuredGrid::SetUpdateExtent int    ext[6] [inline, virtual]
 

Reimplemented from vtkDataObject.

Definition at line 131 of file vtkStructuredGrid.h.

void vtkStructuredGrid::SetExtent int    extent[6]
 

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

void vtkStructuredGrid::SetExtent int    x1,
int    x2,
int    y1,
int    y2,
int    z1,
int    z2
 

virtual int* vtkStructuredGrid::GetExtent   [virtual]
 

virtual void vtkStructuredGrid::GetExtent int &   ,
int &   ,
int &   ,
int &   ,
int &   ,
int &   
[virtual]
 

virtual void vtkStructuredGrid::GetExtent int   [6] [virtual]
 

unsigned long vtkStructuredGrid::GetActualMemorySize   [virtual]
 

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkPointSet.

void vtkStructuredGrid::ShallowCopy vtkDataObject   src [virtual]
 

Shallow and Deep copy.

Reimplemented from vtkPointSet.

void vtkStructuredGrid::DeepCopy vtkDataObject   src [virtual]
 

Reimplemented from vtkPointSet.

void vtkStructuredGrid::GetCellPoints int    cellId,
vtkIdList   ptIds
[inline]
 

For legacy compatibility. Do not use.

Reimplemented from vtkDataSet.

Definition at line 154 of file vtkStructuredGrid.h.

void vtkStructuredGrid::GetPointCells int    ptId,
vtkIdList   cellIds
[inline]
 

Reimplemented from vtkDataSet.

Definition at line 156 of file vtkStructuredGrid.h.

void vtkStructuredGrid::operator= const vtkStructuredGrid &    [inline, protected]
 

Definition at line 164 of file vtkStructuredGrid.h.

int vtkStructuredGrid::GetExtentType   [inline, protected, virtual]
 

Reimplemented from vtkDataObject.

Definition at line 173 of file vtkStructuredGrid.h.

void vtkStructuredGrid::AllocatePointVisibility   [protected]
 


Member Data Documentation

vtkVertex* vtkStructuredGrid::Vertex [protected]
 

Definition at line 167 of file vtkStructuredGrid.h.

vtkLine* vtkStructuredGrid::Line [protected]
 

Definition at line 168 of file vtkStructuredGrid.h.

vtkQuad* vtkStructuredGrid::Quad [protected]
 

Definition at line 169 of file vtkStructuredGrid.h.

vtkHexahedron* vtkStructuredGrid::Hexahedron [protected]
 

Definition at line 170 of file vtkStructuredGrid.h.

int vtkStructuredGrid::Dimensions[3] [protected]
 

Definition at line 175 of file vtkStructuredGrid.h.

int vtkStructuredGrid::DataDescription [protected]
 

Definition at line 176 of file vtkStructuredGrid.h.

int vtkStructuredGrid::Blanking [protected]
 

Definition at line 177 of file vtkStructuredGrid.h.

vtkScalars* vtkStructuredGrid::PointVisibility [protected]
 

Definition at line 178 of file vtkStructuredGrid.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 13:00:32 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001