/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkQuadEdgeMeshBoundaryEdgesMeshFunction_h
#define itkQuadEdgeMeshBoundaryEdgesMeshFunction_h

#include "itkFunctionBase.h"

namespace itk
{
/**
 * \class QuadEdgeMeshBoundaryEdgesMeshFunction
 *
 * \brief Build a list of references to edges (as \ref GeometricalQuadEdge::RawPointer)
 *        each one representing a different boundary component.
 * \note  Each resulting edge has the surface on its right and is hence
 *        ready for a walk on with the help of BeginGeomLnext().
 * \note  The size() of the resulting list is the number of boundary
 *        components.
 * \ingroup ITKQuadEdgeMesh
 */
template <typename TMesh>
class ITK_TEMPLATE_EXPORT QuadEdgeMeshBoundaryEdgesMeshFunction
  : public FunctionBase<TMesh, typename TMesh::EdgeListPointerType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(QuadEdgeMeshBoundaryEdgesMeshFunction);

  // Standard types
  using Self = QuadEdgeMeshBoundaryEdgesMeshFunction;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = FunctionBase<TMesh, typename TMesh::EdgeListPointerType>;

  // Types in superclass:
  using typename Superclass::InputType;
  using typename Superclass::OutputType;

  // Local aliases
  using MeshType = InputType;
  using QEPrimal = typename MeshType::QEPrimal;
  using EdgeCellType = typename MeshType::EdgeCellType;
  using EdgeListType = typename MeshType::EdgeListType;

  itkOverrideGetNameOfClassMacro(QuadEdgeMeshBoundaryEdgesMeshFunction);
  itkNewMacro(Self);

  OutputType
  Evaluate(const InputType & mesh) const override;

protected:
  QuadEdgeMeshBoundaryEdgesMeshFunction() = default;
};
} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkQuadEdgeMeshBoundaryEdgesMeshFunction.hxx"
#endif

#endif
