dox/Common/vtkIdList.h

Go to the documentation of this file.

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

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

#include "vtkObject.h"

class VTK_COMMON_EXPORT vtkIdList : public vtkObject
{
public:
  static vtkIdList *New();

  void Initialize();
  int Allocate(const vtkIdType sz, const int strategy=0);
  vtkTypeMacro(vtkIdList,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  vtkIdType GetNumberOfIds() {return this->NumberOfIds;};
  
  vtkIdType GetId(const vtkIdType i) {return this->Ids[i];};
  
  void SetNumberOfIds(const vtkIdType number);

  void SetId(const vtkIdType i, const vtkIdType vtkid) {this->Ids[i] = vtkid;};

  void InsertId(const vtkIdType i, const vtkIdType vtkid);

  vtkIdType InsertNextId(const vtkIdType vtkid);

  vtkIdType InsertUniqueId(const vtkIdType vtkid);

  vtkIdType *GetPointer(const vtkIdType i) {return this->Ids + i;};

  vtkIdType *WritePointer(const vtkIdType i, const vtkIdType number);

  void Reset() {this->NumberOfIds = 0;};

  void Squeeze() {this->Resize(this->NumberOfIds);};

  void DeepCopy(vtkIdList *ids);

  void DeleteId(vtkIdType vtkid);

  vtkIdType IsId(vtkIdType vtkid);

  void IntersectWith(vtkIdList* otherIds);

  //BTX
  // This method should become legacy
  void IntersectWith(vtkIdList& otherIds) {
    return this->IntersectWith(&otherIds); };
  //ETX

protected:
  vtkIdList();
  ~vtkIdList();

  vtkIdType NumberOfIds;
  vtkIdType Size; 
  vtkIdType *Ids;

  vtkIdType *Resize(const vtkIdType sz);
private:
  vtkIdList(const vtkIdList&);  // Not implemented.
  void operator=(const vtkIdList&);  // Not implemented.
};

// In-lined for performance
inline vtkIdType vtkIdList::InsertNextId(const vtkIdType vtkid)
{
  if ( this->NumberOfIds >= this->Size )
    {
    this->Resize(this->NumberOfIds+1);
    }
  this->Ids[this->NumberOfIds++] = vtkid;
  return this->NumberOfIds-1;
}

inline vtkIdType vtkIdList::IsId(vtkIdType vtkid)
{
  vtkIdType *ptr, i;
  for (ptr=this->Ids, i=0; i<this->NumberOfIds; i++, ptr++)
    {
    if ( vtkid == *ptr )
      {
      return i;
      }
    }
  return (-1);
}

#endif