---

common/vtkDataSet.h

Go to the documentation of this file.

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

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


Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
   of any contributors may be used to endorse or promote products derived
   from this software without specific prior written permission.

 * Modified source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef __vtkDataSet_h
#define __vtkDataSet_h

#include "vtkDataObject.h"
#include "vtkCellData.h"
#include "vtkPointData.h"
#include "vtkGenericCell.h"
#include "vtkCellTypes.h"

class VTK_EXPORT vtkDataSet : public vtkDataObject
{
public:
  vtkTypeMacro(vtkDataSet,vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  
  virtual void CopyStructure(vtkDataSet *ds) = 0;

  virtual int GetNumberOfPoints() = 0;

  virtual int GetNumberOfCells() = 0;

  virtual float *GetPoint(int ptId) = 0;

  virtual void GetPoint(int id, float x[3]);

  virtual vtkCell *GetCell(int cellId) = 0;

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

  virtual void GetCellBounds(int cellId, float bounds[6]);
  
  virtual int GetCellType(int cellId) = 0;

  virtual void GetCellTypes(vtkCellTypes *types);

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

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

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

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

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

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

  unsigned long int GetMTime();

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

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

  virtual void Squeeze();

  virtual void ComputeBounds();

  float *GetBounds();

  void GetBounds(float bounds[6]);

  float *GetCenter();

  void GetCenter(float center[3]);
  
  float GetLength();

  void Initialize();

  void GetScalarRange(float range[2]);

  float *GetScalarRange();
  
  virtual int GetMaxCellSize() = 0;

  unsigned long GetActualMemorySize();
  
  int GetDataObjectType() 
    {return VTK_DATA_SET;}
  
  void ShallowCopy(vtkDataObject *src);  
  void DeepCopy(vtkDataObject *src);
  
#ifndef VTK_REMOVE_LEGACY_CODE

  void GetCellPoints(int cellId, vtkIdList &ptIds)
    {VTK_LEGACY_METHOD(GetCellPoints,"3.2"); this->GetCellPoints(cellId, &ptIds);}
  void GetPointCells(int ptId, vtkIdList &cellIds)
    {VTK_LEGACY_METHOD(GetPointCells,"3.2"); this->GetPointCells(ptId, &cellIds);}
  void GetCellNeighbors(int cellId, vtkIdList& ptIds, vtkIdList& cellIds)
    {VTK_LEGACY_METHOD(GetCellNeighbors,"3.2"); this->GetCellNeighbors(cellId, &ptIds, &cellIds);}
  virtual int GetDataSetType() 
    {VTK_LEGACY_METHOD(GetDataSetType,"3.2"); return this->GetDataObjectType();}
#endif
  
protected:
  // Constructor with default bounds (0,1, 0,1, 0,1).
  vtkDataSet();
  ~vtkDataSet();  
  vtkDataSet(const vtkDataSet&) {};
  void operator=(const vtkDataSet&) {};  

  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
  float Bounds[6];  // (xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds
  float ScalarRange[2];
  float Center[3];

private:
  void InternalDataSetCopy(vtkDataSet *src);  
};

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

#endif

---