dox/Common/vtkUnsignedCharArray.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkUnsignedCharArray.h

  Copyright (c) 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 __vtkUnsignedCharArray_h
#define __vtkUnsignedCharArray_h

// Tell the template header how to give our superclass a DLL interface.
#if !defined(__vtkUnsignedCharArray_cxx)
# define VTK_DATA_ARRAY_TEMPLATE_TYPE unsigned char
#endif

#include "vtkDataArray.h"
#include "vtkDataArrayTemplate.h" // Real Superclass

// Fake the superclass for the wrappers.
#define vtkDataArray vtkDataArrayTemplate<unsigned char>
class VTK_COMMON_EXPORT vtkUnsignedCharArray : public vtkDataArray
#undef vtkDataArray
{
public:
  static vtkUnsignedCharArray* New();
  vtkTypeMacro(vtkUnsignedCharArray,vtkDataArray);
  void PrintSelf(ostream& os, vtkIndent indent);


  int GetDataType()
    { return VTK_UNSIGNED_CHAR; }


  void GetTupleValue(vtkIdType i, unsigned char* tuple)
    { this->RealSuperclass::GetTupleValue(i, tuple); }


  void SetTupleValue(vtkIdType i, const unsigned char* tuple)
    { this->RealSuperclass::SetTupleValue(i, tuple); }


  void InsertTupleValue(vtkIdType i, const unsigned char* tuple)
    { this->RealSuperclass::InsertTupleValue(i, tuple); }


  vtkIdType InsertNextTupleValue(const unsigned char* tuple)
    { return this->RealSuperclass::InsertNextTupleValue(tuple); }


  unsigned char GetValue(vtkIdType id)
    { return this->RealSuperclass::GetValue(id); }


  void SetValue(vtkIdType id, unsigned char value)
    { this->RealSuperclass::SetValue(id, value); }


  void SetNumberOfValues(vtkIdType number)
    { this->RealSuperclass::SetNumberOfValues(number); }


  void InsertValue(vtkIdType id, unsigned char f)
    { this->RealSuperclass::InsertValue(id, f); }


  vtkIdType InsertNextValue(unsigned char f)
    { return this->RealSuperclass::InsertNextValue(f); }


  unsigned char *GetValueRange(int comp)
    { return this->RealSuperclass::GetValueRange(comp); }
//BTX
  void GetValueRange(unsigned char range[2], int comp)
    { this->RealSuperclass::GetValueRange(range, comp); }
//ETX


  unsigned char *GetValueRange()
    { return this->RealSuperclass::GetValueRange(0); }
//BTX
  void GetValueRange(unsigned char range[2])
    { this->RealSuperclass::GetValueRange(range, 0); }
//ETX

  static unsigned char GetDataTypeValueMin() { return VTK_UNSIGNED_CHAR_MIN; }

  static unsigned char GetDataTypeValueMax() { return VTK_UNSIGNED_CHAR_MAX; }


  unsigned char* WritePointer(vtkIdType id, vtkIdType number)
    { return this->RealSuperclass::WritePointer(id, number); }


  unsigned char* GetPointer(vtkIdType id)
    { return this->RealSuperclass::GetPointer(id); }


  void SetArray(unsigned char* array, vtkIdType size, int save)
    { this->RealSuperclass::SetArray(array, size, save); }
  void SetArray(unsigned char* array, vtkIdType size, int save, int deleteMethod)
    { this->RealSuperclass::SetArray(array, size, save, deleteMethod); }

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

private:
  //BTX
  typedef vtkDataArrayTemplate<unsigned char> RealSuperclass;
  //ETX
  vtkUnsignedCharArray(const vtkUnsignedCharArray&);  // Not implemented.
  void operator=(const vtkUnsignedCharArray&);  // Not implemented.
};

#endif