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) override;
 
  void CopyStructure(vtkDataSet* ds) override;
 
  int GetDataObjectType() override { return VTK_UNIFORM_GRID; }
 
 
  vtkCell* GetCell(int i, int j, int k) override;
  vtkCell* GetCell(vtkIdType cellId) override;
  void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
  vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
    double pcoords[3], double* weights) override;
  vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
    double tol2, int& subId, double pcoords[3], double* weights) override;
  vtkCell* FindAndGetCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
    double pcoords[3], double* weights) override;
  int GetCellType(vtkIdType cellId) override;
  using vtkDataSet::GetCellPoints;
  void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) override
  {
    vtkStructuredData::GetCellPoints(
      cellId, ptIds, this->GetDataDescription(), this->GetDimensions());
  }
  void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override
  {
    vtkStructuredData::GetPointCells(ptId, cellIds, this->GetDimensions());
  }
  void Initialize() override;
  int GetMaxCellSize() override { return 8; } // voxel is the largest
 
  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]);
  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhostsI, int nGhostsJ,
    int nGhostsK);
 
 
  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);
 
  bool HasAnyBlankCells() override;
  bool HasAnyBlankPoints() override;
 
  virtual unsigned char IsPointVisible(vtkIdType pointId);
 
  virtual unsigned char IsCellVisible(vtkIdType cellId);
 
  virtual vtkImageData* NewImageDataCopy();
 
 
  static vtkUniformGrid* GetData(vtkInformation* info);
  static vtkUniformGrid* GetData(vtkInformationVector* v, int i = 0);
 
protected:
  vtkUniformGrid();
  ~vtkUniformGrid() override;
 
  void GetCellDims(int cellDims[3]);
 
  void ComputeScalarRange() override;
 
  vtkEmptyCell* GetEmptyCell();
 
private:
  vtkUniformGrid(const vtkUniformGrid&) = delete;
  void operator=(const vtkUniformGrid&) = delete;
 
  vtkEmptyCell* EmptyCell;
 
  static unsigned char MASKED_CELL_VALUE;
};
 
#endif