dox/Common/DataModel/vtkDataSet.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkDataSet.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 __vtkDataSet_h
#define __vtkDataSet_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"

class vtkCell;
class vtkCellData;
class vtkCellIterator;
class vtkCellTypes;
class vtkExtentTranslator;
class vtkGenericCell;
class vtkIdList;
class vtkPointData;

class VTKCOMMONDATAMODEL_EXPORT vtkDataSet : public vtkDataObject
{
public:
  vtkTypeMacro(vtkDataSet,vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  virtual void CopyStructure(vtkDataSet *ds) = 0;

  virtual void CopyAttributes(vtkDataSet *ds);

  virtual vtkIdType GetNumberOfPoints() = 0;

  virtual vtkIdType GetNumberOfCells() = 0;

  virtual double *GetPoint(vtkIdType ptId) = 0;

  virtual void GetPoint(vtkIdType id, double x[3]);

  virtual vtkCellIterator* NewCellIterator();

  virtual vtkCell *GetCell(vtkIdType cellId) = 0;

  virtual void GetCell(vtkIdType cellId, vtkGenericCell *cell) = 0;

  virtual void GetCellBounds(vtkIdType cellId, double bounds[6]);

  virtual int GetCellType(vtkIdType cellId) = 0;

  virtual void GetCellTypes(vtkCellTypes *types);

  virtual void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds) = 0;

  virtual void GetPointCells(vtkIdType ptId, vtkIdList *cellIds) = 0;


  virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds,
                                vtkIdList *cellIds);


  vtkIdType FindPoint(double x, double y, double z)
    {
    double xyz[3];
    xyz[0] = x; xyz[1] = y; xyz[2] = z;
    return this->FindPoint (xyz);
    }
  virtual vtkIdType FindPoint(double x[3]) = 0;


  virtual vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId,
                             double tol2, int& subId, double pcoords[3],
                             double *weights) = 0;


  virtual vtkIdType FindCell(double x[3], vtkCell *cell,
                             vtkGenericCell *gencell, vtkIdType cellId,
                             double tol2, int& subId, double pcoords[3],
                             double *weights) = 0;


  virtual vtkCell *FindAndGetCell(double x[3], vtkCell *cell, vtkIdType cellId,
                                  double tol2, int& subId, double pcoords[3],
                                  double *weights);

  unsigned long int GetMTime();

  vtkCellData *GetCellData() {return this->CellData;};

  vtkPointData *GetPointData() {return this->PointData;};

  virtual void Squeeze();

  virtual void ComputeBounds();

  double *GetBounds();

  void GetBounds(double bounds[6]);

  double *GetCenter();

  void GetCenter(double center[3]);

  double GetLength();

  void Initialize();

  virtual void GetScalarRange(double range[2]);

  double *GetScalarRange();

  virtual int GetMaxCellSize() = 0;

  unsigned long GetActualMemorySize();


  int GetDataObjectType()
    {return VTK_DATA_SET;}


  void ShallowCopy(vtkDataObject *src);
  void DeepCopy(vtkDataObject *src);

//BTX
  enum FieldDataType
  {
    DATA_OBJECT_FIELD=0,
    POINT_DATA_FIELD=1,
    CELL_DATA_FIELD=2
  };
//ETX

  int CheckAttributes();


  virtual void GenerateGhostLevelArray(int update_piece,
                                       int update_num_pieces,
                                       int update_ghost_level,
                                       int* whole_extent,
                                       vtkExtentTranslator* translator);

  //BTX

  static vtkDataSet* GetData(vtkInformation* info);
  static vtkDataSet* GetData(vtkInformationVector* v, int i=0);
  //ETX

  virtual vtkFieldData* GetAttributesAsFieldData(int type);

  virtual vtkIdType GetNumberOfElements(int type);

protected:
  // Constructor with default bounds (0,1, 0,1, 0,1).
  vtkDataSet();
  ~vtkDataSet();

  virtual void ComputeScalarRange();

  vtkCellData *CellData;   // Scalars, vectors, etc. associated w/ each cell
  vtkPointData *PointData;   // Scalars, vectors, etc. associated w/ each point
  vtkTimeStamp ComputeTime; // Time at which bounds, center, etc. computed
  double Bounds[6];  // (xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds
  double Center[3];

  // Cached scalar range
  double ScalarRange[2];

  // Time at which scalar range is computed
  vtkTimeStamp ScalarRangeComputeTime;

private:
  void InternalDataSetCopy(vtkDataSet *src);
  //BTX
  friend class vtkImageAlgorithmToDataSetFriendship;
  //ETX
private:
  vtkDataSet(const vtkDataSet&);  // Not implemented.
  void operator=(const vtkDataSet&);    // Not implemented.
};

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

#endif