Files
FTXUI/src/ftxui/screen/box.cpp
Arthur Sonzogni 14da21b0ee Improve documentation (#1058)
* Remove @ingroup from class member definitions
* Add the documentation for every public classes.
2025-06-05 11:35:14 +02:00

66 lines
1.6 KiB
C++

// Copyright 2020 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.
#include "ftxui/screen/box.hpp"
#include <algorithm>
namespace ftxui {
/// @return the biggest Box contained in both |a| and |b|.
// static
Box Box::Intersection(Box a, Box b) {
return Box{
std::max(a.x_min, b.x_min),
std::min(a.x_max, b.x_max),
std::max(a.y_min, b.y_min),
std::min(a.y_max, b.y_max),
};
}
/// @return the smallest Box containing both |a| and |b|.
// static
Box Box::Union(Box a, Box b) {
return Box{
std::min(a.x_min, b.x_min),
std::max(a.x_max, b.x_max),
std::min(a.y_min, b.y_min),
std::max(a.y_max, b.y_max),
};
}
/// Shift the box by (x,y).
/// @param x horizontal shift.
/// @param y vertical shift.
void Box::Shift(int x, int y) {
x_min += x;
x_max += x;
y_min += y;
y_max += y;
}
/// @return whether (x,y) is contained inside the box.
bool Box::Contain(int x, int y) const {
return x_min <= x && //
x_max >= x && //
y_min <= y && //
y_max >= y;
}
/// @return whether the box is empty.
bool Box::IsEmpty() const {
return x_min > x_max || y_min > y_max;
}
/// @return whether |other| is the same as |this|
bool Box::operator==(const Box& other) const {
return (x_min == other.x_min) && (x_max == other.x_max) &&
(y_min == other.y_min) && (y_max == other.y_max);
}
/// @return whether |other| and |this| are different.
bool Box::operator!=(const Box& other) const {
return !operator==(other);
}
} // namespace ftxui