dashed_line.hh

// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation, version 2 of the License.
//
// Olena is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or indashed_line functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_DRAW_DASHED_LINE_HH
# define MLN_DRAW_DASHED_LINE_HH


# include <mln/core/concept/function.hh>
# include <mln/core/concept/image.hh>
# include <mln/core/site_set/p_line2d.hh>
# include <mln/core/image/imorph/safe.hh>
# include <mln/data/fill.hh>
# include <mln/pw/image.hh>
# include <mln/pw/cst.hh>


namespace mln
{

  namespace draw
  {

    template <typename I>
    void dashed_line(Image<I>& ima,
                     const mln_psite(I)& beg, const mln_psite(I)& end,
                     const mln_value(I)& v);


# ifndef MLN_INCLUDE_ONLY

    namespace internal
    {

      template <typename I, unsigned dim>
      struct dashed_line_f : Function_v2b<dashed_line_f<I, dim> >
      {
        typedef bool result;

        bool operator()(const mln_site(I)& p) const
        {
          return p[dim] % 2;
        }

      };

    } // end of namespace mln::draw::internal



    template <typename I>
    inline
    void dashed_line(Image<I>& ima_,
                     const mln_psite(I)& beg, const mln_psite(I)& end,
                     const mln_value(I)& v)
    {
      I& ima = exact(ima_);
      mln_precondition(ima.is_valid());

      if (! ima.has(beg))
        trace::warning("Begin site is not part of the given image.");
      if (! ima.has(end))
        trace::warning("End site is not part of the given image.");

      data::fill(((ima | p_line2d(beg, end)).rw() | internal::dashed_line_f<I, 1>()).rw(), v);
    }

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::draw

} // end of namespace mln


#endif // ! MLN_DRAW_DASHED_LINE_HH