vtkUniformGrid.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkUniformGrid.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkUniformGrid_h
#define vtkUniformGrid_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkImageData.h"
 
class vtkEmptyCell;
class vtkStructuredVisibilityConstraint;
class vtkUnsignedCharArray;
class vtkAMRBox;
 
class VTKCOMMONDATAMODEL_EXPORT vtkUniformGrid : public vtkImageData
{
public:
 
  static vtkUniformGrid *New();
  vtkTypeMacro(vtkUniformGrid,vtkImageData);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  virtual void CopyStructure(vtkDataSet *ds);
 
  virtual int GetDataObjectType() {return VTK_UNIFORM_GRID;};
 
 
  virtual vtkCell *GetCell(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 vtkCell *FindAndGetCell(
    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)
    {vtkStructuredData::GetCellPoints(cellId,ptIds,this->GetDataDescription(),
                                      this->GetDimensions());}
  virtual void GetPointCells(vtkIdType ptId, vtkIdList *cellIds)
    {vtkStructuredData::GetPointCells(ptId,cellIds,this->GetDimensions());}
  virtual void Initialize();
  virtual int GetMaxCellSize() {return 8;}; //voxel is the largest
 
  int GetGridDescription();
 
  //  BTX
  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]);
 
  int Initialize(const vtkAMRBox *def, double* origin, double* spacing, int nGhostsI,int nGhostsJ,int nGhostsK);
  //ETX
 
 
  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 );
 
  virtual bool HasAnyBlankCells();
  virtual bool HasAnyBlankPoints();
 
  virtual unsigned char IsPointVisible(vtkIdType ptId);
 
  virtual unsigned char IsCellVisible(vtkIdType cellId);
 
  virtual vtkImageData* NewImageDataCopy();
 
  //BTX
 
  static vtkUniformGrid* GetData(vtkInformation* info);
  static vtkUniformGrid* GetData(vtkInformationVector* v, int i=0);
  //ETX
 
protected:
  vtkUniformGrid();
  ~vtkUniformGrid();
 
  void GetCellDims( int cellDims[3] );
 
  virtual void ComputeScalarRange();
 
  vtkEmptyCell* GetEmptyCell();
 
private:
  vtkUniformGrid(const vtkUniformGrid&);  // Not implemented.
  void operator=(const vtkUniformGrid&);  // Not implemented.
 
  vtkEmptyCell *EmptyCell;
 
  static unsigned char MASKED_CELL_VALUE;
};
 
 
#endif