---

common/vtkFieldData.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkFieldData.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 __vtkFieldData_h
#define __vtkFieldData_h

#include "vtkDataArray.h"
#include "vtkIdList.h"

class VTK_EXPORT vtkFieldData : public vtkObject
{
public:
  static vtkFieldData *New();

  vtkTypeMacro(vtkFieldData,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  void Initialize();

  int Allocate(const int sz, const int ext=1000);

  vtkFieldData *MakeObject();

  void SetNumberOfArrays(int num);

  void SetArray(int i, vtkDataArray *);

  int GetNumberOfArrays();

  vtkDataArray *GetArray(int i);

  int AddArray(vtkDataArray *array);

  int AddArray(vtkDataArray *array, const char *name);

  int AddReplaceArray(vtkDataArray *array, const char *name);

  int AddNoReplaceArray(vtkDataArray *array, const char *name);

  int GetArrayContainingComponent(int i, int& arrayComp);

  vtkDataArray *GetArray(const char *arrayName);

  vtkDataArray *GetArray(const char *arrayName, int &index);

  void SetArrayName(int i,const char *name);
  char *GetArrayName(int i);

  int GetNumberOfComponents();

  int GetNumberOfTuples();

  void SetNumberOfTuples(const int number);

  float *GetTuple(const int i);

  void GetTuple(const int i, float * tuple);

  void SetTuple(const int i, const float * tuple);

  void InsertTuple(const int i, const float * tuple);

  int InsertNextTuple(const float * tuple);

  float GetComponent(const int i, const int j);

  void SetComponent(const int i, const int j, const float c);
  
  void InsertComponent(const int i, const int j, const float c);

  void DeepCopy(vtkFieldData *da);

  void ShallowCopy(vtkFieldData *da);

  void Squeeze();

  void Reset();

  void GetField(vtkIdList *ptId, vtkFieldData *f);

  virtual unsigned long GetActualMemorySize();
  
#ifndef VTK_REMOVE_LEGACY_CODE

  void DeepCopy(vtkFieldData &da) 
    {VTK_LEGACY_METHOD(DeepCopy,"3.2"); this->DeepCopy(&da);}
  void ShallowCopy(vtkFieldData &da) 
    {VTK_LEGACY_METHOD(ShallowCopy,"3.2"); this->ShallowCopy(&da);}
  void GetField(vtkIdList& ptId, vtkFieldData& f) 
    {VTK_LEGACY_METHOD(GetField,"3.2"); this->GetField(&ptId, &f);}
#endif
  
protected:
  vtkFieldData();
  ~vtkFieldData();
  vtkFieldData(const vtkFieldData&) {};
  void operator=(const vtkFieldData&) {};

  int NumberOfArrays;
  vtkDataArray **Data;
  char **ArrayNames;

  int TupleSize; //used for type conversion
  float *Tuple;
};

#endif

---