#include <bn_top_left_fixed_rect.h>
template<int Precision>
bn::top_left_fixed_rect_t class

Defines a two-dimensional rectangle using fixed point precision and a top-left point as position.

Constructors, destructors, conversion operators

top_left_fixed_rect_t() defaulted constexpr
Default constructor.
top_left_fixed_rect_t(const fixed_point_t<Precision>& position, const fixed_size_t<Precision>& dimensions) constexpr
Constructor.
top_left_fixed_rect_t(fixed_t<Precision> x, fixed_t<Precision> y, fixed_t<Precision> width, fixed_t<Precision> height) constexpr
Constructor.
top_left_fixed_rect_t(const top_left_rect& rect) constexpr
Constructor.

Public functions

auto position() const -> const fixed_point_t<Precision>& constexpr
Returns the position of the top-left point of the rectangle.
void set_position(const fixed_point_t<Precision>& position) constexpr
Sets the position of the top-left point of the rectangle.
void set_position(fixed_t<Precision> x, fixed_t<Precision> y) constexpr
Sets the position of the top-left point of the rectangle.
auto dimensions() const -> const fixed_size_t<Precision>& constexpr
Returns the size of the rectangle.
void set_dimensions(const fixed_size_t<Precision>& dimensions) constexpr
Sets the size of the rectangle.
void set_dimensions(fixed_t<Precision> width, fixed_t<Precision> height) constexpr
Sets the size of the rectangle.
auto x() const -> fixed_t<Precision> constexpr
Returns the horizontal position of the top-left point of the rectangle.
void set_x(fixed_t<Precision> x) constexpr
Sets the horizontal position of the top-left point of the rectangle.
auto y() const -> fixed_t<Precision> constexpr
Returns the vertical position of the top-left point of the rectangle.
void set_y(fixed_t<Precision> y) constexpr
Sets the vertical position of the top-left point of the rectangle.
auto width() const -> fixed_t<Precision> constexpr
Returns the width of the rectangle.
void set_width(fixed_t<Precision> width) constexpr
Sets the width of the rectangle.
auto height() const -> fixed_t<Precision> constexpr
Returns the height of the rectangle.
void set_height(fixed_t<Precision> height) constexpr
Sets the height of the rectangle.
auto top() const -> fixed_t<Precision> constexpr
Returns the position of the top boundary of the rectangle.
auto left() const -> fixed_t<Precision> constexpr
Returns the position of the left boundary of the rectangle.
auto bottom() const -> fixed_t<Precision> constexpr
Returns the position of the bottom boundary of the rectangle.
auto right() const -> fixed_t<Precision> constexpr
Returns the position of the right boundary of the rectangle.
auto top_left() const -> fixed_point_t<Precision> constexpr
Returns the position of the top-left corner of the rectangle.
auto top_right() const -> fixed_point_t<Precision> constexpr
Returns the position of the top-right corner of the rectangle.
auto bottom_left() const -> fixed_point_t<Precision> constexpr
Returns the position of the bottom-left corner of the rectangle.
auto bottom_right() const -> fixed_point_t<Precision> constexpr
Returns the position of the bottom-right corner of the rectangle.
auto center_x() const -> fixed_t<Precision> constexpr
Returns the horizontal position of the center point of the rectangle.
auto center_y() const -> fixed_t<Precision> constexpr
Returns the vertical position of the center point of the rectangle.
auto center() const -> fixed_point_t<Precision> constexpr
Returns the position of the center point of the rectangle.
auto contains(const fixed_point_t<Precision>& point) const -> bool constexpr
Indicates if the given point is inside the rectangle or not.
auto edge_contains(const fixed_point_t<Precision>& point) const -> bool constexpr
Indicates if the given point is inside the rectangle or not.
auto contains(const top_left_fixed_rect_t& other) const -> bool constexpr
Indicates if the given rectangle is inside this one or not.
auto edge_contains(const top_left_fixed_rect_t& other) const -> bool constexpr
Indicates if the given rectangle is inside this one or not.
auto intersects(const top_left_fixed_rect_t& other) const -> bool constexpr
Indicates if this rectangle intersects with the given one or not.
auto touches(const top_left_fixed_rect_t& other) const -> bool constexpr
Indicates if this rectangle touches the given one or not.

Friends

auto operator==(const top_left_fixed_rect_t& a, const top_left_fixed_rect_t& b) -> bool defaulted constexpr
Default equal operator.

Function documentation

template<int Precision>
bn::top_left_fixed_rect_t<Precision>::top_left_fixed_rect_t(const fixed_point_t<Precision>& position, const fixed_size_t<Precision>& dimensions) constexpr

Constructor.

Parameters
position Position of the top-left point of the rectangle.
dimensions Size of the rectangle.

template<int Precision>
bn::top_left_fixed_rect_t<Precision>::top_left_fixed_rect_t(fixed_t<Precision> x, fixed_t<Precision> y, fixed_t<Precision> width, fixed_t<Precision> height) constexpr

Constructor.

Parameters
x Horizontal position of the top-left point of the rectangle.
y Vertical position of the top-left point of the rectangle.
width Valid width of the rectangle (>= 0).
height Valid height of the rectangle (>= 0).

template<int Precision>
bn::top_left_fixed_rect_t<Precision>::top_left_fixed_rect_t(const top_left_rect& rect) constexpr

Constructor.

Parameters
rect Integer rectangle.

template<int Precision>
void bn::top_left_fixed_rect_t<Precision>::set_position(fixed_t<Precision> x, fixed_t<Precision> y) constexpr

Sets the position of the top-left point of the rectangle.

Parameters
x Horizontal position of the top-left point of the rectangle.
y Vertical position of the top-left point of the rectangle.

template<int Precision>
void bn::top_left_fixed_rect_t<Precision>::set_dimensions(fixed_t<Precision> width, fixed_t<Precision> height) constexpr

Sets the size of the rectangle.

Parameters
width Valid width of the rectangle (>= 0).
height Valid height of the rectangle (>= 0).

template<int Precision>
void bn::top_left_fixed_rect_t<Precision>::set_width(fixed_t<Precision> width) constexpr

Sets the width of the rectangle.

Parameters
width Valid width (>= 0).

template<int Precision>
void bn::top_left_fixed_rect_t<Precision>::set_height(fixed_t<Precision> height) constexpr

Sets the height of the rectangle.

Parameters
height Valid height (>= 0).

template<int Precision>
bool bn::top_left_fixed_rect_t<Precision>::contains(const fixed_point_t<Precision>& point) const constexpr

Indicates if the given point is inside the rectangle or not.

If the point is on the edge of the rectangle, it returns false.

template<int Precision>
bool bn::top_left_fixed_rect_t<Precision>::edge_contains(const fixed_point_t<Precision>& point) const constexpr

Indicates if the given point is inside the rectangle or not.

If the point is on the edge of the rectangle, it returns true.

template<int Precision>
bool bn::top_left_fixed_rect_t<Precision>::contains(const top_left_fixed_rect_t& other) const constexpr

Indicates if the given rectangle is inside this one or not.

If the given rectangle is on the edge of this one, it returns false.

template<int Precision>
bool bn::top_left_fixed_rect_t<Precision>::edge_contains(const top_left_fixed_rect_t& other) const constexpr

Indicates if the given rectangle is inside this one or not.

If the given rectangle is on the edge of this one, it returns true.

template<int Precision>
bool bn::top_left_fixed_rect_t<Precision>::intersects(const top_left_fixed_rect_t& other) const constexpr

Indicates if this rectangle intersects with the given one or not.

Two rectangles intersect if there is at least one point that is within both rectangles, excluding their edges.

template<int Precision>
bool bn::top_left_fixed_rect_t<Precision>::touches(const top_left_fixed_rect_t& other) const constexpr

Indicates if this rectangle touches the given one or not.

Two rectangles touch each other if there is at least one point that is within both rectangles, including their edges.