Scroom::Utils::Rectangle< T > Class Template Reference

#include <rectangle.hh>

Inheritance diagram for Scroom::Utils::Rectangle< T >:

Collaboration diagram for Scroom::Utils::Rectangle< T >:

Public Types
using	value_type = T
using	xy_type = Point< T >

Public Member Functions
	Rectangle ()=default
	Rectangle (value_type x_, value_type y_, value_type width_, value_type height_)
	Rectangle (const Segment< value_type > &horizontally_, const Segment< value_type > &vertically_)
	Rectangle (const cairo_rectangle_int_t &rect)
template<bool T_is_int = std::is_same<int, typename std::remove_cv<T>::type>::value>
	Rectangle (typename std::enable_if<!T_is_int, Rectangle< int > const & >::type rect)
cairo_rectangle_int_t	toGdkRectangle () const
Rectangle	moveTo (xy_type const &other) const
Rectangle	moveTo (value_type const &x, value_type const &y) const
bool	contains (xy_type const &other) const
bool	contains (const Rectangle &other) const
bool	intersects (const Rectangle &other) const
void	reduceSizeToMultipleOf (value_type size)
Rectangle	intersection (const Rectangle &other) const
template<typename U >
Rectangle< typename std::common_type< T, U >::type >	intersection (const Rectangle< U > &other) const
value_type	getTop () const
value_type	getLeft () const
value_type	getBottom () const
value_type	getRight () const
void	setTop (value_type v)
void	setLeft (value_type v)
void	setBottom (value_type v)
void	setRight (value_type v)
value_type	getWidth () const
value_type	getHeight () const
value_type	x () const
value_type	y () const
value_type	width () const
value_type	height () const
xy_type	getTopLeft () const
xy_type	getTopRight () const
xy_type	getBottomLeft () const
xy_type	getBottomRight () const
bool	isEmpty () const
Rectangle< value_type >	leftOf (value_type v) const
Rectangle< value_type >	rightOf (value_type v) const
Rectangle< value_type >	above (value_type v) const
Rectangle< value_type >	below (value_type v) const
Rectangle< value_type >	leftOf (Rectangle< value_type > const &r) const
Rectangle< value_type >	rightOf (Rectangle< value_type > const &r) const
Rectangle< value_type >	above (Rectangle< value_type > const &r) const
Rectangle< value_type >	below (Rectangle< value_type > const &r) const
bool	operator== (const Rectangle &other) const
bool	operator!= (const Rectangle &other) const
Rectangle< value_type > &	operator+= (xy_type const &other)
Rectangle< value_type > &	operator-= (xy_type const &other)
Rectangle< value_type > &	operator*= (value_type other)
Rectangle< value_type > &	operator*= (xy_type const &other)
Rectangle< value_type > &	operator/= (value_type other)
Rectangle< value_type > &	operator/= (xy_type const &other)
const Segment< value_type > &	getHorizontally () const
const Segment< value_type > &	getVertically () const
void	setSize (xy_type const &s)
xy_type	getSize () const
template<typename U >
Rectangle< U >	to () const

Private Attributes
Segment< value_type >	horizontally
Segment< value_type >	vertically

Member Typedef Documentation

value_type

template<typename T >

using Scroom::Utils::Rectangle< T >::value_type = T

xy_type

template<typename T >

using Scroom::Utils::Rectangle< T >::xy_type = Point<T>

Constructor & Destructor Documentation

Rectangle() [1/5]

template<typename T >

Scroom::Utils::Rectangle< T >::Rectangle ( )

default

Referenced by Scroom::Utils::Rectangle< int >::intersection(), and Scroom::Utils::Rectangle< int >::moveTo().

Here is the caller graph for this function:

Rectangle() [2/5]

template<typename T >

Scroom::Utils::Rectangle< T >::Rectangle ( value_type  x_, value_type  y_, value_type  width_, value_type  height_  )

inline

      : horizontally(x_, width_)
      , vertically(y_, height_)
    {
    }

Rectangle() [3/5]

template<typename T >

Scroom::Utils::Rectangle< T >::Rectangle ( const Segment< value_type > &  horizontally_, const Segment< value_type > &  vertically_  )

inline

      : horizontally(horizontally_)
      , vertically(vertically_)
    {
    }

Rectangle() [4/5]

template<typename T >

Scroom::Utils::Rectangle< T >::Rectangle ( const cairo_rectangle_int_t &  rect )

inlineexplicit

      : horizontally(rect.x, rect.width)
      , vertically(rect.y, rect.height)
    {
    }

Rectangle() [5/5]

template<typename T >

template<bool T_is_int = std::is_same<int, typename std::remove_cv<T>::type>::value>

Scroom::Utils::Rectangle< T >::Rectangle ( typename std::enable_if<!T_is_int, Rectangle< int > const & >::type  rect )

inlineexplicit

Implicit conversion from Rectangle<int> to Rectangle<T>. If T!=int

      : horizontally(rect.getHorizontally())
      , vertically(rect.getVertically())
    {
    }

Member Function Documentation

above() [1/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::above ( Rectangle< value_type > const &  r ) const

inline

    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.intersection(r.horizontally), vertically.before(r.vertically.getStart()));
    }

above() [2/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::above ( value_type  v ) const

inline

    {
      return Rectangle<value_type>(horizontally, vertically.before(v));
    }

Referenced by BOOST_AUTO_TEST_CASE(), and drawOutOfBoundsWithoutBackground().

Here is the caller graph for this function:

below() [1/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::below ( Rectangle< value_type > const &  r ) const

inline

    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.intersection(r.horizontally), vertically.after(r.vertically.getEnd()));
    }

below() [2/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::below ( value_type  v ) const

inline

    {
      return Rectangle<value_type>(horizontally, vertically.after(v));
    }

Referenced by BOOST_AUTO_TEST_CASE(), and drawOutOfBoundsWithoutBackground().

Here is the caller graph for this function:

contains() [1/2]

template<typename T >

bool Scroom::Utils::Rectangle< T >::contains ( const Rectangle< T > &  other ) const

inline

    {
      return horizontally.contains(other.horizontally) && vertically.contains(other.vertically);
    }

contains() [2/2]

template<typename T >

bool Scroom::Utils::Rectangle< T >::contains ( xy_type const &  other ) const

inline

    {
      return horizontally.contains(other.x) && vertically.contains(other.y);
    }

getBottom()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::getBottom ( ) const

inline

{ return vertically.getEnd(); }

Referenced by anonymous_namespace{sizedeterminer.cc}::DetermineSize(), drawOutOfBoundsWithoutBackground(), PipetteCommonOperationsCMYK::sumPixelValues(), and PipetteCommonOperationsRGB::sumPixelValues().

Here is the caller graph for this function:

getBottomLeft()

template<typename T >

xy_type Scroom::Utils::Rectangle< T >::getBottomLeft ( ) const

inline

{ return xy_type(horizontally.getStart(), vertically.getEnd()); }

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

getBottomRight()

template<typename T >

xy_type Scroom::Utils::Rectangle< T >::getBottomRight ( ) const

inline

{ return xy_type(horizontally.getEnd(), vertically.getEnd()); }

Referenced by BOOST_AUTO_TEST_CASE(), PipetteHandler::displayValues(), rects_are_close(), and Scroom::Utils::roundCorners().

Here is the caller graph for this function:

getHeight()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::getHeight ( ) const

inline

{ return vertically.getSize(); }

Referenced by PipetteHandler::displayValues(), Scroom::Utils::Rectangle< int >::height(), Scroom::Utils::operator<<(), setClip(), Scroom::TiledBitmap::to_metadata(), and Scroom::Utils::Rectangle< int >::toGdkRectangle().

Here is the caller graph for this function:

getHorizontally()

template<typename T >

const Segment<value_type>& Scroom::Utils::Rectangle< T >::getHorizontally ( ) const

inline

{ return horizontally; }

Referenced by BOOST_AUTO_TEST_CASE(), Scroom::Utils::center(), and Scroom::Utils::roundOutward().

Here is the caller graph for this function:

getLeft()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::getLeft ( ) const

inline

{ return horizontally.getStart(); }

Referenced by anonymous_namespace{sizedeterminer.cc}::DetermineSize(), drawOutOfBoundsWithoutBackground(), Scroom::Utils::operator<<(), TiledBitmap::redraw(), setClip(), PipetteCommonOperationsCMYK::sumPixelValues(), PipetteCommonOperationsRGB::sumPixelValues(), Scroom::Utils::Rectangle< int >::toGdkRectangle(), and Scroom::Utils::Rectangle< int >::x().

Here is the caller graph for this function:

getRight()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::getRight ( ) const

inline

{ return horizontally.getEnd(); }

Referenced by anonymous_namespace{sizedeterminer.cc}::DetermineSize(), drawOutOfBoundsWithoutBackground(), PipetteCommonOperationsCMYK::sumPixelValues(), and PipetteCommonOperationsRGB::sumPixelValues().

Here is the caller graph for this function:

getSize()

template<typename T >

xy_type Scroom::Utils::Rectangle< T >::getSize ( ) const

inline

{ return xy_type(horizontally.getSize(), vertically.getSize()); }

getTop()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::getTop ( ) const

inline

{ return vertically.getStart(); }

Referenced by anonymous_namespace{sizedeterminer.cc}::DetermineSize(), drawOutOfBoundsWithoutBackground(), Scroom::Utils::operator<<(), setClip(), PipetteCommonOperationsCMYK::sumPixelValues(), PipetteCommonOperationsRGB::sumPixelValues(), Scroom::Utils::Rectangle< int >::toGdkRectangle(), and Scroom::Utils::Rectangle< int >::y().

Here is the caller graph for this function:

getTopLeft()

template<typename T >

xy_type Scroom::Utils::Rectangle< T >::getTopLeft ( ) const

inline

{ return xy_type(horizontally.getStart(), vertically.getStart()); }

Referenced by BOOST_AUTO_TEST_CASE(), PipetteHandler::displayValues(), CommonOperations::draw(), Operations1bpp::draw(), Operations8bpp::draw(), Operations::draw(), drawOutOfBoundsWithBackground(), drawOutOfBoundsWithBackgroundColor(), drawOutOfBoundsWithoutBackground(), rects_are_close(), MeasureHandler::render(), PipetteHandler::render(), and Scroom::Utils::roundCorners().

Here is the caller graph for this function:

getTopRight()

template<typename T >

xy_type Scroom::Utils::Rectangle< T >::getTopRight ( ) const

inline

{ return xy_type(horizontally.getEnd(), vertically.getStart()); }

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

getVertically()

template<typename T >

const Segment<value_type>& Scroom::Utils::Rectangle< T >::getVertically ( ) const

inline

{ return vertically; }

Referenced by BOOST_AUTO_TEST_CASE(), Scroom::Utils::center(), and Scroom::Utils::roundOutward().

Here is the caller graph for this function:

getWidth()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::getWidth ( ) const

inline

{ return horizontally.getSize(); }

Referenced by PipetteHandler::displayValues(), Scroom::Utils::operator<<(), setClip(), PipetteCommonOperationsCMYK::sumPixelValues(), PipetteCommonOperationsRGB::sumPixelValues(), Scroom::TiledBitmap::to_metadata(), Scroom::Utils::Rectangle< int >::toGdkRectangle(), and Scroom::Utils::Rectangle< int >::width().

Here is the caller graph for this function:

height()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::height ( ) const

inline

{ return getHeight(); }

Referenced by TiledBitmap::drawTile(), traceRectangleContour(), View::updateScrollbars(), and View::updateZoom().

Here is the caller graph for this function:

intersection() [1/2]

template<typename T >

Rectangle Scroom::Utils::Rectangle< T >::intersection ( const Rectangle< T > &  other ) const

inline

    {
      return Rectangle(horizontally.intersection(other.horizontally), vertically.intersection(other.vertically));
    }

Referenced by PipetteHandler::computeValues(), anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation::getPixelAverages(), Scroom::Utils::Rectangle< int >::intersection(), and TiledBitmap::redraw().

Here is the caller graph for this function:

intersection() [2/2]

template<typename T >

template<typename U >

Rectangle<typename std::common_type<T, U>::type> Scroom::Utils::Rectangle< T >::intersection ( const Rectangle< U > &  other ) const

inline

    {
      using R = typename std::common_type<T, U>::type;
 
      return Rectangle<R>(*this).intersection(Rectangle<R>(other));
    }

intersects()

template<typename T >

bool Scroom::Utils::Rectangle< T >::intersects ( const Rectangle< T > &  other ) const

inline

    {
      return horizontally.intersects(other.horizontally) && vertically.intersects(other.vertically);
    }

isEmpty()

template<typename T >

bool Scroom::Utils::Rectangle< T >::isEmpty ( ) const

inline

{ return horizontally.isEmpty() || vertically.isEmpty(); }

Referenced by Scroom::Utils::Rectangle< int >::above(), Scroom::Utils::Rectangle< int >::below(), Scroom::Utils::Rectangle< int >::leftOf(), Scroom::Utils::Rectangle< int >::operator==(), and Scroom::Utils::Rectangle< int >::rightOf().

Here is the caller graph for this function:

leftOf() [1/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::leftOf ( Rectangle< value_type > const &  r ) const

inline

    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.before(r.horizontally.getStart()), vertically.intersection(r.vertically));
    }

leftOf() [2/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::leftOf ( value_type  v ) const

inline

    {
      return Rectangle<value_type>(horizontally.before(v), vertically);
    }

Referenced by BOOST_AUTO_TEST_CASE(), and drawOutOfBoundsWithoutBackground().

Here is the caller graph for this function:

moveTo() [1/2]

template<typename T >

Rectangle Scroom::Utils::Rectangle< T >::moveTo ( value_type const &  x, value_type const &  y  ) const

inline

    {
      return Rectangle(horizontally.moveTo(x), vertically.moveTo(y));
    }

moveTo() [2/2]

template<typename T >

Rectangle Scroom::Utils::Rectangle< T >::moveTo ( xy_type const &  other ) const

inline

{ return moveTo(other.x, other.y); }

Referenced by drawOutOfBoundsWithBackground(), and Scroom::Utils::Rectangle< int >::moveTo().

Here is the caller graph for this function:

operator!=()

template<typename T >

bool Scroom::Utils::Rectangle< T >::operator!= ( const Rectangle< T > &  other ) const

inline

{ return !(*this == other); }

operator*=() [1/2]

template<typename T >

Rectangle<value_type>& Scroom::Utils::Rectangle< T >::operator*= ( value_type  other )

inline

    {
      horizontally *= other;
      vertically *= other;
      return *this;
    }

operator*=() [2/2]

template<typename T >

Rectangle<value_type>& Scroom::Utils::Rectangle< T >::operator*= ( xy_type const &  other )

inline

    {
      horizontally *= other.x;
      vertically *= other.y;
      return *this;
    }

operator+=()

template<typename T >

Rectangle<value_type>& Scroom::Utils::Rectangle< T >::operator+= ( xy_type const &  other )

inline

    {
      horizontally += other.x;
      vertically += other.y;
      return *this;
    }

operator-=()

template<typename T >

Rectangle<value_type>& Scroom::Utils::Rectangle< T >::operator-= ( xy_type const &  other )

inline

{ return *this += -other; }

operator/=() [1/2]

template<typename T >

Rectangle<value_type>& Scroom::Utils::Rectangle< T >::operator/= ( value_type  other )

inline

    {
      horizontally /= other;
      vertically /= other;
      return *this;
    }

operator/=() [2/2]

template<typename T >

Rectangle<value_type>& Scroom::Utils::Rectangle< T >::operator/= ( xy_type const &  other )

inline

    {
      horizontally /= other.x;
      vertically /= other.y;
      return *this;
    }

operator==()

template<typename T >

bool Scroom::Utils::Rectangle< T >::operator== ( const Rectangle< T > &  other ) const

inline

    {
      if(isEmpty() != other.isEmpty())
      {
        return false;
      }
 
      if(isEmpty())
      {
        return true;
      }
 
      return horizontally == other.horizontally && vertically == other.vertically;
    }

reduceSizeToMultipleOf()

template<typename T >

void Scroom::Utils::Rectangle< T >::reduceSizeToMultipleOf ( value_type  size )

inline

    {
      horizontally.reduceSizeToMultipleOf(size);
      vertically.reduceSizeToMultipleOf(size);
    }

rightOf() [1/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::rightOf ( Rectangle< value_type > const &  r ) const

inline

    {
      if(r.isEmpty())
      {
        return r;
      }
 
      return Rectangle<value_type>(horizontally.after(r.horizontally.getEnd()), vertically.intersection(r.vertically));
    }

rightOf() [2/2]

template<typename T >

Rectangle<value_type> Scroom::Utils::Rectangle< T >::rightOf ( value_type  v ) const

inline

    {
      return Rectangle<value_type>(horizontally.after(v), vertically);
    }

Referenced by BOOST_AUTO_TEST_CASE(), and drawOutOfBoundsWithoutBackground().

Here is the caller graph for this function:

setBottom()

template<typename T >

void Scroom::Utils::Rectangle< T >::setBottom ( value_type  v )

inline

{ vertically.setEnd(v); }

setLeft()

template<typename T >

void Scroom::Utils::Rectangle< T >::setLeft ( value_type  v )

inline

{ horizontally.setStart(v); }

setRight()

template<typename T >

void Scroom::Utils::Rectangle< T >::setRight ( value_type  v )

inline

{ horizontally.setEnd(v); }

setSize()

template<typename T >

void Scroom::Utils::Rectangle< T >::setSize ( xy_type const &  s )

inline

    {
      horizontally.setSize(s.x);
      vertically.setSize(s.y);
    }

setTop()

template<typename T >

void Scroom::Utils::Rectangle< T >::setTop ( value_type  v )

inline

{ vertically.setStart(v); }

to()

template<typename T >

template<typename U >

Rectangle<U> Scroom::Utils::Rectangle< T >::to ( ) const

inline

    {
      return {
        horizontally.template to<U>(),
        vertically.template to<U>(),
      };
    }

toGdkRectangle()

template<typename T >

cairo_rectangle_int_t Scroom::Utils::Rectangle< T >::toGdkRectangle ( ) const

inline

    {
      return Scroom::GtkHelpers::createCairoIntRectangle(getLeft(), getTop(), getWidth(), getHeight());
    }

Referenced by ExamplePresentation::redraw(), and TransparentOverlayViewInfo::redraw().

Here is the caller graph for this function:

width()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::width ( ) const

inline

{ return getWidth(); }

Referenced by TiledBitmap::drawTile(), traceRectangleContour(), View::updateScrollbars(), and View::updateZoom().

Here is the caller graph for this function:

x()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::x ( ) const

inline

{ return getLeft(); }

Referenced by Operations1bpp::draw(), Operations8bpp::draw(), Operations::draw(), TiledBitmap::drawTile(), Scroom::Utils::Rectangle< int >::moveTo(), traceRectangleContour(), and View::updateScrollbars().

Here is the caller graph for this function:

y()

template<typename T >

value_type Scroom::Utils::Rectangle< T >::y ( ) const

inline

{ return getTop(); }

Referenced by Operations1bpp::draw(), Operations8bpp::draw(), Operations::draw(), TiledBitmap::drawTile(), Scroom::Utils::Rectangle< int >::moveTo(), traceRectangleContour(), and View::updateScrollbars().

Here is the caller graph for this function:

Member Data Documentation

horizontally

template<typename T >

Segment<value_type> Scroom::Utils::Rectangle< T >::horizontally

private

Referenced by Scroom::Utils::Rectangle< int >::above(), Scroom::Utils::Rectangle< int >::below(), Scroom::Utils::Rectangle< int >::contains(), Scroom::Utils::Rectangle< int >::getBottomLeft(), Scroom::Utils::Rectangle< int >::getBottomRight(), Scroom::Utils::Rectangle< int >::getHorizontally(), Scroom::Utils::Rectangle< int >::getLeft(), Scroom::Utils::Rectangle< int >::getRight(), Scroom::Utils::Rectangle< int >::getSize(), Scroom::Utils::Rectangle< int >::getTopLeft(), Scroom::Utils::Rectangle< int >::getTopRight(), Scroom::Utils::Rectangle< int >::getWidth(), Scroom::Utils::Rectangle< int >::intersection(), Scroom::Utils::Rectangle< int >::intersects(), Scroom::Utils::Rectangle< int >::isEmpty(), Scroom::Utils::Rectangle< int >::leftOf(), Scroom::Utils::Rectangle< int >::moveTo(), Scroom::Utils::Rectangle< int >::operator*=(), Scroom::Utils::Rectangle< int >::operator+=(), Scroom::Utils::Rectangle< int >::operator/=(), Scroom::Utils::Rectangle< int >::operator==(), Scroom::Utils::Rectangle< int >::reduceSizeToMultipleOf(), Scroom::Utils::Rectangle< int >::rightOf(), Scroom::Utils::Rectangle< int >::setLeft(), Scroom::Utils::Rectangle< int >::setRight(), Scroom::Utils::Rectangle< int >::setSize(), and Scroom::Utils::Rectangle< int >::to().

vertically

template<typename T >

Segment<value_type> Scroom::Utils::Rectangle< T >::vertically

private

Referenced by Scroom::Utils::Rectangle< int >::above(), Scroom::Utils::Rectangle< int >::below(), Scroom::Utils::Rectangle< int >::contains(), Scroom::Utils::Rectangle< int >::getBottom(), Scroom::Utils::Rectangle< int >::getBottomLeft(), Scroom::Utils::Rectangle< int >::getBottomRight(), Scroom::Utils::Rectangle< int >::getHeight(), Scroom::Utils::Rectangle< int >::getSize(), Scroom::Utils::Rectangle< int >::getTop(), Scroom::Utils::Rectangle< int >::getTopLeft(), Scroom::Utils::Rectangle< int >::getTopRight(), Scroom::Utils::Rectangle< int >::getVertically(), Scroom::Utils::Rectangle< int >::intersection(), Scroom::Utils::Rectangle< int >::intersects(), Scroom::Utils::Rectangle< int >::isEmpty(), Scroom::Utils::Rectangle< int >::leftOf(), Scroom::Utils::Rectangle< int >::moveTo(), Scroom::Utils::Rectangle< int >::operator*=(), Scroom::Utils::Rectangle< int >::operator+=(), Scroom::Utils::Rectangle< int >::operator/=(), Scroom::Utils::Rectangle< int >::operator==(), Scroom::Utils::Rectangle< int >::reduceSizeToMultipleOf(), Scroom::Utils::Rectangle< int >::rightOf(), Scroom::Utils::Rectangle< int >::setBottom(), Scroom::Utils::Rectangle< int >::setSize(), Scroom::Utils::Rectangle< int >::setTop(), and Scroom::Utils::Rectangle< int >::to().

---

The documentation for this class was generated from the following file:

• inc/scroom/rectangle.hh