vtkBitArray.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkBitArray.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 vtkBitArray_h
#define vtkBitArray_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDataArray.h"

class vtkBitArrayLookup;

class VTKCOMMONCORE_EXPORT vtkBitArray : public vtkDataArray
{
public:
  enum DeleteMethod
  {
    VTK_DATA_ARRAY_FREE=vtkAbstractArray::VTK_DATA_ARRAY_FREE,
    VTK_DATA_ARRAY_DELETE=vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
    VTK_DATA_ARRAY_ALIGNED_FREE=vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
    VTK_DATA_ARRAY_USER_DEFINED=vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
  };

  static vtkBitArray *New();
  vtkTypeMacro(vtkBitArray,vtkDataArray);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override;

  void Initialize() override;

  // satisfy vtkDataArray API
  int GetDataType() override {return VTK_BIT;}
  int GetDataTypeSize() override { return 0; }

  void SetNumberOfTuples(vtkIdType number) override;

  void SetTuple(vtkIdType i, vtkIdType j,
                        vtkAbstractArray* source) override;

  void InsertTuple(vtkIdType i, vtkIdType j,
                           vtkAbstractArray* source) override;

  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
                            vtkAbstractArray *source) override;

  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
                            vtkAbstractArray* source) override;

  vtkIdType InsertNextTuple(vtkIdType j,
                                    vtkAbstractArray* source) override;

  double *GetTuple(vtkIdType i) override;

  void GetTuple(vtkIdType i, double * tuple) override;


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


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


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


  void RemoveTuple(vtkIdType id) override;
  void RemoveFirstTuple() override;
  void RemoveLastTuple() override;

  void SetComponent(vtkIdType i, int j, double c) override;

  void Squeeze() override;

  vtkTypeBool Resize(vtkIdType numTuples) override;

  int GetValue(vtkIdType id);

  void SetNumberOfValues(vtkIdType number) override;

  void SetValue(vtkIdType id, int value);

  void InsertValue(vtkIdType id, int i);

  void SetVariantValue(vtkIdType idx, vtkVariant value) override;

  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;

  vtkIdType InsertNextValue(int i);

  void InsertComponent(vtkIdType i, int j, double c) override;

  unsigned char *GetPointer(vtkIdType id)
    { return this->Array + id/8; }

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

  void* WriteVoidPointer(vtkIdType id, vtkIdType number) override
  {
    return this->WritePointer(id, number);
  }

  void *GetVoidPointer(vtkIdType id) override
  {
      return static_cast<void *>(this->GetPointer(id));
  }

  void DeepCopy(vtkDataArray *da) override;
  void DeepCopy(vtkAbstractArray* aa) override
    { this->Superclass::DeepCopy(aa); }


#ifndef __VTK_WRAP__
  void SetArray(unsigned char* array, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE);
#endif
  void SetVoidArray(void *array, vtkIdType size, int save) override
  {
      this->SetArray(static_cast<unsigned char *>(array), size, save);
  }
  void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
  {
      this->SetArray(static_cast<unsigned char *>(array), size, save, deleteMethod);
  }

  void SetArrayFreeFunction(void (*callback)(void *)) override;

  VTK_NEWINSTANCE vtkArrayIterator* NewIterator() override;


  vtkIdType LookupValue(vtkVariant value) override;
  void LookupValue(vtkVariant value, vtkIdList* ids) override;
  vtkIdType LookupValue(int value);
  void LookupValue(int value, vtkIdList* ids);

  void DataChanged() override;

  void ClearLookup() override;

protected:
  vtkBitArray();
  ~vtkBitArray() override;

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

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

  void (*DeleteFunction)(void*);

private:
  // hide superclass' DeepCopy() from the user and the compiler
  void DeepCopy(vtkDataArray &da) {this->vtkDataArray::DeepCopy(&da);}

private:
  vtkBitArray(const vtkBitArray&) = delete;
  void operator=(const vtkBitArray&) = delete;

  vtkBitArrayLookup* Lookup;
  void UpdateLookup();

};

inline void vtkBitArray::SetNumberOfValues(vtkIdType number)
{
  this->Allocate(number);
  this->MaxId = number - 1;
  this->DataChanged();
}

inline void vtkBitArray::SetValue(vtkIdType id, int value)
{
  if (value)
  {
    this->Array[id/8] = static_cast<unsigned char>(
      this->Array[id/8] | (0x80 >> id%8));
  }
  else
  {
    this->Array[id/8] = static_cast<unsigned char>(
      this->Array[id/8] & (~(0x80 >> id%8)));
  }
  this->DataChanged();
}

inline void vtkBitArray::InsertValue(vtkIdType id, int i)
{
  if ( id >= this->Size )
  {
    if (!this->ResizeAndExtend(id+1))
    {
      return;
    }
  }
  if (i)
  {
    this->Array[id/8] = static_cast<unsigned char>(
      this->Array[id/8] | (0x80 >> id%8));
  }
  else
  {
    this->Array[id/8] = static_cast<unsigned char>(
      this->Array[id/8] & (~(0x80 >> id%8)));
  }
  if ( id > this->MaxId )
  {
    this->MaxId = id;
  }
  this->DataChanged();
}

inline void vtkBitArray::SetVariantValue(vtkIdType id, vtkVariant value)
{
  this->SetValue(id, value.ToInt());
}

inline void vtkBitArray::InsertVariantValue(vtkIdType id, vtkVariant value)
{
  this->InsertValue(id, value.ToInt());
}

inline vtkIdType vtkBitArray::InsertNextValue(int i)
{
  this->InsertValue (++this->MaxId,i);
  this->DataChanged();
  return this->MaxId;
}

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

#endif