rectangle.hh

Go to the documentation of this file.

/*
 * Scroom - Generic viewer for 2D data
 * Copyright (C) 2009-2026 Kees-Jan Dijkzeul
 *
 * SPDX-License-Identifier: LGPL-2.1
 */
 
#pragma once
 
#include <ostream>
 
#include <boost/operators.hpp>
 
#include <scroom/gtk-helpers.hh>
#include <scroom/linearsegment.hh>
#include <scroom/point.hh>
 
namespace Scroom::Utils
{
 
  template <typename T>
  class Rectangle
    : public boost::addable2<Rectangle<T>, Point<T>>
    , public boost::subtractable2<Rectangle<T>, Point<T>>
    , public boost::multipliable2<Rectangle<T>, T>
    , public boost::multipliable2<Rectangle<T>, Point<T>>
    , public boost::dividable2<Rectangle<T>, T>
    , public boost::dividable2<Rectangle<T>, Point<T>>
  {
  public:
    using value_type = T;
    using xy_type = Point<T>;
 
    Rectangle() = default;
 
    Rectangle(value_type x_, value_type y_, value_type width_, value_type height_)
      : horizontally(x_, width_)
      , vertically(y_, height_)
    {
    }
 
    Rectangle(const Segment<value_type>& horizontally_, const Segment<value_type>& vertically_)
      : horizontally(horizontally_)
      , vertically(vertically_)
    {
    }
 
    explicit Rectangle(const cairo_rectangle_int_t& rect)
      : horizontally(rect.x, rect.width)
      , vertically(rect.y, rect.height)
    {
    }
 
    template <bool T_is_int = std::is_same_v<int, std::remove_cv_t<T>>>
    explicit Rectangle(std::enable_if_t<!T_is_int, Rectangle<int> const&> rect)
      : horizontally(rect.getHorizontally())
      , vertically(rect.getVertically())
    {
    }
 
    [[nodiscard]] cairo_rectangle_int_t toGdkRectangle() const
    {
      return Scroom::GtkHelpers::createCairoIntRectangle(getLeft(), getTop(), getWidth(), getHeight());
    }
 
    [[nodiscard]] Rectangle moveTo(xy_type const& other) const { return moveTo(other.x, other.y); }
 
    [[nodiscard]] Rectangle moveTo(value_type const& x, value_type const& y) const
    {
      return Rectangle(horizontally.moveTo(x), vertically.moveTo(y));
    }
 
    [[nodiscard]] bool contains(xy_type const& other) const
    {
      return horizontally.contains(other.x) && vertically.contains(other.y);
    }
 
    [[nodiscard]] bool contains(const Rectangle& other) const
    {
      return horizontally.contains(other.horizontally) && vertically.contains(other.vertically);
    }
 
    [[nodiscard]] bool intersects(const Rectangle& other) const
    {
      return horizontally.intersects(other.horizontally) && vertically.intersects(other.vertically);
    }
 
    void reduceSizeToMultipleOf(value_type size)
    {
      horizontally.reduceSizeToMultipleOf(size);
      vertically.reduceSizeToMultipleOf(size);
    }
 
    [[nodiscard]] Rectangle intersection(const Rectangle& other) const
    {
      return Rectangle(horizontally.intersection(other.horizontally), vertically.intersection(other.vertically));
    }
 
    template <typename U>
    [[nodiscard]] Rectangle<std::common_type_t<T, U>> intersection(const Rectangle<U>& other) const
    {
      using R = std::common_type_t<T, U>;
 
      return Rectangle<R>(*this).intersection(Rectangle<R>(other));
    }
 
    [[nodiscard]] value_type getTop() const { return vertically.getStart(); }
 
    [[nodiscard]] value_type getLeft() const { return horizontally.getStart(); }
 
    [[nodiscard]] value_type getBottom() const { return vertically.getEnd(); }
 
    [[nodiscard]] value_type getRight() const { return horizontally.getEnd(); }
 
    void setTop(value_type v) { vertically.setStart(v); }
    void setLeft(value_type v) { horizontally.setStart(v); }
    void setBottom(value_type v) { vertically.setEnd(v); }
    void setRight(value_type v) { horizontally.setEnd(v); }
 
    [[nodiscard]] value_type getWidth() const { return horizontally.getSize(); }
 
    [[nodiscard]] value_type getHeight() const { return vertically.getSize(); }
 
    [[nodiscard]] value_type x() const { return getLeft(); }
 
    [[nodiscard]] value_type y() const { return getTop(); }
 
    [[nodiscard]] value_type width() const { return getWidth(); }
 
    [[nodiscard]] value_type height() const { return getHeight(); }
 
    [[nodiscard]] xy_type getTopLeft() const { return xy_type(horizontally.getStart(), vertically.getStart()); }
 
    [[nodiscard]] xy_type getTopRight() const { return xy_type(horizontally.getEnd(), vertically.getStart()); }
 
    [[nodiscard]] xy_type getBottomLeft() const { return xy_type(horizontally.getStart(), vertically.getEnd()); }
 
    [[nodiscard]] xy_type getBottomRight() const { return xy_type(horizontally.getEnd(), vertically.getEnd()); }
 
    [[nodiscard]] bool isEmpty() const { return horizontally.isEmpty() || vertically.isEmpty(); }
 
    [[nodiscard]] Rectangle<value_type> leftOf(value_type v) const
    {
      return Rectangle<value_type>(horizontally.before(v), vertically);
    }
 
    [[nodiscard]] Rectangle<value_type> rightOf(value_type v) const
    {
      return Rectangle<value_type>(horizontally.after(v), vertically);
    }
 
    [[nodiscard]] Rectangle<value_type> above(value_type v) const
    {
      return Rectangle<value_type>(horizontally, vertically.before(v));
    }
 
    [[nodiscard]] Rectangle<value_type> below(value_type v) const
    {
      return Rectangle<value_type>(horizontally, vertically.after(v));
    }
 
    [[nodiscard]] Rectangle<value_type> leftOf(Rectangle<value_type> const& r) const
    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.before(r.horizontally.getStart()), vertically.intersection(r.vertically));
    }
 
    [[nodiscard]] Rectangle<value_type> rightOf(Rectangle<value_type> const& r) const
    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.after(r.horizontally.getEnd()), vertically.intersection(r.vertically));
    }
 
    [[nodiscard]] Rectangle<value_type> above(Rectangle<value_type> const& r) const
    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.intersection(r.horizontally), vertically.before(r.vertically.getStart()));
    }
 
    [[nodiscard]] Rectangle<value_type> below(Rectangle<value_type> const& r) const
    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.intersection(r.horizontally), vertically.after(r.vertically.getEnd()));
    }
 
    bool operator==(const Rectangle& other) const
    {
      if(isEmpty() != other.isEmpty())
      {
        return false;
      }
 
      if(isEmpty())
      {
        return true;
      }
 
      return horizontally == other.horizontally && vertically == other.vertically;
    }
 
    bool operator!=(const Rectangle& other) const { return !(*this == other); }
 
    Rectangle<value_type>& operator+=(xy_type const& other)
    {
      horizontally += other.x;
      vertically += other.y;
      return *this;
    }
 
    Rectangle<value_type>& operator-=(xy_type const& other) { return *this += -other; }
 
    Rectangle<value_type>& operator*=(value_type other)
    {
      horizontally *= other;
      vertically *= other;
      return *this;
    }
 
    Rectangle<value_type>& operator*=(xy_type const& other)
    {
      horizontally *= other.x;
      vertically *= other.y;
      return *this;
    }
 
    Rectangle<value_type>& operator/=(value_type other)
    {
      horizontally /= other;
      vertically /= other;
      return *this;
    }
 
    Rectangle<value_type>& operator/=(xy_type const& other)
    {
      horizontally /= other.x;
      vertically /= other.y;
      return *this;
    }
 
    [[nodiscard]] const Segment<value_type>& getHorizontally() const { return horizontally; }
 
    [[nodiscard]] const Segment<value_type>& getVertically() const { return vertically; }
 
    void setSize(xy_type const& s)
    {
      horizontally.setSize(s.x);
      vertically.setSize(s.y);
    }
 
    [[nodiscard]] xy_type getSize() const { return xy_type(horizontally.getSize(), vertically.getSize()); }
 
    template <typename U>
    [[nodiscard]] Rectangle<U> to() const
    {
      return {
        horizontally.template to<U>(),
        vertically.template to<U>(),
      };
    }
 
  private:
    Segment<value_type> horizontally;
    Segment<value_type> vertically;
  };
 
  template <typename T>
  Rectangle<T> make_rect(T x, T y, T width, T height)
  {
    return Rectangle<T>(x, y, width, height);
  }
 
  template <typename T>
  Rectangle<T> make_rect(Point<T> position, Point<T> size)
  {
    return Rectangle<T>(position.x, position.y, size.x, size.y);
  }
 
  template <typename T>
  Rectangle<T> make_rect_from_start_end(Point<T> start, Point<T> end)
  {
    return Rectangle<T>(make_segment_from_start_end(start.x, end.x), make_segment_from_start_end(start.y, end.y));
  }
 
  template <typename T>
  std::ostream& operator<<(std::ostream& os, const Rectangle<T>& r)
  {
    os << '<' << r.getLeft() << ',' << r.getTop() << ',' << r.getWidth() << ',' << r.getHeight() << '>';
 
    return os;
  }
 
  inline std::ostream& operator<<(std::ostream& os, const cairo_rectangle_int_t& r) { return os << Rectangle<double>(r); }
 
  template <typename T, typename U>
  Rectangle<std::common_type_t<T, U>> operator*(Rectangle<T> left, U right)
  {
    Rectangle<std::common_type_t<T, U>> result(left);
    result *= static_cast<std::common_type_t<T, U>>(right);
    return result;
  }
 
  template <typename T, typename U>
  Rectangle<std::common_type_t<T, U>> operator*(T left, Rectangle<U> right)
  {
    return right * left;
  }
 
  inline Rectangle<double> operator*(cairo_rectangle_int_t const& r, Point<double> const& p) { return Rectangle<double>(r) * p; }
 
  inline Rectangle<double> operator*(Point<double> const& p, cairo_rectangle_int_t const& r) { return Rectangle<double>(r) * p; }
 
  template <typename T, typename U>
  Rectangle<std::common_type_t<T, U>> operator-(Rectangle<T> left, Point<U> right)
  {
    using R = std::common_type_t<T, U>;
 
    return Rectangle<R>(left) - Point<R>(right);
  }
 
  inline Rectangle<double> roundOutward(Rectangle<double> r)
  {
    return {
      roundOutward(r.getHorizontally()),
      roundOutward(r.getVertically()),
    };
  }
 
  inline Rectangle<double> roundCorners(Rectangle<double> r)
  {
    return make_rect_from_start_end(
      round_to_multiple_of(r.getTopLeft(), make_point(1.0)), round_to_multiple_of(r.getBottomRight(), make_point(1.0))
    );
  }
 
  template <typename T>
  inline Point<T> center(Rectangle<T> r)
  {
    return make_point(center(r.getHorizontally()), center(r.getVertically()));
  }
 
 
} // namespace Scroom::Utils