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

  Program:   Visualization Toolkit
  Module:    vtkPropCollection.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.

=========================================================================*/
/**
 * @class   vtkPropCollection
 * @brief   an ordered list of Props
 *
 * vtkPropCollection represents and provides methods to manipulate a list of
 * Props (i.e., vtkProp and subclasses). The list is ordered and duplicate
 * entries are not prevented.
 *
 * @sa
 * vtkProp vtkCollection
 */

#ifndef vtkPropCollection_h
#define vtkPropCollection_h

#include "vtkCollection.h"
#include "vtkRenderingCoreModule.h" // For export macro

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

class VTKRENDERINGCORE_EXPORT vtkPropCollection : public vtkCollection
{
public:
  static vtkPropCollection* New();
  vtkTypeMacro(vtkPropCollection, vtkCollection);

  /**
   * Add a Prop to the bottom of the list.
   */
  void AddItem(vtkProp* a);

  /**
   * Get the next Prop in the list.
   */
  vtkProp* GetNextProp();

  /**
   * Get the last Prop in the list.
   */
  vtkProp* GetLastProp();

  /**
   * Get the number of paths contained in this list. (Recall that a
   * vtkProp can consist of multiple parts.) Used in picking and other
   * activities to get the parts of composite entities like vtkAssembly
   * or vtkPropAssembly.
   */
  int GetNumberOfPaths();

  /**
   * Reentrant safe way to get an object in a collection. Just pass the
   * same cookie back and forth.
   */
  vtkProp* GetNextProp(vtkCollectionSimpleIterator& cookie)
  {
    return static_cast<vtkProp*>(this->GetNextItemAsObject(cookie));
  }

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

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

private:
  vtkPropCollection(const vtkPropCollection&) = delete;
  void operator=(const vtkPropCollection&) = delete;
};

inline void vtkPropCollection::AddItem(vtkProp* a)
{
  this->vtkCollection::AddItem(a);
}

inline vtkProp* vtkPropCollection::GetNextProp()
{
  return static_cast<vtkProp*>(this->GetNextItemAsObject());
}

inline vtkProp* vtkPropCollection::GetLastProp()
{
  if (this->Bottom == nullptr)
  {
    return nullptr;
  }
  else
  {
    return static_cast<vtkProp*>(this->Bottom->Item);
  }
}

#endif

// VTK-HeaderTest-Exclude: vtkPropCollection.h
