Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkUniformGrid Class Reference

#include <vtkUniformGrid.h>

Inheritance diagram for vtkUniformGrid:

Inheritance graph
[legend]
Collaboration diagram for vtkUniformGrid:

Collaboration graph
[legend]
List of all members.

Detailed Description

topologically and geometrically regular array of data

vtkUniformGrid is a data object that is a concrete implementation of vtkDataSet. vtkUniformGrid represents a geometric structure that is a topological and geometrical regular array of points. vtkUniformGrid is essentially a simple vtkImageData that supports blanking.

Created by:
  • Bertel, Francois
CVS contributions (if > 5%):
  • Bertel, Francois (98%)
CVS logs (CVSweb):
  • .h (/Filtering/vtkUniformGrid.h)
  • .cxx (/Filtering/vtkUniformGrid.cxx)
Examples:
vtkUniformGrid (Examples)
Tests:
vtkUniformGrid (Tests)

Definition at line 57 of file vtkUniformGrid.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)
void CopyStructure (vtkDataSet *ds)
int GetDataObjectType ()
void SetDimensions (int i, int j, int k)
void SetDimensions (int dims[3])
int ComputeStructuredCoordinates (double x[3], int ijk[3], double pcoords[3])
int GetDataDimension ()
unsigned long GetActualMemorySize ()
int GetExtentType ()
vtkUnsignedCharArrayGetPointVisibilityArray ()
void SetPointVisibilityArray (vtkUnsignedCharArray *pointVisibility)
vtkUnsignedCharArrayGetCellVisibilityArray ()
void SetCellVisibilityArray (vtkUnsignedCharArray *pointVisibility)
unsigned char IsPointVisible (vtkIdType ptId)
unsigned char IsCellVisible (vtkIdType cellId)
unsigned char GetPointBlanking ()
unsigned char GetCellBlanking ()
vtkIdType GetNumberOfCells ()
vtkIdType GetNumberOfPoints ()
double * GetPoint (vtkIdType ptId)
void GetPoint (vtkIdType id, double x[3])
vtkCellGetCell (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)
vtkCellFindAndGetCell (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 ()
void Initialize ()
int GetMaxCellSize ()
virtual void GetScalarRange (double range[2])
double * GetScalarRange ()
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])
int * GetDimensions ()
void GetDimensions (int dims[3])
void SetExtent (int extent[6])
void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
int * GetExtent ()
void GetExtent (int &x1, int &x2, int &y1, int &y2, int &z1, int &z2)
void GetExtent (int *extent)
virtual void SetSpacing (double, double, double)
virtual void SetSpacing (double[3])
virtual double * GetSpacing ()
virtual void GetSpacing (double &, double &, double &)
virtual void GetSpacing (double[3])
virtual void SetOrigin (double, double, double)
virtual void SetOrigin (double[3])
virtual double * GetOrigin ()
virtual void GetOrigin (double &, double &, double &)
virtual void GetOrigin (double[3])
void ShallowCopy (vtkDataObject *src)
void DeepCopy (vtkDataObject *src)
void BlankPoint (vtkIdType ptId)
void UnBlankPoint (vtkIdType ptId)
void BlankCell (vtkIdType ptId)
void UnBlankCell (vtkIdType ptId)

Static Public Member Functions

vtkUniformGridNew ()
int IsTypeOf (const char *type)
vtkUniformGridSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkUniformGrid ()
 ~vtkUniformGrid ()
void SetPointVisibility (vtkStructuredVisibilityConstraint *pointVisibility)
virtual vtkStructuredVisibilityConstraintGetPointVisibility ()
void SetCellVisibility (vtkStructuredVisibilityConstraint *cellVisibility)
virtual vtkStructuredVisibilityConstraintGetCellVisibility ()

Protected Attributes

vtkVertexVertex
vtkLineLine
vtkPixelPixel
vtkVoxelVoxel
vtkEmptyCellEmptyCell
int Dimensions [3]
int DataDescription
double Origin [3]
double Spacing [3]
vtkStructuredVisibilityConstraintPointVisibility
vtkStructuredVisibilityConstraintCellVisibility


Member Typedef Documentation

typedef vtkDataSet vtkUniformGrid::Superclass
 

Reimplemented from vtkDataSet.

Definition at line 62 of file vtkUniformGrid.h.


Constructor & Destructor Documentation

vtkUniformGrid::vtkUniformGrid  )  [protected]
 

vtkUniformGrid::~vtkUniformGrid  )  [protected]
 


Member Function Documentation

vtkUniformGrid* vtkUniformGrid::New  )  [static]
 

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

Reimplemented from vtkDataObject.

virtual const char* vtkUniformGrid::GetClassName  )  [virtual]
 

Reimplemented from vtkDataSet.

int vtkUniformGrid::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 vtkDataSet.

virtual int vtkUniformGrid::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 vtkDataSet.

vtkUniformGrid* vtkUniformGrid::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkDataSet.

void vtkUniformGrid::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.

void vtkUniformGrid::CopyStructure vtkDataSet ds  )  [virtual]
 

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

Implements vtkDataSet.

int vtkUniformGrid::GetDataObjectType  )  [inline, virtual]
 

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 70 of file vtkUniformGrid.h.

vtkIdType vtkUniformGrid::GetNumberOfCells  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkUniformGrid::GetNumberOfPoints  )  [inline, virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 283 of file vtkUniformGrid.h.

References GetDimensions(), and vtkIdType.

double* vtkUniformGrid::GetPoint vtkIdType  ptId  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Referenced by GetPoint().

void vtkUniformGrid::GetPoint vtkIdType  id,
double  x[3]
[inline, virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 275 of file vtkUniformGrid.h.

References GetPoint(), and vtkIdType.

vtkCell* vtkUniformGrid::GetCell vtkIdType  cellId  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

void vtkUniformGrid::GetCell vtkIdType  cellId,
vtkGenericCell cell
[virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

void vtkUniformGrid::GetCellBounds vtkIdType  cellId,
double  bounds[6]
[virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

vtkIdType vtkUniformGrid::FindPoint double  x,
double  y,
double  z
[inline]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 81 of file vtkUniformGrid.h.

References vtkDataSet::FindPoint(), and vtkIdType.

vtkIdType vtkUniformGrid::FindPoint double  x[3]  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkUniformGrid::FindCell double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights
[virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkUniformGrid::FindCell double  x[3],
vtkCell cell,
vtkGenericCell gencell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights
[virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkCell* vtkUniformGrid::FindAndGetCell double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights
[virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

int vtkUniformGrid::GetCellType vtkIdType  cellId  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

void vtkUniformGrid::GetCellPoints vtkIdType  cellId,
vtkIdList ptIds
[inline, virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 92 of file vtkUniformGrid.h.

References vtkStructuredData::GetCellPoints(), and vtkIdType.

void vtkUniformGrid::GetPointCells vtkIdType  ptId,
vtkIdList cellIds
[inline, virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 95 of file vtkUniformGrid.h.

References vtkStructuredData::GetPointCells(), and vtkIdType.

void vtkUniformGrid::ComputeBounds  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

void vtkUniformGrid::Initialize  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

int vtkUniformGrid::GetMaxCellSize  )  [inline, virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 99 of file vtkUniformGrid.h.

virtual void vtkUniformGrid::GetScalarRange double  range[2]  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

double* vtkUniformGrid::GetScalarRange  )  [inline]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 101 of file vtkUniformGrid.h.

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

For streaming. User/next filter specifies which piece the want updated. The source of this data has to return exactly this piece.

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

For streaming. User/next filter specifies which piece the want updated. The source of this data has to return exactly this piece.

Reimplemented from vtkDataObject.

Definition at line 108 of file vtkUniformGrid.h.

References vtkDataObject::SetUpdateExtent().

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

Call superclass method to avoid hiding Since this data type does not use 3D extents, this set method is useless but necessary since vtkDataSetToDataSetFilter does not know what type of data it is working on.

Reimplemented from vtkDataObject.

Definition at line 117 of file vtkUniformGrid.h.

void vtkUniformGrid::SetUpdateExtent int  ext[6]  )  [inline, virtual]
 

Call superclass method to avoid hiding Since this data type does not use 3D extents, this set method is useless but necessary since vtkDataSetToDataSetFilter does not know what type of data it is working on.

Reimplemented from vtkDataObject.

Definition at line 119 of file vtkUniformGrid.h.

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

Set dimensions of structured points dataset.

void vtkUniformGrid::SetDimensions int  dims[3]  ) 
 

Set dimensions of structured points dataset.

int* vtkUniformGrid::GetDimensions  ) 
 

Get dimensions of this structured points dataset. Dimensions are computed from Extents during this call.

Referenced by GetNumberOfPoints().

void vtkUniformGrid::GetDimensions int  dims[3]  ) 
 

Get dimensions of this structured points dataset. Dimensions are computed from Extents during this call.

int vtkUniformGrid::ComputeStructuredCoordinates double  x[3],
int  ijk[3],
double  pcoords[3]
 

Convenience function computes the structured coordinates for a point x[3]. The voxel is specified by the array ijk[3], and the parametric coordinates in the cell are specified with pcoords[3]. The function returns a 0 if the point x is outside of the volume, and a 1 if inside the volume.

int vtkUniformGrid::GetDataDimension  )  [inline]
 

Return the dimensionality of the data.

Definition at line 289 of file vtkUniformGrid.h.

References vtkStructuredData::GetDataDimension().

void vtkUniformGrid::SetExtent int  extent[6]  ) 
 

Description: 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 vtkUniformGrid::SetExtent int  x1,
int  x2,
int  y1,
int  y2,
int  z1,
int  z2
 

Description: 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).

int* vtkUniformGrid::GetExtent  ) 
 

Description: 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 vtkUniformGrid::GetExtent int &  x1,
int &  x2,
int &  y1,
int &  y2,
int &  z1,
int &  z2
 

Description: 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 vtkUniformGrid::GetExtent int *  extent  ) 
 

Description: 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).

unsigned long vtkUniformGrid::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 vtkDataSet.

virtual void vtkUniformGrid::SetSpacing double  ,
double  ,
double 
[virtual]
 

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkUniformGrid::SetSpacing double  [3]  )  [virtual]
 

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual double* vtkUniformGrid::GetSpacing  )  [virtual]
 

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkUniformGrid::GetSpacing double &  ,
double &  ,
double & 
[virtual]
 

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkUniformGrid::GetSpacing double  [3]  )  [virtual]
 

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkUniformGrid::SetOrigin double  ,
double  ,
double 
[virtual]
 

Set the origin of the data. The origin plus spacing determine the position in space of the points.

virtual void vtkUniformGrid::SetOrigin double  [3]  )  [virtual]
 

Set the origin of the data. The origin plus spacing determine the position in space of the points.

virtual double* vtkUniformGrid::GetOrigin  )  [virtual]
 

Set the origin of the data. The origin plus spacing determine the position in space of the points.

virtual void vtkUniformGrid::GetOrigin double &  ,
double &  ,
double & 
[virtual]
 

Set the origin of the data. The origin plus spacing determine the position in space of the points.

virtual void vtkUniformGrid::GetOrigin double  [3]  )  [virtual]
 

Set the origin of the data. The origin plus spacing determine the position in space of the points.

void vtkUniformGrid::ShallowCopy vtkDataObject src  )  [virtual]
 

Shallow and Deep copy.

Reimplemented from vtkDataSet.

void vtkUniformGrid::DeepCopy vtkDataObject src  )  [virtual]
 

Shallow and Deep copy.

Reimplemented from vtkDataSet.

int vtkUniformGrid::GetExtentType  )  [inline, virtual]
 

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 185 of file vtkUniformGrid.h.

void vtkUniformGrid::BlankPoint vtkIdType  ptId  ) 
 

Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

void vtkUniformGrid::UnBlankPoint vtkIdType  ptId  ) 
 

Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

void vtkUniformGrid::BlankCell vtkIdType  ptId  ) 
 

Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

void vtkUniformGrid::UnBlankCell vtkIdType  ptId  ) 
 

Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

vtkUnsignedCharArray* vtkUniformGrid::GetPointVisibilityArray  ) 
 

Get the array that defines the blanking (visibility) of each point.

void vtkUniformGrid::SetPointVisibilityArray vtkUnsignedCharArray pointVisibility  ) 
 

Set an array that defines the (blanking) visibility of the points in the grid. Make sure that length of the visibility array matches the number of points in the grid.

vtkUnsignedCharArray* vtkUniformGrid::GetCellVisibilityArray  ) 
 

Get the array that defines the blanking (visibility) of each cell.

void vtkUniformGrid::SetCellVisibilityArray vtkUnsignedCharArray pointVisibility  ) 
 

Set an array that defines the (blanking) visibility of the cells in the grid. Make sure that length of the visibility array matches the number of points in the grid.

unsigned char vtkUniformGrid::IsPointVisible vtkIdType  ptId  ) 
 

Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set.

unsigned char vtkUniformGrid::IsCellVisible vtkIdType  cellId  ) 
 

Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set.

unsigned char vtkUniformGrid::GetPointBlanking  ) 
 

Returns 1 if there is any visibility constraint on the points, 0 otherwise.

unsigned char vtkUniformGrid::GetCellBlanking  ) 
 

Returns 1 if there is any visibility constraint on the cells, 0 otherwise.

void vtkUniformGrid::SetPointVisibility vtkStructuredVisibilityConstraint pointVisibility  )  [protected]
 

virtual vtkStructuredVisibilityConstraint* vtkUniformGrid::GetPointVisibility  )  [protected, virtual]
 

void vtkUniformGrid::SetCellVisibility vtkStructuredVisibilityConstraint cellVisibility  )  [protected]
 

virtual vtkStructuredVisibilityConstraint* vtkUniformGrid::GetCellVisibility  )  [protected, virtual]
 


Member Data Documentation

vtkVertex* vtkUniformGrid::Vertex [protected]
 

Definition at line 241 of file vtkUniformGrid.h.

vtkLine* vtkUniformGrid::Line [protected]
 

Definition at line 242 of file vtkUniformGrid.h.

vtkPixel* vtkUniformGrid::Pixel [protected]
 

Definition at line 243 of file vtkUniformGrid.h.

vtkVoxel* vtkUniformGrid::Voxel [protected]
 

Definition at line 244 of file vtkUniformGrid.h.

vtkEmptyCell* vtkUniformGrid::EmptyCell [protected]
 

Definition at line 245 of file vtkUniformGrid.h.

int vtkUniformGrid::Dimensions[3] [protected]
 

Definition at line 250 of file vtkUniformGrid.h.

int vtkUniformGrid::DataDescription [protected]
 

Definition at line 251 of file vtkUniformGrid.h.

double vtkUniformGrid::Origin[3] [protected]
 

Definition at line 253 of file vtkUniformGrid.h.

double vtkUniformGrid::Spacing[3] [protected]
 

Definition at line 254 of file vtkUniformGrid.h.

vtkStructuredVisibilityConstraint* vtkUniformGrid::PointVisibility [protected]
 

Definition at line 256 of file vtkUniformGrid.h.

vtkStructuredVisibilityConstraint* vtkUniformGrid::CellVisibility [protected]
 

Definition at line 261 of file vtkUniformGrid.h.


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