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

#include <algorithm>
#include <functional>
#include <vector>

VTK_ABI_NAMESPACE_BEGIN
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 static_cast<int>(this->Objects.size()); }

  vtkObject* GetItemAsObject(int i) VTK_FUTURE_CONST;

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

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

  vtkObject* GetNextItemAsObject();

  vtkObject* GetNextItemAsObject(vtkCollectionSimpleIterator& cookie) VTK_FUTURE_CONST;

  VTK_DEPRECATED_IN_9_7_0("Use vtk::Range instead.")
  VTK_NEWINSTANCE vtkCollectionIterator* NewIterator();

  std::vector<vtkObject*>::iterator begin() { return this->Objects.begin(); }
  std::vector<vtkObject*>::iterator end() { return this->Objects.end(); }

  void Sort(std::function<bool(vtkObject*, vtkObject*)> f)
  {
    std::sort(this->Objects.begin(), this->Objects.end(), f);
  }


  bool UsesGarbageCollector() const override { return true; }

protected:
  vtkCollection() = default;
  ~vtkCollection() override;

  // See vtkGarbageCollector.h:
  void ReportReferences(vtkGarbageCollector* collector) override;

private:
  std::size_t Current = 0;
  std::vector<vtkObject*> Objects;

  vtkCollection(const vtkCollection&) = delete;
  void operator=(const vtkCollection&) = delete;
};

inline vtkObject* vtkCollection::GetNextItemAsObject()
{
  if (this->Current >= this->Objects.size())
  {
    return nullptr;
  }
  vtkObject* obj = this->Objects[this->Current];
  this->Current++;
  return obj;
}

inline vtkObject* vtkCollection::GetNextItemAsObject(
  vtkCollectionSimpleIterator& cookie) VTK_FUTURE_CONST
{
  vtkObject** elem = static_cast<vtkObject**>(cookie);

  if (elem >= this->Objects.data() + this->Objects.size())
  {
    return nullptr;
  }
  cookie = static_cast<vtkCollectionSimpleIterator>(elem + 1);
  return *elem;
}

VTK_ABI_NAMESPACE_END
#endif