cvrBresenhamCircle.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2005
 * Peter Doerfler
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrBresenhamCircle.h
 *         Contains the functor bresenhamCircle.
 * \author Peter Doerfler
 * \date   30.07.2005
 *
 * revisions ..: $Id: cvrBresenhamCircle.h,v 1.2 2005/08/09 14:34:33 arndh Exp $
 */

#ifndef _CVR_BRESENHAM_CIRCLE_H_
#define _CVR_BRESENHAM_CIRCLE_H_

#include "cvrFunctor.h"
#include "cvrGenericMatrix.h"
#include "cvrPointList.h"
#include "cvrLattice1D.h"

namespace cvr {

  /**
   * Functor for rendering circle segments with the Bresenham circle
   * drawing algorithm.
   *
   * The apply methods take the first and last points of the circle
   * segment, and an object where to store the points. Currently two
   * types of point stores are supported:
   *
   * - genericMatrix<T>, in which points are drawn with a given value of T
   * - ipointList, in which points are stored in the list
   *
   * Additional point stores may be added, see the addPoint() method.
   *
   */
  class bresenhamCircle : public functor {
  public:
    /**
     * The parameters for the class bresenhamCircle
     */
    class parameters : public functor::parameters {
    public:
      /**
       * Default constructor
       */
      parameters();

      /**
       * Copy constructor
       * \param other the parameters object to be copied
       */
      parameters(const parameters& other);

      /**
       * Destructor
       */
      ~parameters();

      /**
       * Copy the contents of a parameters object
       * \param other the parameters object to be copied
       * \return a reference to this parameters object
       */
      parameters& copy(const parameters& other);

      /**
       * Copy the contents of a parameters object
       * \param other the parameters object to be copied
       * \return a reference to this parameters object
       */
      parameters& operator=(const parameters& other);

      /**
       * Returns the complete name of the parameters class.
       */
      virtual const std::string& name() const;

      /**
       * Returns a pointer to a clone of the parameters.
       */
      virtual parameters* clone() const;

      /**
       * Returns a pointer to a new instance of the parameters.
       */
      virtual parameters* newInstance() const;

      /**
       * Write the parameters in the given ioHandler
       * \param handler the ioHandler to be used
       * \param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * \return true if write was successful
       */
      virtual bool write(ioHandler& handler,const bool complete=true) const;

      /**
       * Read the parameters from the given ioHandler
       * \param handler the ioHandler to be used
       * \param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * \return true if write was successful
       */
      virtual bool read(ioHandler& handler,const bool complete=true);

      // ------------------------------------------------
      // the parameters
      // ------------------------------------------------

      //TODO: comment the parameters of your functor
      // If you add more parameters manually, do not forget to do following:
      // 1. indicate in the default constructor the default values
      // 2. make sure that the copy member also copy your new parameters
      // 3. make sure that the read and write members also read and
      //    write your parameters


    };

    /**
     * Default constructor
     */
    bresenhamCircle();

    /**
     * Construct a functor using the given parameters
     */
    bresenhamCircle(const parameters& par);

    /**
     * Copy constructor
     * \param other the object to be copied
     */
    bresenhamCircle(const bresenhamCircle& other);

    /**
     * Destructor
     */
    virtual ~bresenhamCircle();

    /**
     * Render a circle with center \a (cx,cy) and radius \a radius.
     *
     * The circle will be drawn to the given genericMatrix<T> instance,
     * using the given color.
     *
     * @param cx x-coord of center
     * @param cy y-coord of center
     * @param radius radius of the circle
     * @param m matrix the circle is drawn into
     * @param color color the circle is drawn in
     */
    template<typename T>
    inline bool apply(const int cx, const int cy,
                      const int radius,
                      genericMatrix<T>& m, T color) const;

    /**
     * Render a circle with center \a (cx,cy) and radius \a radius.
     *
     * The point will be added to the given pointlist \a l.
     *
     * @param cx x-coord of center
     * @param cy y-coord of center
     * @param radius radius of the circle
     * @param l pointlist the points are added to
     */
    inline bool apply(const int cx, const int cy,
                      const int radius,
                      ipointList& l) const;

    /**
     * Render a circle with center \a center and radius \a radius.
     *
     * The circle will be drawn to the given genericMatrix<T> instance,
     * using the given color.
     *
     * @param center center of the circle
     * @param radius radius of the circle
     * @param m matrix the circle is drawn into
     * @param color color the circle is drawn in
     */
    template<typename T>
    inline bool apply(const ipoint& center, const int radius,
                      genericMatrix<T>& m, T color) const;

    /**
     * Render a circle with center \a center and radius \a radius.
     *
     * The point will be added to the given pointlist \a l.
     *
     * @param center center of the circle
     * @param radius radius of the circle
     * @param l pointlist the points are added to
     */
    inline bool apply(const ipoint& center, const int radius,
                      ipointList& l) const;

    /**
     * Render a circle with radius \a radius.
     *
     * The outmost x-coordinates of each y-coordinate will be added to
     * the given lattice1D \a ioPts. This lattice1D can then be used as io
     * points for sampling a circle area.
     *
     * @param radius radius of the circle
     * @param ioPts lattice1D containing io coordinates
     */
    inline bool apply(const int radius, lattice1D<int>& ioPts) const;

    /**
     * Copy data of "other" functor.
     * \param other the functor to be copied
     * \return a reference to this functor object
     */
    bresenhamCircle& copy(const bresenhamCircle& other);

    /**
     * Alias for copy member
     * \param other the functor to be copied
     * \return a reference to this functor object
     */
    bresenhamCircle& operator=(const bresenhamCircle& other);

    /**
     * Returns the complete name of the functor class
     */
    virtual const std::string& name() const;

    /**
     * Returns a pointer to a clone of this functor.
     */
    virtual bresenhamCircle* clone() const;

    /**
     * Returns a pointer to a new instance of this functor.
     */
    virtual bresenhamCircle* newInstance() const;

    /**
     * Returns used parameters
     */
    const parameters& getParameters() const;

    //TODO: comment the attributes of your functor
    // If you add more attributes manually, do not forget to do following:
    // 1. indicate in the default constructor the default values
    // 2. make sure that the copy member also copy your new attributes, or
    //    ensure there, that these attributes are properly initialized.

  private:

    /**
     * Implementation of the Bresenham circle rendering algorithm.
     * This method uses addPoint to store the produced points
     * in the given point store.
     */
    template<typename POINT_STORE, typename T>
    bool renderCircle(const int cx, const int cy, const int rad,
                      POINT_STORE& store, T color) const;

    /**
     * Adds the given point plus symmetric points to the given point
     * list.
     */
    template<typename T>
    inline void addPoints(const int cx, const int cy,
                          const int x, const int y,
                          ipointList& l, T unused) const;

    /**
     * Adds the given point plus symmetric points to the given ilattice1D.
     */
    template<typename T>
    inline void addPoints(const int cx, const int cy,
                          const int x, const int y,
                          lattice1D<int>& arr, T unused) const;

    /**
     * Draws the given point plus symmetric points to the given matrix
     * with the given color.
     */
    template<typename T>
    inline void addPoints(const int cx, const int cy,
                          const int x, const int y,
                          genericMatrix<T>& m, T color) const;

    /**
     * Sets the point \a (x,y) in \a m to \a color if 0<=x<mx
     * and 0<=y<m<.
     */
    template<typename T>
    inline void setPoint(const int x, const int y,
                         const int mx, const int my,
                         genericMatrix<T>& m, T color) const;

  };
}

#include "cvrBresenhamCircle_inline.h"

/* The following include is necesary, so that the renderCircle method
   gets instantiated for every instantiation of genericMatrix<T> as a
   point store. Otherwise, we would need to manually instantiate each
   apply for every T in genericMatrix<T>.
*/
#include "cvrBresenhamCircle_template.h"

#endif