SPAR/AIModule/BWTA/vendors/CGAL/CGAL/Sweep_line_2/Arr_basic_insertion_traits_2.h

Go to the documentation of this file.

// Copyright (c) 1997  Tel-Aviv University (Israel).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org); you may redistribute it under
// the terms of the Q Public License version 1.0.
// See the file LICENSE.QPL distributed with CGAL.
//
// Licensees holding a valid commercial license may use this file in
// accordance with the commercial license agreement provided with the software.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//
// $URL: svn+ssh://scm.gforge.inria.fr/svn/cgal/branches/CGAL-3.5-branch/Arrangement_on_surface_2/include/CGAL/Sweep_line_2/Arr_basic_insertion_traits_2.h $
// $Id: Arr_basic_insertion_traits_2.h 50366 2009-07-05 12:56:48Z efif $
// 
//
// Author(s)     : Baruch Zukerman <baruchzu@post.tau.ac.il>
//                 Ron Wein <wein@post.tau.ac.il>
//                 Efi Fogel <efif@post.tau.ac.il>

#ifndef CGAL_ARR_BASIC_INSERTION_TRAITS_2_H
#define CGAL_ARR_BASIC_INSERTION_TRAITS_2_H

#include <CGAL/Object.h>
#include <CGAL/Arr_tags.h>

#include <list>
#include <iterator>

CGAL_BEGIN_NAMESPACE

template <typename Traits_, typename Arrangement_>
class Arr_basic_insertion_traits_2 
{
public:

  typedef Traits_                                   Traits_2;
  typedef Arrangement_                              Arrangement_2;

  typedef typename Arrangement_2::Halfedge_handle   Halfedge_handle;
  typedef typename Arrangement_2::Vertex_handle     Vertex_handle;
  typedef typename Traits_2::X_monotone_curve_2     Base_x_monotone_curve_2;
  typedef typename Traits_2::Point_2                Base_point_2;
  typedef typename Traits_2::Construct_min_vertex_2 Base_construct_min_vertex_2;
  typedef typename Traits_2::Construct_max_vertex_2 Base_construct_max_vertex_2;
  typedef typename Traits_2::Compare_x_2            Base_compare_x_2;
  typedef typename Traits_2::Compare_xy_2           Base_compare_xy_2;
  typedef typename Traits_2::Compare_y_at_x_2       Base_compare_y_at_x_2;
  typedef typename Traits_2::Compare_y_at_x_right_2 Base_compare_y_at_x_right_2;
  typedef typename Traits_2::Equal_2                Base_equal_2;
  typedef typename Traits_2::Is_vertical_2          Base_is_vertical_2;

  
  typedef typename CGALi::Arr_complete_left_side_tag< Traits_2 >::Tag
                                                    Arr_left_side_tag;
  typedef typename CGALi::Arr_complete_bottom_side_tag< Traits_2 >::Tag
                                                    Arr_bottom_side_tag;
  typedef typename CGALi::Arr_complete_top_side_tag< Traits_2 >::Tag
                                                    Arr_top_side_tag;
  typedef typename CGALi::Arr_complete_right_side_tag< Traits_2 >::Tag
                                                    Arr_right_side_tag;

  /* Insertion is implemented as sweep-line visitor. The sweep-line algorithm
   * never uses Compare_y_at_x_left_2.
   */
  typedef Tag_false                                 Has_left_category;

protected:

  const Traits_2 * m_base_traits;

public:

  Arr_basic_insertion_traits_2 (const Traits_2 & tr):
    m_base_traits (&tr)
  {}

  class Ex_x_monotone_curve_2 
  {
  public:

    typedef  Base_x_monotone_curve_2  Base;

  protected:

    Base                m_base_xcv;    // The base x-monotone curve.
    Halfedge_handle     m_he_handle;   // The corresponding arrangement edge
                                       // (may be invalid).
    bool                m_overlap;     // Does this curve represent and overlap
                                       // of two other curves.

  public:

    Ex_x_monotone_curve_2():
      m_base_xcv(),
      m_he_handle(),
      m_overlap(false)
    {}

    Ex_x_monotone_curve_2(const Base& xcv):
      m_base_xcv (xcv),
      m_he_handle(),
      m_overlap(false)
    {}

    Ex_x_monotone_curve_2(const Base& xcv, Halfedge_handle he) :
      m_base_xcv (xcv),
      m_he_handle (he),
      m_overlap(false)
    {
      CGAL_precondition (he == Halfedge_handle() ||
                         he->direction() == ARR_RIGHT_TO_LEFT);
    }

    const Base& base() const
    {
      return (m_base_xcv);
    }

    Base& base()
    {
      return (m_base_xcv);
    }

    operator const Base& () const
    {
      return (m_base_xcv);
    }

    Ex_x_monotone_curve_2& operator= (const Base& xcv)
    {
      m_base_xcv = xcv;
      m_he_handle = Halfedge_handle();
      return (*this);
    }

    Halfedge_handle halfedge_handle() const
    {
      return (m_he_handle);
    }

    void set_halfedge_handle(Halfedge_handle he)
    {
      CGAL_precondition (he == Halfedge_handle() ||
                         he->direction() == ARR_RIGHT_TO_LEFT);
      m_he_handle = he;
    }

    bool is_overlapping () const
    {
      return (m_overlap);
    }

    void set_overlapping ()
    {
      m_overlap = true;
    }
  };

  typedef Ex_x_monotone_curve_2                     X_monotone_curve_2;

#ifdef CGAL_SL_VERBOSE
  // For debugging purposes:
  friend std::ostream& operator<< (std::ostream& os,
                                   const X_monotone_curve_2& xcv)
  {
    os << xcv.base();
    return (os);
  }
#endif
 
  class Ex_point_2 
  {
  public:

    typedef  Base_point_2            Base;

  protected:

    Base             m_base_pt;        // The base point.
    Vertex_handle    m_v;              // The corresponding arrangement vertex
                                       // (may be invalid).

  public:

    Ex_point_2() :
      m_base_pt(),
      m_v()
    {}

    Ex_point_2 (const Base& pt) :
      m_base_pt (pt),
      m_v()
    {}

    Ex_point_2 (const Base& pt, Vertex_handle v) :
      m_base_pt (pt),
      m_v (v)
    {}

    const Base& base() const
    {
      return (m_base_pt);
    }
    
    operator const Base& () const
    {
      return (m_base_pt);
    }

    Vertex_handle vertex_handle() const
    {
      return m_v;
    }

    void set_vertex_handle(Vertex_handle v)
    {
      m_v = v;
    }
  };

  typedef Ex_point_2                                Point_2;

#ifdef CGAL_SL_VERBOSE
  // For debugging purposes:
  friend std::ostream& operator<< (std::ostream& os,
                                   const Point_2& pt)
  {
    os << pt.base();
    return (os);
  }
#endif

  class Construct_min_vertex_2 {
  protected:
    Base_construct_min_vertex_2  m_base_min_v;
    Base_equal_2                 m_base_equal;
    Halfedge_handle              invalid_he;

    Construct_min_vertex_2 (const Base_construct_min_vertex_2& base_min_v,
                            const Base_equal_2& base_equal) :
      m_base_min_v (base_min_v),
      m_base_equal (base_equal),
      invalid_he()
    {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;
    
  public:
    Point_2 operator() (const X_monotone_curve_2 & xcv) 
    {
      // If there is not halfedge associated with the curve, just return
      // a point with invalid halfedge handle.
      const Base_point_2&  base_p = m_base_min_v(xcv.base());

      if (xcv.halfedge_handle() == invalid_he)
        return (Point_2 (base_p));

      // Note that the halfedge associated with the curve is always directed
      // from right to left, so its target is the leftmost vertex.
      // We probably have to associate the point with the target vertex of
      // the halfedge associated with the curve.
      Vertex_handle        vh = xcv.halfedge_handle()->target();

      if (! xcv.is_overlapping())
        return (Point_2(base_p, vh));

      // In case of an overlapping curve, make sure the curve endpoint equals
      // the point associated with the vertex. If not, we attach an invalid
      // vertex to the extended point.
      if (! vh->is_at_open_boundary() && m_base_equal (base_p, vh->point()))
        return (Point_2(base_p, vh));
      else
        return (Point_2 (base_p));
    }
  };

  Construct_min_vertex_2 construct_min_vertex_2_object () const
  {
    return (Construct_min_vertex_2
            (m_base_traits->construct_min_vertex_2_object(),
             m_base_traits->equal_2_object()));
  }

  class Construct_max_vertex_2 {
  protected:
    Base_construct_max_vertex_2  m_base_max_v;
    Base_equal_2                 m_base_equal;
    Halfedge_handle              invalid_he;

    Construct_max_vertex_2 (const Base_construct_max_vertex_2& base_max_v,
                            const Base_equal_2& base_equal) :
      m_base_max_v (base_max_v),
      m_base_equal (base_equal),
      invalid_he()
    {}


    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Point_2 operator() (const X_monotone_curve_2 & xcv) 
    {
      // If there is not halfedge associated with the curve, just return
      // a point with invalid halfedge handle.
      const Base_point_2&  base_p = m_base_max_v(xcv.base());

      if (xcv.halfedge_handle() == invalid_he)
        return (Point_2 (base_p));

      // Note that the halfedge associated with the curve is always directed
      // from right to left, so its source is the rightmost vertex.
      // We probably have to associate the point with the source vertex of
      // the halfedge associated with the curve.
      Vertex_handle        vh = xcv.halfedge_handle()->source();

      if (! xcv.is_overlapping())
        return (Point_2(base_p, vh));

      // In case of an overlapping curve, make sure the curve endpoint equals
      // the point associated with the vertex. If not, we attach an invalid
      // vertex to the extended point.
      if (! vh->is_at_open_boundary() && m_base_equal (base_p, vh->point()))
        return (Point_2(base_p, vh));
      else
        return (Point_2 (base_p));
    }
  };

  Construct_max_vertex_2 construct_max_vertex_2_object () const
  {
    return (Construct_max_vertex_2
            (m_base_traits->construct_max_vertex_2_object(),
             m_base_traits->equal_2_object()));
  }

  class Compare_xy_2 {
  protected:
    Base_compare_xy_2 m_base_cmp_xy;

    Compare_xy_2(const Base_compare_xy_2 & base) : m_base_cmp_xy(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const Point_2& p1, const Point_2& p2) const
    {
      if(p1.vertex_handle() == p2.vertex_handle() &&
         p1.vertex_handle() != Vertex_handle())
        return (EQUAL);

      return (m_base_cmp_xy(p1.base(), p2.base()));
    }
  };

  Compare_xy_2 compare_xy_2_object () const
  {
    return (Compare_xy_2 (m_base_traits->compare_xy_2_object()));
  }

  class Compare_y_at_x_2 {
  protected:
    Base_compare_y_at_x_2 m_base_cmp_y_at_x;

    Compare_y_at_x_2(const Base_compare_y_at_x_2& base) :
        m_base_cmp_y_at_x(base)
    {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const Point_2& p,
                                  const X_monotone_curve_2& xcv) const
    {
      return (m_base_cmp_y_at_x (p.base(), xcv.base()));
    }
  };

  Compare_y_at_x_2 compare_y_at_x_2_object () const
  {
    return (Compare_y_at_x_2 (m_base_traits->compare_y_at_x_2_object()));
  }

  class Compare_y_at_x_right_2 {
  protected:
    Base_compare_y_at_x_right_2 m_base_cmp_y_at_x_right;

    Compare_y_at_x_right_2(const Base_compare_y_at_x_right_2& base) :
        m_base_cmp_y_at_x_right(base)
    {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const X_monotone_curve_2& xcv1,
                                  const X_monotone_curve_2& xcv2,
                                  const Point_2& p) const
    {
      return (m_base_cmp_y_at_x_right(xcv1.base(),
                                      xcv2.base(),
                                      p.base()));
    }
  };

  Compare_y_at_x_right_2 compare_y_at_x_right_2_object () const
  {
    return (Compare_y_at_x_right_2
            (m_base_traits->compare_y_at_x_right_2_object()));
  }

  class Equal_2 {
  protected:
    Base_equal_2 m_base_eq;

    Equal_2(const Base_equal_2& base) : m_base_eq(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    bool operator() (const X_monotone_curve_2& xcv1,
                     const X_monotone_curve_2& xcv2) const
    {
      return (m_base_eq(xcv1.base(), xcv2.base()));
    }

    bool operator() (const Point_2& p1, const Point_2& p2) const
    {
      return (m_base_eq(p1.base(), p2.base()));
    }
  };

  Equal_2 equal_2_object () const
  {
    return (Equal_2 (m_base_traits->equal_2_object()));
  }

  class Compare_x_2 {
  protected:
    Base_compare_x_2 m_base_cmp_x;

    Compare_x_2(const Base_compare_x_2& base) : m_base_cmp_x(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const Point_2& p1, const Point_2& p2) const
    {
      return (m_base_cmp_x(p1.base(), p2.base()));
    }
  };

  Compare_x_2 compare_x_2_object () const
  {
    return (Compare_x_2 (m_base_traits->compare_x_2_object()));
  }

  class Is_vertical_2 {
  protected:
    Base_is_vertical_2 m_base_is_vert;

    Is_vertical_2(const Base_is_vertical_2& base) : m_base_is_vert(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
     bool operator() (const X_monotone_curve_2& xcv) const
    {
      return (m_base_is_vert(xcv.base()));
    }
  };

  Is_vertical_2 is_vertical_2_object() const
  {
    return (Is_vertical_2(m_base_traits->is_vertical_2_object()));
  }

  // left-right

  class Parameter_space_in_x_2 {
  protected:
    const Traits_2 * m_base;

    Parameter_space_in_x_2 (const Traits_2 * tr) : m_base(tr) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Arr_parameter_space operator() (const X_monotone_curve_2 & xcv,
                                    Arr_curve_end ce) const
    {
      return (m_base->parameter_space_in_x_2_object() (xcv.base(), ce));
    }

    Arr_parameter_space operator()(const Point_2 & p) const
    {
      return m_base->parameter_space_in_x_2_object() (p.base());
    }

    Arr_parameter_space operator()(const X_monotone_curve_2 & xcv) const
    {
      return m_base->parameter_space_in_x_2_object() (xcv.base());
    }
  
  };

  Parameter_space_in_x_2 parameter_space_in_x_2_object () const
  {
    return Parameter_space_in_x_2 (m_base_traits);
  }
  
  class Compare_y_near_boundary_2 {
  protected:
    const Traits_2 * m_base;

    Compare_y_near_boundary_2(const Traits_2 * base) : m_base(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const X_monotone_curve_2 & xcv1,
                                  const X_monotone_curve_2 & xcv2, 
                                  Arr_curve_end ce) const
    {
      return m_base->compare_y_near_boundary_2_object() (xcv1.base(),
                                                         xcv2.base(), ce);
    }

  };

  Compare_y_near_boundary_2 compare_y_near_boundary_2_object() const
  {
    return Compare_y_near_boundary_2 (m_base_traits);
  }
  
  class Compare_y_on_boundary_2 
  {
  protected:
    const Traits_2 * m_base;
    
    Compare_y_on_boundary_2 (const Traits_2 * base) : m_base(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const Point_2 & p1,
                                  const Point_2 & p2) const
    {
      return m_base->compare_y_on_boundary_2_object()(p1.base(), p2.base());
    }

  };

  Compare_y_on_boundary_2 compare_y_on_boundary_2_object() const
  {
    return Compare_y_on_boundary_2(m_base_traits);
  }

  // TODO Is_on_x_identification_2
  

  // bottom-top

  class Parameter_space_in_y_2 {
  protected:
    const Traits_2 * m_base;

    Parameter_space_in_y_2(const Traits_2 * tr) : m_base(tr) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Arr_parameter_space operator() (const X_monotone_curve_2& xcv,
                                    Arr_curve_end ce) const
    {
      return m_base->parameter_space_in_y_2_object() (xcv.base(), ce);
    }

    Arr_parameter_space operator()(const Point_2 & p) const
    {
      return m_base->parameter_space_in_y_2_object() (p.base());
    }

    Arr_parameter_space operator()(const X_monotone_curve_2 & xcv) const
    {
      return m_base->parameter_space_in_y_2_object() (xcv.base());
    }

  };

  Parameter_space_in_y_2 parameter_space_in_y_2_object () const
  {
    return Parameter_space_in_y_2 (m_base_traits);
  }

  class Compare_x_near_boundary_2 {
  protected:
    const Traits_2 * m_base;

    Compare_x_near_boundary_2 (const Traits_2 * base) : m_base(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const Point_2 & p,
                                  const X_monotone_curve_2 & xcv,
                                  Arr_curve_end ce) const
    {

      return m_base->compare_x_near_boundary_2_object() (p.base(),
                                                         xcv.base(), ce);
    }

    Comparison_result operator() (const X_monotone_curve_2 & xcv1,
                                  Arr_curve_end ce1,
                                  const X_monotone_curve_2 & xcv2,
                                  Arr_curve_end ce2) const
    {
      return m_base->compare_x_near_boundary_2_object() (xcv1.base(), ce1,
                                                         xcv2.base(), ce2);
    }

  };
  
  Compare_x_near_boundary_2 compare_x_near_boundary_2_object() const
  {
    return Compare_x_near_boundary_2(m_base_traits);
  }

  class Compare_x_on_boundary_2 
  {
  protected:
    const Traits_2 * m_base;
    
    Compare_x_on_boundary_2 (const Traits_2 * base) : m_base(base) {}

    friend class Arr_basic_insertion_traits_2<Traits_, Arrangement_>;

  public:
    Comparison_result operator() (const Point_2 & p1,
                                  const Point_2 & p2) const
    {
      return m_base->compare_x_on_boundary_2_object()(p1.base(), p2.base());
    }

  };

  Compare_x_on_boundary_2 compare_x_on_boundary_2_object() const
  {
    return Compare_x_on_boundary_2(m_base_traits);
  }

  // TODO Is_on_y_identification_2

};

CGAL_END_NAMESPACE

#endif