vtkCell.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkCell.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 vtkCell_h
#define vtkCell_h
 
#define VTK_CELL_SIZE 512
#define VTK_TOL 1.e-05 // Tolerance for geometric calculation
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
#include "vtkIdList.h" // Needed for inline methods
#include "vtkCellType.h" // Needed to define cell types
 
class vtkCellArray;
class vtkCellData;
class vtkDataArray;
class vtkPointData;
class vtkIncrementalPointLocator;
class vtkPoints;
 
class VTKCOMMONDATAMODEL_EXPORT vtkCell : public vtkObject
{
public:
  vtkTypeMacro(vtkCell,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  void Initialize(int npts, vtkIdType *pts, vtkPoints *p);
 
  virtual void ShallowCopy(vtkCell *c);
 
  virtual void DeepCopy(vtkCell *c);
 
  virtual int GetCellType() = 0;
 
  virtual int GetCellDimension() = 0;
 
  virtual int IsLinear() {return 1;}
 
 
  virtual int RequiresInitialization() {return 0;}
  virtual void Initialize() {}
 
  virtual int IsExplicitCell() {return 0;}
 
 
  virtual int RequiresExplicitFaceRepresentation() {return 0;}
  virtual void SetFaces(vtkIdType *vtkNotUsed(faces)) {}
  virtual vtkIdType *GetFaces() {return NULL;}
 
  vtkPoints *GetPoints() {return this->Points;}
 
  vtkIdType GetNumberOfPoints() {return this->PointIds->GetNumberOfIds();}
 
  virtual int GetNumberOfEdges() = 0;
 
  virtual int GetNumberOfFaces() = 0;
 
  vtkIdList *GetPointIds() {return this->PointIds;}
 
  vtkIdType GetPointId(int ptId) {return this->PointIds->GetId(ptId);}
 
  virtual vtkCell *GetEdge(int edgeId) = 0;
 
  virtual vtkCell *GetFace(int faceId) = 0;
 
  virtual int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) = 0;
 
 
  virtual int EvaluatePosition(double x[3], double* closestPoint,
                               int& subId, double pcoords[3],
                               double& dist2, double *weights) = 0;
 
 
  virtual void EvaluateLocation(int& subId, double pcoords[3],
                                double x[3], double *weights) = 0;
 
 
  virtual void Contour(double value, vtkDataArray *cellScalars,
                       vtkIncrementalPointLocator *locator, vtkCellArray *verts,
                       vtkCellArray *lines, vtkCellArray *polys,
                       vtkPointData *inPd, vtkPointData *outPd,
                       vtkCellData *inCd, vtkIdType cellId,
                       vtkCellData *outCd) = 0;
 
 
  virtual void Clip(double value, vtkDataArray *cellScalars,
                    vtkIncrementalPointLocator *locator, vtkCellArray *connectivity,
                    vtkPointData *inPd, vtkPointData *outPd,
                    vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd,
                    int insideOut) = 0;
 
 
  virtual int IntersectWithLine(double p1[3], double p2[3],
                                double tol, double& t, double x[3],
                                double pcoords[3], int& subId) = 0;
 
  virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) = 0;
 
 
  virtual void Derivatives(int subId, double pcoords[3], double *values,
                           int dim, double *derivs) = 0;
 
 
  void GetBounds(double bounds[6]);
 
 
  double *GetBounds();
 
 
  double GetLength2();
 
 
  virtual int GetParametricCenter(double pcoords[3]);
 
 
  virtual double GetParametricDistance(double pcoords[3]);
 
 
  virtual int IsPrimaryCell() {return 1;}
 
 
  virtual double *GetParametricCoords();
 
 
  virtual void InterpolateFunctions(double vtkNotUsed(pcoords)[3], double* vtkNotUsed(weight))
    {
    }
  virtual void InterpolateDerivs(double vtkNotUsed(pcoords)[3], double* vtkNotUsed(derivs))
    {
    }
 
  // left public for quick computational access
  vtkPoints *Points;
  vtkIdList *PointIds;
 
protected:
  vtkCell();
  ~vtkCell();
 
  double Bounds[6];
 
private:
  vtkCell(const vtkCell&);  // Not implemented.
  void operator=(const vtkCell&);  // Not implemented.
};
 
#endif