Preimage2D.h

#pragma once

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

#define Preimage2D_RECURSES

#if !defined Preimage2D_h

#define Preimage2D_h

// Inclusions
#include <iostream>
#include <list>
#include "DGtal/base/Common.h"
#include "DGtal/base/OpInSTLContainers.h"
#include "DGtal/shapes/fromPoints/Point2ShapePredicate.h"
#include "DGtal/io/Color.h"

namespace DGtal
{

  // template class Preimage2D
  template <typename Shape>
  class Preimage2D
  {


    // ----------------------- Types ------------------------------
  public:

    typedef typename Shape::Point Point;
    typedef typename Shape::Point Vector;

  private:

    //container of points
    typedef std::list<Point> Container;
    //Iterators on the container
    typedef typename std::list<Point>::iterator ForwardIterator;
    typedef typename std::list<Point>::reverse_iterator BackwardIterator;
    typedef typename std::list<Point>::const_iterator ConstForwardIterator;
    typedef typename std::list<Point>::const_reverse_iterator ConstBackwardIterator;

    //Predicates used to decide whether the preimage
    //has to be updated or not
    typedef Point2ShapePredicate<Shape,false,true> 
      PHullBackQHullFrontPred; 
    typedef Point2ShapePredicate<Shape,true,true> 
      QHullBackPHullFrontPred; 
    typedef Point2ShapePredicate<Shape,true,true> 
      PHullFrontQHullBackPred; 
    typedef Point2ShapePredicate<Shape,false,true> 
      QHullFrontPHullBackPred; 
    //Predicates used to update the hulls
    typedef Point2ShapePredicate<Shape,true,false> 
      FrontPHullUpdatePred; 
    typedef Point2ShapePredicate<Shape,false,false> 
      FrontQHullUpdatePred; 
    typedef Point2ShapePredicate<Shape,false,false> 
      BackPHullUpdatePred; 
    typedef Point2ShapePredicate<Shape,true,false> 
      BackQHullUpdatePred; 
    


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

    Preimage2D(const Point & firstPoint, const Point & secondPoint, const Shape & aShape );

    ~Preimage2D();

    Preimage2D ( const Preimage2D & other );

    Preimage2D & operator= ( const Preimage2D & other );

    bool operator==( const Preimage2D & other) const;

    bool operator!=( const Preimage2D & other) const;

    bool isLeftExteriorAtTheFront(const Point & aP, const Point & aQ);

    bool isLeftExteriorAtTheBack(const Point & aP, const Point & aQ);

    bool isRightExteriorAtTheFront(const Point & aP, const Point & aQ);

    bool isRightExteriorAtTheBack(const Point & aP, const Point & aQ);

    bool canBeAddedAtTheFront(const Point & aP, const Point & aQ);

    bool canBeAddedAtTheBack(const Point & aP, const Point & aQ);
    
    bool addFront(const Point & aP, const Point & aQ);

    bool addBack(const Point & aP, const Point & aQ);

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

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

    bool isValid() const;
  
    Point getUf() const;

    Point getUl() const;

    Point getLf() const;

    Point getLl() const;
    
    void getSeparatingStraightLine(double& alpha, double& beta, double& gamma) const;
    
    const Shape & shape() const
    {
      return myShape;
    };
    
    const Container & pHull() const
    {
      return myPHull;
    };
    
    const Container & qHull() const
    {
      return myQHull;
    };

    //------------------ display -------------------------------
    //DrawableWithBoard2D* defaultStyle( std::string mode="" ) const;
    
    std::string className() const;

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

    Shape myShape;
  
    //lists of the vertices of the preimage
    Container myPHull;
    Container myQHull;

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


  private:

    template <typename Iterator, typename Predicate>
    void update(const Point & aPoint, 
                Container & aContainer,
                Iterator & anIterator,
                const Iterator & anEndIterator);



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

  }; // end of class Preimage2D


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


} // namespace DGtal


// Includes inline functions.
#include "DGtal/geometry/tools/Preimage2D.ih"

//                                                                           //

#endif // !defined Preimage2D_h

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