Common/vtkUniformGrid.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkUniformGrid.h,v $
  Language:  C++

  Copyright (c) 1993-2002 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 "vtkDataSet.h"

#include "vtkStructuredData.h" // Needed for inline methods

class vtkDataArray;
class vtkEmptyCell;
class vtkImageData;
class vtkLine;
class vtkPixel;
class vtkVertex;
class vtkVoxel;
class vtkStructuredVisibilityConstraint;
class vtkUnsignedCharArray;

class VTK_COMMON_EXPORT vtkUniformGrid : public vtkDataSet
{
public:
  static vtkUniformGrid *New();

  vtkTypeRevisionMacro(vtkUniformGrid,vtkDataSet);
  void PrintSelf(ostream& os, vtkIndent indent);

  void CopyStructure(vtkDataSet *ds);

  int GetDataObjectType() {return VTK_UNIFORM_GRID;};


  vtkIdType GetNumberOfCells();
  vtkIdType GetNumberOfPoints();
  double *GetPoint(vtkIdType ptId);
  void GetPoint(vtkIdType id, double x[3]);
  vtkCell *GetCell(vtkIdType cellId);
  void GetCell(vtkIdType cellId, vtkGenericCell *cell);
  void GetCellBounds(vtkIdType cellId, double bounds[6]);
  vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, 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);
  vtkCell *FindAndGetCell(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)
    {vtkStructuredData::GetCellPoints(cellId,ptIds,this->DataDescription,
                                      this->GetDimensions());}
  void GetPointCells(vtkIdType ptId, vtkIdList *cellIds)
    {vtkStructuredData::GetPointCells(ptId,cellIds,this->GetDimensions());}
  void ComputeBounds();
  void Initialize();
  int GetMaxCellSize() {return 8;}; //voxel is the largest
  virtual void GetScalarRange(double range[2]);
  double *GetScalarRange() {return this->Superclass::GetScalarRange();}


  void SetUpdateExtent(int piece, int numPieces, int ghostLevel);
  void SetUpdateExtent(int piece, int numPieces)
    {this->SetUpdateExtent(piece, numPieces, 0);}


  void SetUpdateExtent( int x1, int x2, int y1, int y2, int z1, int z2 )
    { this->Superclass::SetUpdateExtent( x1, x2, y1, y2, z1, z2 ); };
  void SetUpdateExtent( int ext[6] )
    { this->Superclass::SetUpdateExtent( ext ); };

  void SetDimensions(int i, int j, int k);

  void SetDimensions(int dims[3]);


  int *GetDimensions();
  void GetDimensions(int dims[3]);

  int ComputeStructuredCoordinates(double x[3], int ijk[3], double pcoords[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();
  

  vtkSetVector3Macro(Spacing,double);
  vtkGetVector3Macro(Spacing,double);
  

  vtkSetVector3Macro(Origin,double);
  vtkGetVector3Macro(Origin,double);
  

  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);
  
  vtkUnsignedCharArray *GetPointVisibilityArray(); 

  void SetPointVisibilityArray(vtkUnsignedCharArray *pointVisibility);

  vtkUnsignedCharArray *GetCellVisibilityArray(); 

  void SetCellVisibilityArray(vtkUnsignedCharArray *pointVisibility);

  unsigned char IsPointVisible(vtkIdType ptId);
  
  unsigned char IsCellVisible(vtkIdType cellId);

  unsigned char GetPointBlanking();

  unsigned char GetCellBlanking();

protected:
  vtkUniformGrid();
  ~vtkUniformGrid();

  // for the GetCell method
  vtkVertex *Vertex;
  vtkLine *Line;
  vtkPixel *Pixel;
  vtkVoxel *Voxel;
  vtkEmptyCell *EmptyCell;

  // The extent of what is currently in the structured grid.
  // Dimensions is just an array to return a value.
  // Its contents are out of data until GetDimensions is called.
  int Dimensions[3];
  int DataDescription;

  double Origin[3];
  double Spacing[3];

  vtkStructuredVisibilityConstraint* PointVisibility;

  void SetPointVisibility(vtkStructuredVisibilityConstraint *pointVisibility);
  vtkGetObjectMacro(PointVisibility, vtkStructuredVisibilityConstraint);

  vtkStructuredVisibilityConstraint* CellVisibility;

  void SetCellVisibility(vtkStructuredVisibilityConstraint *cellVisibility);
  vtkGetObjectMacro(CellVisibility, vtkStructuredVisibilityConstraint);

private:
  void InternalUniformGridCopy(vtkUniformGrid *src);
  void InternalUniformGridCopy(vtkImageData *src);
private:
  vtkUniformGrid(const vtkUniformGrid&);  // Not implemented.
  void operator=(const vtkUniformGrid&);  // Not implemented.
};


inline void vtkUniformGrid::GetPoint(vtkIdType id, double x[3])
{
  double *p=this->GetPoint(id);
  x[0] = p[0]; x[1] = p[1]; x[2] = p[2];
}



inline vtkIdType vtkUniformGrid::GetNumberOfPoints()
{
  int *dims = this->GetDimensions();
  return dims[0]*dims[1]*dims[2];
}

inline int vtkUniformGrid::GetDataDimension()
{
  return vtkStructuredData::GetDataDimension(this->DataDescription);
}

#endif

Generated on Tue May 23 11:05:11 2006 for VTK by Doxygen 1.3.5