UmbrellaComputer.h

#pragma once

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

#define UmbrellaComputer_RECURSES

#if !defined UmbrellaComputer_h

#define UmbrellaComputer_h

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

namespace DGtal
{

  // template class UmbrellaComputer
  template <typename TDigitalSurfaceTracker>
  class UmbrellaComputer
  {
    // Concept checks
    BOOST_CONCEPT_ASSERT(( CDigitalSurfaceTracker<TDigitalSurfaceTracker> ) );

    // ----------------------- public types ------------------------------
  public:
    typedef TDigitalSurfaceTracker DigitalSurfaceTracker;
    typedef typename DigitalSurfaceTracker::DigitalSurfaceContainer DigitalSurfaceContainer;
    typedef typename DigitalSurfaceContainer::KSpace KSpace;
    typedef typename DigitalSurfaceContainer::Surfel Surfel;
    typedef typename DigitalSurfaceContainer::Size Size;
    typedef typename KSpace::SCell SCell;

    struct State 
    {
      Surfel surfel;
      Dimension k;
      bool epsilon;
      Dimension j;
      inline State(){}
      inline State( const Surfel & _surfel, 
                    Dimension _k, bool _epsilon, Dimension _j )
        : surfel( _surfel ), k( _k ), epsilon( _epsilon ), j( _j )
      {}
      inline bool operator==( const State & other ) const
      {
        return ( surfel == other.surfel ) 
          && ( k == other.k ) 
          && ( epsilon == other.epsilon )
          && ( j == other.j );
      }
      inline bool operator<( const State & other ) const
      {
        return ( surfel < other.surfel ) 
          || ( ( surfel == other.surfel ) 
               && ( ( k < other.k ) 
                    || ( ( k == other.k ) 
                         && ( ( epsilon < other.epsilon )
                              || ( ( epsilon == other.epsilon)
                                   && ( j < other.j ) ) ) ) ) );
      }
    };

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

    ~UmbrellaComputer();

    UmbrellaComputer();

    UmbrellaComputer( const UmbrellaComputer & other );

    UmbrellaComputer & 
    operator=( const UmbrellaComputer & other );
   
    void init( const DigitalSurfaceTracker & tracker,
               Dimension k, bool epsilon, Dimension j );

    void setState( const State & aState );

    void getState( State & aState ) const;

    const State & state() const;

    const KSpace & space() const;
 
    // ----------------------- Accessor services ------------------------------
  public:

    const Surfel & surfel() const;

    SCell separator() const;

    SCell pivot() const;
    
    Dimension orthDir() const;

    Dimension trackDir() const;

    bool trackOrientation() const;

    Dimension separatorDir() const;

    bool separatorOrientation() const;
    
    // ----------------------- Pivoting services ------------------------------
  public:

    unsigned int next();
    
    unsigned int previous();

    bool adjacent();
    


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

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

    bool isValid() const;

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

    DigitalSurfaceTracker* myTracker;
    State myState;

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

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

  }; // end of class UmbrellaComputer


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

} // namespace DGtal


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

//                                                                           //

#endif // !defined UmbrellaComputer_h

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