SurfelNeighborhood.h

#pragma once

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

#define SurfelNeighborhood_RECURSES

#if !defined SurfelNeighborhood_h

#define SurfelNeighborhood_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/topology/SurfelAdjacency.h"

namespace DGtal
{

  // template class SurfelNeighborhood
  template <typename TKSpace>
  class SurfelNeighborhood
  {
    // ----------------------- Types ------------------------------
  public:

    typedef TKSpace KSpace;
    typedef typename KSpace::Point Point;
    typedef typename KSpace::Cell Cell;
    typedef typename KSpace::SCell SCell;

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

    ~SurfelNeighborhood();

    SurfelNeighborhood();

    SurfelNeighborhood ( const SurfelNeighborhood & other );

    SurfelNeighborhood & operator= ( const SurfelNeighborhood & other );

    void init( const KSpace* space, 
         const SurfelAdjacency<KSpace::dimension>* adj,
         const SCell & aSurfel );

    void setSurfel( const SCell & aSurfel );

    const SCell & surfel() const;

    Dimension orthDir() const;

   //----------------------- spel services -------------------------
  public:
    SCell innerSpel() const;

    SCell outerSpel() const;

    SCell innerAdjacentSpel( Dimension track_dir, bool pos ) const;

    SCell outerAdjacentSpel( Dimension track_dir, bool pos ) const;
 
    //----------------------- follower services -------------------------
  public:
    SCell follower1( Dimension track_dir, bool pos ) const;

    SCell follower2( Dimension track_dir, bool pos ) const;

    SCell follower3( Dimension track_dir, bool pos ) const;


    // ----------------------- Surfel adjacency services --------------------
  public:

    template <typename SpelSet>
    unsigned int getAdjacentOnSpelSet( SCell & adj_surfel,
               const SpelSet & obj, 
               Dimension track_dir,
               bool pos ) const;

    template <typename DigitalSet>
    unsigned int getAdjacentOnDigitalSet( SCell & adj_surfel,
            const DigitalSet & obj, 
            Dimension track_dir,
            bool pos ) const;

    template <typename PointPredicate>
    unsigned int getAdjacentOnPointPredicate( SCell & adj_surfel,
                const PointPredicate & pp, 
                Dimension track_dir,
                bool pos ) const;

    template <typename SurfelPredicate>
    unsigned int getAdjacentOnSurfelPredicate( SCell & adj_surfel,
                                               const SurfelPredicate & sp, 
                                               Dimension track_dir,
                                               bool pos ) const;

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

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

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:

    const KSpace* mySpace;
    const SurfelAdjacency<KSpace::dimension>* mySurfelAdj;
    SCell mySurfel;
    Dimension myOrthDir;
    bool myOrthDirect;
 
    // ------------------------- Hidden services ------------------------------
  protected:


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

  }; // end of class SurfelNeighborhood


  template <typename T>
  std::ostream&
  operator<< ( std::ostream & out, const SurfelNeighborhood<T> & object );

} // namespace DGtal


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

//                                                                           //

#endif // !defined SurfelNeighborhood_h

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