Common/vtkCharArray.h

Go to the documentation of this file.

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

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

  Copyright (c) 1993-2002 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 __vtkCharArray_h
#define __vtkCharArray_h

#include "vtkDataArray.h"

class VTK_COMMON_EXPORT vtkCharArray : public vtkDataArray
{
public:
  static vtkCharArray *New();

  vtkTypeRevisionMacro(vtkCharArray,vtkDataArray);
  void PrintSelf(ostream& os, vtkIndent indent);

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

  void Initialize();
  
  int GetDataType() {return VTK_CHAR;};
  
  int GetDataTypeSize() { return sizeof(char); }

  void SetNumberOfTuples(const vtkIdType number);

  float *GetTuple(const vtkIdType i);


  void GetTuple(const vtkIdType i, float * tuple);
  void GetTuple(const vtkIdType i, double * tuple);


  void SetTuple(const vtkIdType i, const float * tuple);
  void SetTuple(const vtkIdType i, const double * tuple);


  void InsertTuple(const vtkIdType i, const float * tuple);
  void InsertTuple(const vtkIdType i, const double * tuple);


  vtkIdType InsertNextTuple(const float * tuple);
  vtkIdType InsertNextTuple(const double * tuple);

  void Squeeze() {this->ResizeAndExtend (this->MaxId+1);}

  virtual void Resize(vtkIdType numTuples);

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

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

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

  char GetValue(const vtkIdType id) {return this->Array[id];};


  void SetValue(const vtkIdType id, const char value)
    { this->Array[id] = value;}

  void SetNumberOfValues(const vtkIdType number);

  char *WritePointer(const vtkIdType id, const vtkIdType number);

  void InsertValue(const vtkIdType id, const char c);

  vtkIdType InsertNextValue(const char c);


  void *GetVoidPointer(const vtkIdType id)
    {return (void *)this->GetPointer(id);};
  char *GetPointer(const vtkIdType id) {return this->Array + id;}

  void DeepCopy(vtkDataArray *ia);


  void SetArray(char* array, vtkIdType size, int save);
  void SetVoidArray(void *array, vtkIdType size, int save) 
    {this->SetArray((char*)array, size, save);};

protected:
  vtkCharArray(vtkIdType numComp=1);
  ~vtkCharArray();

  char *Array;    // pointer to data
  char *ResizeAndExtend(const vtkIdType sz);  // function to resize data

  int TupleSize; //used for data conversion
  float *Tuple;

  int SaveUserArray;
private:
  vtkCharArray(const vtkCharArray&);  // Not implemented.
  void operator=(const vtkCharArray&);  // Not implemented.
};


// Specify the number of values for this object to hold. Does an
// allocation as well as setting the MaxId ivar. Used in conjunction with
// SetValue() method for fast insertion.
inline void vtkCharArray::SetNumberOfValues(const vtkIdType number) 
{
  this->Allocate(number);
  this->MaxId = number - 1;
}


// Get the address of a particular data index. Make sure data is allocated
// for the number of items requested. Set MaxId according to the number of
// data values requested.
inline char *vtkCharArray::WritePointer(const vtkIdType id,
                                        const vtkIdType number) 
{
  vtkIdType newSize=id+number;
  if ( newSize > this->Size )
    {
    this->ResizeAndExtend(newSize);
    }
  if ( (--newSize) > this->MaxId )
    {
    this->MaxId = newSize;
    }
  return this->Array + id;
}

inline void vtkCharArray::InsertValue(const vtkIdType id, const char c)
{
  if ( id >= this->Size )
    {
    this->ResizeAndExtend(id+1);
    }
  this->Array[id] = c;
  if ( id > this->MaxId )
    {
    this->MaxId = id;
    }
}

inline vtkIdType vtkCharArray::InsertNextValue(const char c)
{
  this->InsertValue (++this->MaxId,c); 
  return this->MaxId;
}


#endif

Generated on Thu Jan 22 15:46:42 2004 for VTK by Doxygen 1.3.4