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

common/vtkUnsignedCharArray.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkUnsignedCharArray.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 =========================================================================*/
00054 #ifndef __vtkUnsignedCharArray_h
00055 #define __vtkUnsignedCharArray_h
00056 
00057 #include "vtkDataArray.h"
00058 
00059 class VTK_EXPORT vtkUnsignedCharArray : public vtkDataArray
00060 {
00061 public:
00062   static vtkUnsignedCharArray *New();
00063 
00064   vtkTypeMacro(vtkUnsignedCharArray,vtkDataArray);
00065   void PrintSelf(ostream& os, vtkIndent indent);
00066 
00068   int Allocate(const int sz, const int ext=1000);
00069 
00071   void Initialize();
00072 
00074   vtkDataArray *MakeObject();
00075 
00077   int GetDataType() {return VTK_UNSIGNED_CHAR;};
00078 
00080   void SetNumberOfTuples(const int number);
00081 
00084   float *GetTuple(const int i);
00085 
00087   void GetTuple(const int i, float * tuple);
00088   void GetTuple(const int i, double * tuple);
00089 
00091   void SetTuple(const int i, const float * tuple);
00092   void SetTuple(const int i, const double * tuple);
00093 
00096   void InsertTuple(const int i, const float * tuple);
00097   void InsertTuple(const int i, const double * tuple);
00098 
00101   int InsertNextTuple(const float * tuple);
00102   int InsertNextTuple(const double * tuple);
00103 
00105   void Squeeze() {this->Resize (this->MaxId+1);};
00106 
00110   float GetComponent(const int i, const int j);
00111 
00116   void SetComponent(const int i, const int j, const float c);
00117 
00121   void InsertComponent(const int i, const int j, const float c);
00122 
00124   unsigned char GetValue(const int id) {return this->Array[id];};
00125 
00128   void SetValue(const int id, const unsigned char value) {
00129     this->Array[id] = value;};
00130 
00134   void SetNumberOfValues(const int number);
00135 
00137   void InsertValue(const int id, const unsigned char c);
00138 
00141   int InsertNextValue(const unsigned char c);
00142 
00145   unsigned char *GetPointer(const int id) {return this->Array + id;}
00146   void *GetVoidPointer(const int id) {return (void *)this->GetPointer(id);};
00147 
00151   unsigned char *WritePointer(const int id, const int number);
00152   
00154   void DeepCopy(vtkDataArray *da);
00155 
00162   void SetArray(unsigned char* array, int size, int save);
00163   void SetVoidArray(void *array,int size, int save) 
00164     {this->SetArray((unsigned char*)array, size, save);};
00165 
00166 #ifndef VTK_REMOVE_LEGACY_CODE
00167 
00168   void DeepCopy(vtkDataArray &da) 
00169     {VTK_LEGACY_METHOD(DeepCopy,"3.2"); this->DeepCopy(&da);}
00170 #endif
00171   
00172 
00173 protected:
00174   vtkUnsignedCharArray(int numComp=1);
00175   ~vtkUnsignedCharArray();
00176   vtkUnsignedCharArray(const vtkUnsignedCharArray&) {};
00177   void operator=(const vtkUnsignedCharArray&) {};
00178 
00179   unsigned char *Array;   // pointer to data
00180   unsigned char *Resize(const int sz);  // function to resize data
00181 
00182   int TupleSize; //used for data conversion
00183   float *Tuple;
00184 
00185   int SaveUserArray;
00186 };
00187 
00188 inline void vtkUnsignedCharArray::SetNumberOfValues(const int number) 
00189 {
00190   this->Allocate(number);
00191   this->MaxId = number - 1;
00192 }
00193 
00194 inline unsigned char *vtkUnsignedCharArray::WritePointer(const int id, const int number) 
00195 {
00196   int newSize=id+number;
00197   if ( newSize > this->Size )
00198     {
00199     this->Resize(newSize);
00200     }
00201   if ( (--newSize) > this->MaxId )
00202     {
00203     this->MaxId = newSize;
00204     }
00205   return this->Array + id;
00206 }
00207 
00208 inline void vtkUnsignedCharArray::InsertValue(const int id, const unsigned char c)
00209 {
00210   if ( id >= this->Size )
00211     {
00212     this->Resize(id+1);
00213     }
00214   this->Array[id] = c;
00215   if ( id > this->MaxId )
00216     {
00217     this->MaxId = id;
00218     }
00219 }
00220 
00221 inline int vtkUnsignedCharArray::InsertNextValue(const unsigned char c)
00222 {
00223   this->InsertValue (++this->MaxId,c); 
00224   return this->MaxId;
00225 }
00226 
00227 
00228 #endif

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