vtkStructuredGrid.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkStructuredGrid.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 vtkStructuredGrid_h
#define vtkStructuredGrid_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkPointSet.h"
 
#include "vtkStructuredData.h" // Needed for inline methods
 
class vtkEmptyCell;
class vtkHexahedron;
class vtkLine;
class vtkQuad;
class vtkUnsignedCharArray;
class vtkVertex;
 
class VTKCOMMONDATAMODEL_EXPORT vtkStructuredGrid : public vtkPointSet
{
public:
  static vtkStructuredGrid *New();
 
  vtkTypeMacro(vtkStructuredGrid,vtkPointSet);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  int GetDataObjectType() {return VTK_STRUCTURED_GRID;}
 
  void CopyStructure(vtkDataSet *ds);
 
 
  vtkIdType GetNumberOfPoints() {return vtkPointSet::GetNumberOfPoints();}
  double *GetPoint(vtkIdType ptId) {return this->vtkPointSet::GetPoint(ptId);}
  void GetPoint(vtkIdType ptId, double p[3])
    {this->vtkPointSet::GetPoint(ptId,p);}
  vtkCell *GetCell(vtkIdType cellId);
  void GetCell(vtkIdType cellId, vtkGenericCell *cell);
  void GetCellBounds(vtkIdType cellId, double bounds[6]);
  int GetCellType(vtkIdType cellId);
  vtkIdType GetNumberOfCells();
  void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds);
  void GetPointCells(vtkIdType ptId, vtkIdList *cellIds)
    {
      vtkStructuredData::GetPointCells(ptId,cellIds,this->GetDimensions());
    }
  void Initialize();
  int GetMaxCellSize() {return 8;}; //hexahedron is the largest
  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 dim[3]);
 
  int GetDataDimension();
 
 
  void SetExtent(int extent[6]);
  void SetExtent(int x1, int x2, int y1, int y2, int z1, int z2);
  vtkGetVector6Macro(Extent, int);
 
  unsigned long GetActualMemorySize();
 
 
  void ShallowCopy(vtkDataObject *src);
  void DeepCopy(vtkDataObject *src);
 
  int GetExtentType() { return VTK_3D_EXTENT; }
 
 
  void BlankPoint(vtkIdType ptId);
  void UnBlankPoint(vtkIdType ptId);
 
 
  void BlankCell(vtkIdType ptId);
  void UnBlankCell(vtkIdType ptId);
 
  unsigned char IsPointVisible(vtkIdType ptId);
 
  unsigned char IsCellVisible(vtkIdType cellId);
 
  virtual bool HasAnyBlankPoints();
  virtual bool HasAnyBlankCells();
 
  void GetCellDims( int cellDims[3] );
 
  virtual void Crop(const int* updateExtent);
 
  //BTX
 
  static vtkStructuredGrid* GetData(vtkInformation* info);
  static vtkStructuredGrid* GetData(vtkInformationVector* v, int i=0);
  //ETX
 
  void GetPoint(int i, int j, int k, double p[3], bool adjustForExtent = true);
 
protected:
  vtkStructuredGrid();
  ~vtkStructuredGrid();
 
  // for the GetCell method
  vtkVertex *Vertex;
  vtkLine *Line;
  vtkQuad *Quad;
  vtkHexahedron *Hexahedron;
  vtkEmptyCell *EmptyCell;
 
  int Dimensions[3];
  int DataDescription;
 
  int Extent[6];
 
  virtual void ComputeScalarRange();
 
private:
 
  void GetCellNeighbors(vtkIdType cellId, vtkIdList& ptIds, vtkIdList& cellIds)
    {this->GetCellNeighbors(cellId, &ptIds, &cellIds);}
 
  // Internal method used by DeepCopy and ShallowCopy.
  void InternalStructuredGridCopy(vtkStructuredGrid *src);
 
  static unsigned char MASKED_CELL_VALUE;
 
private:
  vtkStructuredGrid(const vtkStructuredGrid&);  // Not implemented.
  void operator=(const vtkStructuredGrid&);  // Not implemented.
};
 
 
inline vtkIdType vtkStructuredGrid::GetNumberOfCells()
{
  int nCells=1;
  int dims[3];
  int i;
 
  this->GetDimensions(dims);
  for (i=0; i<3; i++)
    {
    if (dims[i] <= 0)
      {
      return 0;
      }
    if (dims[i] > 1)
      {
      nCells *= (dims[i]-1);
      }
    }
 
  return nCells;
}
 
inline int vtkStructuredGrid::GetDataDimension()
{
  return vtkStructuredData::GetDataDimension(this->DataDescription);
}
 
#endif