FTXUI 6.1.9 C++ functional terminal UI.

Loading...
Searching...
No Matches
box.hpp
Go to the documentation of this file.
1// Copyright 2020 Arthur Sonzogni. All rights reserved.
2// Use of this source code is governed by the MIT license that can be found in
3// the LICENSE file.
4#ifndef FTXUI_SCREEN_BOX_HPP
5#define FTXUI_SCREEN_BOX_HPP
6
7 namespace ftxui {
8
9/// @brief Box is a structure that represents a rectangular area in a 2D space.
10///
11/// It is defined by its minimum and maximum coordinates along the x and y axes.
12/// Note that the coordinates are inclusive, meaning that the box includes both
13/// the minimum and maximum values.
14///
15/// @ingroup screen
16 struct Box {
17 int x_min = 0;
18 int x_max = 0;
19 int y_min = 0;
20 int y_max = 0;
21
22 static auto Intersection(Box a, Box b) -> Box;
23 static auto Union(Box a, Box b) -> Box;
24 void Shift(int x, int y);
25 bool Contain(int x, int y) const;
26 bool IsEmpty() const;
27 bool operator==(const Box& other) const;
28 bool operator!=(const Box& other) const;
29};
30
31} // namespace ftxui
32
33#endif // FTXUI_SCREEN_BOX_HPP
ftxui::Box::operator!=
bool operator!=(const Box &other) const
Definition box.cpp:61
ftxui::Box::Contain
bool Contain(int x, int y) const
Definition box.cpp:42
ftxui::Box::Shift
void Shift(int x, int y)
Definition box.cpp:34
ftxui::Box::x_max
int x_max
Definition box.hpp:18
ftxui::Box::y_min
int y_min
Definition box.hpp:19
ftxui::Box::Intersection
static auto Intersection(Box a, Box b) -> Box
Definition box.cpp:11
ftxui::Box::IsEmpty
bool IsEmpty() const
Definition box.cpp:50
ftxui::Box::y_max
int y_max
Definition box.hpp:20
ftxui::Box::operator==
bool operator==(const Box &other) const
Definition box.cpp:55
ftxui::Box::Union
static auto Union(Box a, Box b) -> Box
Definition box.cpp:22
ftxui::Box::x_min
int x_min
Definition box.hpp:17
ftxui::Box
Box is a structure that represents a rectangular area in a 2D space.
Definition box.hpp:16
ftxui
The FTXUI ftxui:: namespace.
Definition animation.hpp:10