vtkActor2DCollection.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 vtkActor2DCollection_h
#define vtkActor2DCollection_h

#include "vtkPropCollection.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

#include "vtkActor2D.h" // Needed for inline methods

VTK_ABI_NAMESPACE_BEGIN
class vtkViewport;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkActor2DCollection : public vtkPropCollection
{
public:
  static vtkActor2DCollection* New();

  vtkTypeMacro(vtkActor2DCollection, vtkPropCollection);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Sort();

  void AddItem(vtkActor2D* a);


  int IsItemPresent(vtkActor2D* a);
  int IndexOfFirstOccurrence(vtkActor2D* a);
  vtkActor2D* GetNextActor2D();
  vtkActor2D* GetLastActor2D();


  vtkActor2D* GetNextItem();
  vtkActor2D* GetLastItem();

  void RenderOverlay(vtkViewport* viewport);

  vtkActor2D* GetNextActor2D(vtkCollectionSimpleIterator& cookie)
  {
    return static_cast<vtkActor2D*>(this->GetNextItemAsObject(cookie));
  }

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

private:
  // hide the standard AddItem from the user and the compiler.
  void AddItem(vtkObject* o) { this->vtkCollection::AddItem(o); }
  void AddItem(vtkProp* o) { this->vtkPropCollection::AddItem(o); }
  int IsItemPresent(vtkObject* o) { return this->vtkCollection::IsItemPresent(o); }
  int IndexOfFirstOccurrence(vtkObject* o)
  {
    return this->vtkCollection::IndexOfFirstOccurrence(o);
  }

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

inline int vtkActor2DCollection::IsItemPresent(vtkActor2D* a)
{
  return this->vtkCollection::IsItemPresent(a);
}

inline int vtkActor2DCollection::IndexOfFirstOccurrence(vtkActor2D* a)
{
  return this->vtkCollection::IndexOfFirstOccurrence(a);
}

inline vtkActor2D* vtkActor2DCollection::GetNextActor2D()
{
  return static_cast<vtkActor2D*>(this->GetNextItemAsObject());
}

inline vtkActor2D* vtkActor2DCollection::GetLastActor2D()
{
  int numItems = this->GetNumberOfItems();
  if (numItems == 0)
  {
    return nullptr;
  }
  else
  {
    return static_cast<vtkActor2D*>(this->GetItemAsObject(numItems - 1));
  }
}

inline vtkActor2D* vtkActor2DCollection::GetNextItem()
{
  return this->GetNextActor2D();
}

inline vtkActor2D* vtkActor2DCollection::GetLastItem()
{
  return this->GetLastActor2D();
}

VTK_ABI_NAMESPACE_END
#endif