LightExplicitDigitalSurface.h

#pragma once

#if defined(LightExplicitDigitalSurface_RECURSES)
#error Recursive header files inclusion detected in LightExplicitDigitalSurface.h
#else // defined(LightExplicitDigitalSurface_RECURSES)

#define LightExplicitDigitalSurface_RECURSES

#if !defined LightExplicitDigitalSurface_h

#define LightExplicitDigitalSurface_h

// Inclusions
#include <iostream>
#include <vector>
#include "DGtal/base/Common.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/topology/CSurfelPredicate.h"
#include "DGtal/topology/Topology.h"
#include "DGtal/topology/SurfelAdjacency.h"
#include "DGtal/topology/SurfelNeighborhood.h"
#include "DGtal/graph/BreadthFirstVisitor.h"
#include "DGtal/graph/GraphVisitorRange.h"

namespace DGtal
{

  // template class LightExplicitDigitalSurface
  template <typename TKSpace, typename TSurfelPredicate>
  class LightExplicitDigitalSurface
  {
  public:

    class Tracker
    {
    public:
      // -------------------- associated types --------------------
      typedef Tracker Self;
      typedef LightExplicitDigitalSurface<TKSpace,TSurfelPredicate>
      DigitalSurfaceContainer;
      typedef typename TKSpace::SCell Surfel;

      // -------------------- inner types --------------------
      typedef TKSpace KSpace;
      typedef SurfelNeighborhood<KSpace> Neighborhood;

    public:
      Tracker( ConstAlias<DigitalSurfaceContainer> aSurface, 
               const Surfel & s );

      Tracker( const Tracker & other );

      ~Tracker();

      const DigitalSurfaceContainer & surface() const;
      const Surfel & current() const;
      Dimension orthDir() const;

      void move( const Surfel & s );
      
      uint8_t adjacent( Surfel & s, Dimension d, bool pos ) const;
      
    private:
      const DigitalSurfaceContainer & mySurface;
      Neighborhood myNeighborhood;

    };

    // ----------------------- associated types ------------------------------
  public:
    typedef LightExplicitDigitalSurface<TKSpace,TSurfelPredicate> Self;
    typedef TKSpace KSpace;
    typedef typename KSpace::SCell Surfel;
    typedef typename KSpace::Size Size;
    // Model of CSurfelPredicate
    typedef TSurfelPredicate SurfelPredicate;

    // BOOST_CONCEPT_ASSERT(( CCellularGridSpaceND< KSpace > ));
    BOOST_CONCEPT_ASSERT(( concepts::CSurfelPredicate< SurfelPredicate > ));

    // ----------------------- other types ------------------------------
  public:
    typedef SurfelAdjacency<KSpace::dimension> Adjacency;
    typedef typename KSpace::Cell Cell;
    typedef typename KSpace::SCell SCell;
    typedef typename KSpace::CellSet CellSet;
    typedef typename KSpace::SCellSet SCellSet;


    // ----------------- UndirectedSimplePreGraph types ------------------
    typedef Surfel Vertex;
    typedef SCellSet VertexSet;  
    template <typename Value>
    struct VertexMap {
      typedef typename KSpace::template SurfelMap<Value>::Type Type;
    };

    // -------------------- specific types ------------------------------
    typedef BreadthFirstVisitor< Self > SelfVisitor;
    typedef GraphVisitorRange< SelfVisitor > SelfVisitorRange;
    typedef typename SelfVisitorRange::ConstIterator SurfelConstIterator;
    typedef typename KSpace::Space Space;
    typedef typename KSpace::Point Point;
    typedef Tracker DigitalSurfaceTracker;

    // ----------------------- Standard services ------------------------------
  public:

    ~LightExplicitDigitalSurface();

    LightExplicitDigitalSurface ( const LightExplicitDigitalSurface & other );

    LightExplicitDigitalSurface( ConstAlias<KSpace> aKSpace,
                                 ConstAlias<SurfelPredicate> aSP,
                                 const Adjacency & adj,
                                 const Surfel & s );

    const Adjacency & surfelAdjacency() const;
    Adjacency & surfelAdjacency();
    const SurfelPredicate & surfelPredicate() const;
    const Surfel & surfel() const;
    void setSurfel(const Surfel& aSurfel);

    // --------- CDigitalSurfaceContainer realization -------------------------
  public:

    const KSpace & space() const;
    bool isInside( const Surfel & s ) const;

    SurfelConstIterator begin() const;

    SurfelConstIterator end() const;

    Size nbSurfels() const;

    bool empty() const;

    DigitalSurfaceTracker* newTracker( const Surfel & s ) const;

    Connectedness connectedness() const;

    // ----------------- CUndirectedSimplePreGraph realization -----------------
  public:
    
    Size degree( const Vertex & v ) const;

    template <typename OutputIterator>
    void writeNeighbors( OutputIterator & it,
                         const Vertex & v ) const;

    template <typename OutputIterator, typename VertexPredicate>
    void writeNeighbors( OutputIterator & it,
                         const Vertex & v,
                         const VertexPredicate & pred ) const;

    Size bestCapacity() const;


    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
    const KSpace & myKSpace;
    const SurfelPredicate & mySurfelPredicate;
    Adjacency mySurfelAdjacency;
    Surfel mySurfel;
    mutable Tracker myTracker;

    // ------------------------- Hidden services ------------------------------
  protected:


  private:

    LightExplicitDigitalSurface & operator= ( const LightExplicitDigitalSurface & other );

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of class LightExplicitDigitalSurface


  template <typename TKSpace, typename TSurfelPredicate>
  std::ostream&
  operator<< ( std::ostream & out, 
               const LightExplicitDigitalSurface<TKSpace, TSurfelPredicate> & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/topology/LightExplicitDigitalSurface.ih"

//                                                                           //

#endif // !defined LightExplicitDigitalSurface_h

#undef LightExplicitDigitalSurface_RECURSES
#endif // else defined(LightExplicitDigitalSurface_RECURSES)