VTK
Public Member Functions | Protected Member Functions | Protected Attributes
vtkUniformGrid Class Reference

image data with blanking More...

#include <vtkUniformGrid.h>

Inheritance diagram for vtkUniformGrid:
Inheritance graph
[legend]
Collaboration diagram for vtkUniformGrid:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void CopyStructure (vtkDataSet *ds)
virtual int GetDataObjectType ()
int GetGridDescription ()
int Initialize (const vtkAMRBox *def, double *origin, double *spacing)
int Initialize (const vtkAMRBox *def, double *origin, double *spacing, int nGhosts)
int Initialize (const vtkAMRBox *def, double *origin, double *spacing, const int nGhosts[3])
virtual vtkUnsignedCharArrayGetPointVisibilityArray ()
virtual void SetPointVisibilityArray (vtkUnsignedCharArray *pointVisibility)
virtual vtkUnsignedCharArrayGetCellVisibilityArray ()
virtual void SetCellVisibilityArray (vtkUnsignedCharArray *pointVisibility)
virtual void AttachCellVisibilityToCellData ()
virtual void AttachPointVisibilityToPointData ()
virtual unsigned char IsPointVisible (vtkIdType ptId)
virtual unsigned char IsCellVisible (vtkIdType cellId)
virtual unsigned char GetPointBlanking ()
virtual unsigned char GetCellBlanking ()
virtual vtkImageDataNewImageDataCopy ()
virtual vtkCellGetCell (vtkIdType cellId)
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
virtual int GetCellType (vtkIdType cellId)
virtual void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
virtual void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
virtual void Initialize ()
virtual int GetMaxCellSize ()
int Initialize (const vtkAMRBox *def, double *origin, double *spacing, int nGhostsI, int nGhostsJ, int nGhostsK)
virtual void ShallowCopy (vtkDataObject *src)
virtual void DeepCopy (vtkDataObject *src)
virtual void BlankPoint (vtkIdType ptId)
virtual void UnBlankPoint (vtkIdType ptId)
virtual void BlankPoint (const int i, const int j, const int k)
virtual void UnBlankPoint (const int i, const int j, const int k)
virtual void BlankCell (vtkIdType ptId)
virtual void UnBlankCell (vtkIdType ptId)
virtual void BlankCell (const int i, const int j, const int k)
virtual void UnBlankCell (const int i, const int j, const int k)

Static Public Member Functions

static vtkUniformGridGetData (vtkInformation *info)
static vtkUniformGridGetData (vtkInformationVector *v, int i=0)

Protected Member Functions

 vtkUniformGrid ()
 ~vtkUniformGrid ()
void GetCellDims (int cellDims[3])
virtual void ComputeScalarRange ()
void SetPointVisibility (vtkStructuredVisibilityConstraint *pointVisibility)
virtual
vtkStructuredVisibilityConstraint
GetPointVisibility ()
void SetCellVisibility (vtkStructuredVisibilityConstraint *cellVisibility)
virtual
vtkStructuredVisibilityConstraint
GetCellVisibility ()
vtkEmptyCellGetEmptyCell ()

Protected Attributes

vtkStructuredVisibilityConstraintPointVisibility
vtkStructuredVisibilityConstraintCellVisibility
typedef vtkImageData Superclass
static vtkUniformGridNew ()
static int IsTypeOf (const char *type)
static vtkUniformGridSafeDownCast (vtkObjectBase *o)
virtual int IsA (const char *type)
vtkUniformGridNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBaseNewInstanceInternal () const

Detailed Description

image data with blanking

vtkUniformGrid is a subclass of vtkImageData. In addition to all the image data functionality, it supports blanking.

Examples:
vtkUniformGrid (Examples)
Tests:
vtkUniformGrid (Tests)

Definition at line 39 of file vtkUniformGrid.h.


Member Typedef Documentation

Construct an empty uniform grid.

Reimplemented from vtkImageData.

Definition at line 45 of file vtkUniformGrid.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Construct an empty uniform grid.

Reimplemented from vtkImageData.

static int vtkUniformGrid::IsTypeOf ( const char *  type) [static]

Construct an empty uniform grid.

Reimplemented from vtkImageData.

virtual int vtkUniformGrid::IsA ( const char *  type) [virtual]

Construct an empty uniform grid.

Reimplemented from vtkImageData.

Construct an empty uniform grid.

Reimplemented from vtkImageData.

virtual vtkObjectBase* vtkUniformGrid::NewInstanceInternal ( ) const [protected, virtual]

Construct an empty uniform grid.

Reimplemented from vtkImageData.

Construct an empty uniform grid.

Reimplemented from vtkImageData.

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

Construct an empty uniform grid.

Reimplemented from vtkImageData.

virtual void vtkUniformGrid::CopyStructure ( vtkDataSet ds) [virtual]

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

Reimplemented from vtkImageData.

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

Return what type of dataset this is.

Reimplemented from vtkImageData.

Definition at line 54 of file vtkUniformGrid.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

virtual 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.

Reimplemented from vtkImageData.

virtual 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.

Reimplemented from vtkImageData.

virtual 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 vtkImageData.

virtual int vtkUniformGrid::GetCellType ( vtkIdType  cellId) [virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

Definition at line 72 of file vtkUniformGrid.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

Definition at line 75 of file vtkUniformGrid.h.

virtual void vtkUniformGrid::Initialize ( ) [virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

virtual int vtkUniformGrid::GetMaxCellSize ( ) [inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkImageData.

Definition at line 78 of file vtkUniformGrid.h.

Returns the data description of this uniform grid instance.

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing 
)

Initialize with no ghost cell arrays, from the definition in the given box. The box is expetced to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing,
int  nGhosts 
)

Initialize from the definition in the given box, with ghost cell arrays nGhosts cells thick in all directions. The box is expetced to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing,
const int  nGhosts[3] 
)

Initialize from the definition in the given box, with ghost cell arrays of the thickness given in each direction by "nGhosts" array. The box and ghost array are expected to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing,
int  nGhostsI,
int  nGhostsJ,
int  nGhostsK 
)

Construct a uniform grid, from the definition in the given box "def", with ghost cell arrays of the thickness given in each direction by "nGhosts*". The box and ghost array are expected to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

virtual void vtkUniformGrid::ShallowCopy ( vtkDataObject src) [virtual]

Shallow and Deep copy.

Reimplemented from vtkImageData.

virtual void vtkUniformGrid::DeepCopy ( vtkDataObject src) [virtual]

Shallow and Deep copy.

Reimplemented from vtkImageData.

virtual void vtkUniformGrid::BlankPoint ( vtkIdType  ptId) [virtual]

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.

virtual void vtkUniformGrid::UnBlankPoint ( vtkIdType  ptId) [virtual]

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.

virtual void vtkUniformGrid::BlankPoint ( const int  i,
const int  j,
const int  k 
) [virtual]

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.

virtual void vtkUniformGrid::UnBlankPoint ( const int  i,
const int  j,
const int  k 
) [virtual]

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.

virtual void vtkUniformGrid::BlankCell ( vtkIdType  ptId) [virtual]

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.

virtual void vtkUniformGrid::UnBlankCell ( vtkIdType  ptId) [virtual]

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.

virtual void vtkUniformGrid::BlankCell ( const int  i,
const int  j,
const int  k 
) [virtual]

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.

virtual void vtkUniformGrid::UnBlankCell ( const int  i,
const int  j,
const int  k 
) [virtual]

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.

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

virtual void vtkUniformGrid::SetPointVisibilityArray ( vtkUnsignedCharArray pointVisibility) [virtual]

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.

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

virtual void vtkUniformGrid::SetCellVisibilityArray ( vtkUnsignedCharArray pointVisibility) [virtual]

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.

Attaches the CellVisibility array to the Cell data. Used primarily for debugging.

Attaches the PointVisibility arry to the Point data. Used primarily for debugging.

virtual unsigned char vtkUniformGrid::IsPointVisible ( vtkIdType  ptId) [virtual]

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

virtual unsigned char vtkUniformGrid::IsCellVisible ( vtkIdType  cellId) [virtual]

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

virtual unsigned char vtkUniformGrid::GetPointBlanking ( ) [virtual]

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

virtual unsigned char vtkUniformGrid::GetCellBlanking ( ) [virtual]

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

Retrieve an instance of this class from an information object.

Reimplemented from vtkImageData.

static vtkUniformGrid* vtkUniformGrid::GetData ( vtkInformationVector v,
int  i = 0 
) [static]

Retrieve an instance of this class from an information object.

Reimplemented from vtkImageData.

void vtkUniformGrid::GetCellDims ( int  cellDims[3]) [protected]

Returns the cell dimensions for this vtkUniformGrid instance.

virtual void vtkUniformGrid::ComputeScalarRange ( ) [protected, virtual]

Override this method because of blanking.

Reimplemented from vtkDataSet.


Member Data Documentation

Definition at line 199 of file vtkUniformGrid.h.

Definition at line 202 of file vtkUniformGrid.h.


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