vtkCollection.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkCollection_h
#define vtkCollection_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_6_0
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCollectionElement //;prevents pick-up by man page generator
{
public:
  vtkCollectionElement()
    : Item(nullptr)
    , Next(nullptr)
  {
  }
  vtkObject* Item;
  vtkCollectionElement* Next;
};
typedef void* vtkCollectionSimpleIterator;
 
class vtkCollectionIterator;
 
class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkCollection : public vtkObject
{
public:
  vtkTypeMacro(vtkCollection, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCollection* New();

  void AddItem(vtkObject*);

  void InsertItem(int i, vtkObject*);

  void ReplaceItem(int i, vtkObject*);

  void RemoveItem(int i);

  void RemoveItem(vtkObject*);

  void RemoveAllItems();

  int IsItemPresent(vtkObject* a) VTK_FUTURE_CONST;

  VTK_DEPRECATED_IN_9_6_0("Use correctly spelled IndexOfFirstOccurrence instead.")
  int IndexOfFirstOccurence(vtkObject* a) VTK_FUTURE_CONST;

  int IndexOfFirstOccurrence(vtkObject* a) const;

  int GetNumberOfItems() VTK_FUTURE_CONST { return this->NumberOfItems; }

  void InitTraversal() { this->Current = this->Top; }

  void InitTraversal(vtkCollectionSimpleIterator& cookie)
  {
    cookie = static_cast<vtkCollectionSimpleIterator>(this->Top);
  }

  vtkObject* GetNextItemAsObject();

  vtkObject* GetItemAsObject(int i) VTK_FUTURE_CONST;

  vtkObject* GetNextItemAsObject(vtkCollectionSimpleIterator& cookie) VTK_FUTURE_CONST;

  VTK_NEWINSTANCE vtkCollectionIterator* NewIterator();


  bool UsesGarbageCollector() const override { return true; }
 
protected:
  vtkCollection();
  ~vtkCollection() override;
 
  virtual void RemoveElement(vtkCollectionElement* element, vtkCollectionElement* previous);
  virtual void DeleteElement(vtkCollectionElement*);
  int NumberOfItems;
  vtkCollectionElement* Top;
  vtkCollectionElement* Bottom;
  vtkCollectionElement* Current;
 
  friend class vtkCollectionIterator;
 
  // See vtkGarbageCollector.h:
  void ReportReferences(vtkGarbageCollector* collector) override;
 
private:
  vtkCollection(const vtkCollection&) = delete;
  void operator=(const vtkCollection&) = delete;
};
 
inline vtkObject* vtkCollection::GetNextItemAsObject()
{
  vtkCollectionElement* elem = this->Current;
 
  if (elem != nullptr)
  {
    this->Current = elem->Next;
    return elem->Item;
  }
  else
  {
    return nullptr;
  }
}
 
inline vtkObject* vtkCollection::GetNextItemAsObject(void*& cookie) VTK_FUTURE_CONST
{
  vtkCollectionElement* elem = static_cast<vtkCollectionElement*>(cookie);
 
  if (elem != nullptr)
  {
    cookie = static_cast<void*>(elem->Next);
    return elem->Item;
  }
  else
  {
    return nullptr;
  }
}
 
VTK_ABI_NAMESPACE_END
#endif