Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

common/vtkDataArray.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkDataArray.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00069 #ifndef __vtkDataArray_h
00070 #define __vtkDataArray_h
00071 
00072 #include "vtkObject.h"
00073 
00074 class vtkFloatArray;
00075 
00076 class VTK_EXPORT vtkDataArray : public vtkObject 
00077 {
00078 public:
00079   vtkTypeMacro(vtkDataArray,vtkObject);
00080   void PrintSelf(ostream& os, vtkIndent indent);
00081 
00082   virtual int Allocate(const int sz, const int ext=1000) = 0;
00083   virtual void Initialize() = 0;
00084 
00088   virtual vtkDataArray *MakeObject() = 0;
00089 
00092   virtual int GetDataType() = 0;
00093 
00096   vtkSetClampMacro(NumberOfComponents,int,1,VTK_LARGE_INTEGER);
00097   int GetNumberOfComponents() {return this->NumberOfComponents;};
00098 
00101   virtual void SetNumberOfTuples(const int number) = 0;
00102 
00104   int GetNumberOfTuples() 
00105     {return (this->MaxId + 1)/this->NumberOfComponents;}
00106 
00111   virtual float *GetTuple(const int i) = 0;
00112 
00116   virtual void GetTuple(const int i, float * tuple) = 0;
00117   virtual void GetTuple(const int i, double * tuple);
00118 
00122   virtual void SetTuple(const int i, const float * tuple) = 0;
00123   virtual void SetTuple(const int i, const double * tuple);
00124 
00127   virtual void InsertTuple(const int i, const float * tuple) = 0;
00128   virtual void InsertTuple(const int i, const double * tuple);
00129 
00133   virtual int InsertNextTuple(const float * tuple) = 0;
00134   virtual int InsertNextTuple(const double * tuple);
00135 
00139   virtual float GetComponent(const int i, const int j);
00140 
00145   virtual void SetComponent(const int i, const int j, const float c);
00146 
00150   virtual void InsertComponent(const int i, const int j, const float c);
00151 
00158   virtual void GetData(int tupleMin, int tupleMax, int compMin, int compMax, 
00159              vtkFloatArray &data);
00160 
00163   virtual void DeepCopy(vtkDataArray *da);
00164 
00167   virtual void *GetVoidPointer(const int id) = 0;
00168 
00170   virtual void Squeeze() = 0;
00171   
00173   void Reset() 
00174     {this->MaxId = -1;}
00175 
00177   int GetSize() 
00178     {return this->Size;}
00179   
00181   int GetMaxId() 
00182     {return this->MaxId;}
00183 
00186   int GetExtend() 
00187     {return this->Extend;}
00188 
00195   virtual void SetVoidArray(void *vtkNotUsed(array),int vtkNotUsed(size),
00196              int vtkNotUsed(save)) {};
00197 
00204   unsigned long GetActualMemorySize();
00205   
00206 #ifndef VTK_REMOVE_LEGACY_CODE
00207 
00208   void DeepCopy(vtkDataArray &da) 
00209     {VTK_LEGACY_METHOD(DeepCopy,"3.2"); this->DeepCopy(&da);}
00210 #endif
00211   
00212 protected:
00213   // Construct object with default tuple dimension (number of components) of 1.
00214   vtkDataArray(int numComp=1);
00215   ~vtkDataArray() {};
00216   vtkDataArray(const vtkDataArray&) {};
00217   void operator=(const vtkDataArray&) {};
00218 
00219   int Size;      // allocated size of data
00220   int MaxId;     // maximum index inserted thus far
00221   int Extend;    // grow array by this amount
00222   int NumberOfComponents; // the number of components per tuple
00223 };
00224 
00225 #endif

Generated on Wed Nov 21 12:26:51 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001