Tools/Boundary.h

Go to the documentation of this file.

/**
 * @file Boundary.h
 *
 * This file contains the template class Boundary.
 *
 * @author <A href=mailto:roefer@tzi.de>Thomas Röfer</A>
 */

#ifndef __BOUNDARY_H__
#define __BOUNDARY_H__

#include "Tools/Math/Vector2.h"
#include "Range.h"

/**
 * The template class represents rectangular boundaries.
 */
template<class T> class Boundary
{
  public:
    Range<T> x, /**< The range in x-direction. */
             y; /**< The range in y-direction. */

    /**
     * Constructor.
     */
    Boundary() : x(0,0), y(0,0) {}

    /**
     * Constructor.
     * This constructor allows to specify the minimum and maximum values
     * for type T, e.g. -HUGE_VAL and HUGE_VAL for double. These limits 
     * are used to construct the object, so that it can adapt to any boundary later.
     * @param min The minimum value of T.
     * @param max The maximum value of T.
     */
    Boundary(T min,T max)
    : x(max,min), y(max,min) {}

    /**
     * The function enlarges the boundary so that it also includes the specified point.
     * @param p The point.
     */
    void add(const Vector2<T>& p)
    {
      x.add(p.x),
      y.add(p.y);
    }

    /**
     * The function enlarges the boundary so that it also includes another boundary.
     * @param b The other boundary.
     */
    void add(const Boundary<T>& b)     // add function for adding Boundaries
    {
      x.add(b.x);
      y.add(b.y);
    }

    /**
     * The function checks whether a certain point is enclosed by the boundary 
     * @param p The point.
     * @return Lies the point inside the boundary?
     */
    bool isInside(const Vector2<T>& p) const 
      {return x.isInside(p.x) && y.isInside(p.y);}
};

#endif // __BOUNDARY_H_

---