#ifndef Magnum_Math_Geometry_Rectangle_h #define Magnum_Math_Geometry_Rectangle_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /** @file * @brief Class Magnum::Math::Geometry::Rectangle */ #include "Math/Vector2.h" namespace Magnum { namespace Math { namespace Geometry { /** @brief %Rectangle Helper class for storing axis-aligned rectangles consisting of bottom left and top right corner positions with origin in bottom left. Bottom/left positions are inclusive, while top/right positions are exclusive. @see Magnum::Rectangle, Magnum::Rectanglei, Magnum::Rectangled @todo rename to Range, make it generic for one, two and three dimensions, add translated(), padded()... @todo move outside Math? */ template class Rectangle { template friend class Rectangle; public: /** * Create rectangle from position and size * @param bottomLeft Bottom left rectangle corner * @param size %Rectangle size */ static Rectangle fromSize(const Vector2& bottomLeft, const Vector2& size) { return {bottomLeft, bottomLeft+size}; } /** * @brief Construct zero rectangle * * Construct zero-area rectangle positioned at origin. */ constexpr Rectangle() {} /** @brief Construct rectangle from two corners */ constexpr Rectangle(const Vector2& bottomLeft, const Vector2& topRight): _bottomLeft(bottomLeft), _topRight(topRight) {} /** * @brief Construct rectangle from another of different type * * Performs only default casting on the values, no rounding or * anything else. Example usage: * @code * Rectangle floatingPoint({1.3f, 2.7f}, {-15.0f, 7.0f}); * Rectangle integral(floatingPoint); // {{1, 2}, {-15, 7}} * @endcode */ template constexpr explicit Rectangle(const Rectangle& other): _bottomLeft(other._bottomLeft), _topRight(other._topRight) {} /** @brief Copy constructor */ constexpr Rectangle(const Rectangle&) = default; /** @brief Assignment operator */ Rectangle& operator=(const Rectangle&) = default; /** @brief Equality operator */ constexpr bool operator==(const Rectangle& other) const { return _bottomLeft == other._bottomLeft && _topRight == other._topRight; } /** @brief Non-equality operator */ constexpr bool operator!=(const Rectangle& other) const { return !operator==(other); } /** @brief Bottom left corner */ Vector2& bottomLeft() { return _bottomLeft; } constexpr Vector2 bottomLeft() const { return _bottomLeft; } /**< @overload */ /** @brief Bottom right corner */ constexpr Vector2 bottomRight() const { return {_topRight.x(), _bottomLeft.y()}; } /**< @overload */ /** @brief Top left corner */ constexpr Vector2 topLeft() const { return {_bottomLeft.x(), _topRight.y()}; } /**< @overload */ /** @brief Top right corner */ Vector2& topRight() { return _topRight; } constexpr Vector2 topRight() const { return _topRight; } /**< @overload */ /** @brief Bottom edge */ T& bottom() { return _bottomLeft.y(); } constexpr T bottom() const { return _bottomLeft.y(); } /**< @overload */ /** @brief Top edge */ T& top() { return _topRight.y(); } constexpr T top() const { return _topRight.y(); } /**< @overload */ /** @brief Left edge */ T& left() { return _bottomLeft.x(); } constexpr T left() const { return _bottomLeft.x(); } /**< @overload */ /** @brief Right edge */ T& right() { return _topRight.x(); } constexpr T right() const { return _topRight.x(); } /**< @overload */ /** @brief %Rectangle size */ constexpr Vector2 size() const { return _topRight-_bottomLeft; } /** @brief %Rectangle width */ constexpr T width() const { return _topRight.x() - _bottomLeft.x(); } /** @brief %Rectangle height */ constexpr T height() const { return _topRight.y() - _bottomLeft.y(); } /** @brief Translated rectangle */ Rectangle translated(const Vector2& vec) { return {_bottomLeft + vec, _topRight + vec}; }; private: Vector2 _bottomLeft; Vector2 _topRight; }; /** @debugoperator{Magnum::Math::Geometry::Rectangle} */ template Corrade::Utility::Debug operator<<(Corrade::Utility::Debug debug, const Rectangle& value) { debug << "Rectangle({"; debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, false); debug << value.left() << ", " << value.bottom() << "}, {" << value.right() << ", " << value.top() << "})"; debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, true); return debug; } }}} namespace Corrade { namespace Utility { /** @configurationvalue{Magnum::Math::Geometry::Rectangle} */ template struct ConfigurationValue> { ConfigurationValue() = delete; /** @brief Writes elements separated with spaces */ static std::string toString(const Magnum::Math::Geometry::Rectangle& value, const ConfigurationValueFlags flags) { return ConfigurationValue>::toString( reinterpret_cast&>(value), flags); } /** @brief Reads elements separated with whitespace */ static Magnum::Math::Geometry::Rectangle fromString(const std::string& stringValue, const ConfigurationValueFlags flags) { const auto vec = ConfigurationValue>::fromString(stringValue, flags); return {{vec[0], vec[1]}, {vec[2], vec[3]}}; } }; #ifndef DOXYGEN_GENERATING_OUTPUT extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; #ifndef MAGNUM_TARGET_GLES extern template struct MAGNUM_EXPORT ConfigurationValue>; #endif #endif }} #endif