mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +08:00
d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
246 lines
8.0 KiB
C++
246 lines
8.0 KiB
C++
/**************************************************************************/
|
|
/* rect2i.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef RECT2I_H
|
|
#define RECT2I_H
|
|
|
|
#include "core/error/error_macros.h"
|
|
#include "core/math/vector2i.h"
|
|
|
|
class String;
|
|
struct Rect2;
|
|
|
|
struct _NO_DISCARD_ Rect2i {
|
|
Point2i position;
|
|
Size2i size;
|
|
|
|
const Point2i &get_position() const { return position; }
|
|
void set_position(const Point2i &p_position) { position = p_position; }
|
|
const Size2i &get_size() const { return size; }
|
|
void set_size(const Size2i &p_size) { size = p_size; }
|
|
|
|
int get_area() const { return size.width * size.height; }
|
|
|
|
_FORCE_INLINE_ Vector2i get_center() const { return position + (size / 2); }
|
|
|
|
inline bool intersects(const Rect2i &p_rect) const {
|
|
#ifdef MATH_CHECKS
|
|
if (unlikely(size.x < 0 || size.y < 0 || p_rect.size.x < 0 || p_rect.size.y < 0)) {
|
|
ERR_PRINT("Rect2i size is negative, this is not supported. Use Rect2i.abs() to get a Rect2i with a positive size.");
|
|
}
|
|
#endif
|
|
if (position.x >= (p_rect.position.x + p_rect.size.width)) {
|
|
return false;
|
|
}
|
|
if ((position.x + size.width) <= p_rect.position.x) {
|
|
return false;
|
|
}
|
|
if (position.y >= (p_rect.position.y + p_rect.size.height)) {
|
|
return false;
|
|
}
|
|
if ((position.y + size.height) <= p_rect.position.y) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
inline bool encloses(const Rect2i &p_rect) const {
|
|
#ifdef MATH_CHECKS
|
|
if (unlikely(size.x < 0 || size.y < 0 || p_rect.size.x < 0 || p_rect.size.y < 0)) {
|
|
ERR_PRINT("Rect2i size is negative, this is not supported. Use Rect2i.abs() to get a Rect2i with a positive size.");
|
|
}
|
|
#endif
|
|
return (p_rect.position.x >= position.x) && (p_rect.position.y >= position.y) &&
|
|
((p_rect.position.x + p_rect.size.x) <= (position.x + size.x)) &&
|
|
((p_rect.position.y + p_rect.size.y) <= (position.y + size.y));
|
|
}
|
|
|
|
_FORCE_INLINE_ bool has_area() const {
|
|
return size.x > 0 && size.y > 0;
|
|
}
|
|
|
|
// Returns the instersection between two Rect2is or an empty Rect2i if there is no intersection
|
|
inline Rect2i intersection(const Rect2i &p_rect) const {
|
|
Rect2i new_rect = p_rect;
|
|
|
|
if (!intersects(new_rect)) {
|
|
return Rect2i();
|
|
}
|
|
|
|
new_rect.position.x = MAX(p_rect.position.x, position.x);
|
|
new_rect.position.y = MAX(p_rect.position.y, position.y);
|
|
|
|
Point2i p_rect_end = p_rect.position + p_rect.size;
|
|
Point2i end = position + size;
|
|
|
|
new_rect.size.x = MIN(p_rect_end.x, end.x) - new_rect.position.x;
|
|
new_rect.size.y = MIN(p_rect_end.y, end.y) - new_rect.position.y;
|
|
|
|
return new_rect;
|
|
}
|
|
|
|
inline Rect2i merge(const Rect2i &p_rect) const { ///< return a merged rect
|
|
#ifdef MATH_CHECKS
|
|
if (unlikely(size.x < 0 || size.y < 0 || p_rect.size.x < 0 || p_rect.size.y < 0)) {
|
|
ERR_PRINT("Rect2i size is negative, this is not supported. Use Rect2i.abs() to get a Rect2i with a positive size.");
|
|
}
|
|
#endif
|
|
Rect2i new_rect;
|
|
|
|
new_rect.position.x = MIN(p_rect.position.x, position.x);
|
|
new_rect.position.y = MIN(p_rect.position.y, position.y);
|
|
|
|
new_rect.size.x = MAX(p_rect.position.x + p_rect.size.x, position.x + size.x);
|
|
new_rect.size.y = MAX(p_rect.position.y + p_rect.size.y, position.y + size.y);
|
|
|
|
new_rect.size = new_rect.size - new_rect.position; // Make relative again.
|
|
|
|
return new_rect;
|
|
}
|
|
bool has_point(const Point2i &p_point) const {
|
|
#ifdef MATH_CHECKS
|
|
if (unlikely(size.x < 0 || size.y < 0)) {
|
|
ERR_PRINT("Rect2i size is negative, this is not supported. Use Rect2i.abs() to get a Rect2i with a positive size.");
|
|
}
|
|
#endif
|
|
if (p_point.x < position.x) {
|
|
return false;
|
|
}
|
|
if (p_point.y < position.y) {
|
|
return false;
|
|
}
|
|
|
|
if (p_point.x >= (position.x + size.x)) {
|
|
return false;
|
|
}
|
|
if (p_point.y >= (position.y + size.y)) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool operator==(const Rect2i &p_rect) const { return position == p_rect.position && size == p_rect.size; }
|
|
bool operator!=(const Rect2i &p_rect) const { return position != p_rect.position || size != p_rect.size; }
|
|
|
|
Rect2i grow(int p_amount) const {
|
|
Rect2i g = *this;
|
|
g.position.x -= p_amount;
|
|
g.position.y -= p_amount;
|
|
g.size.width += p_amount * 2;
|
|
g.size.height += p_amount * 2;
|
|
return g;
|
|
}
|
|
|
|
inline Rect2i grow_side(Side p_side, int p_amount) const {
|
|
Rect2i g = *this;
|
|
g = g.grow_individual((SIDE_LEFT == p_side) ? p_amount : 0,
|
|
(SIDE_TOP == p_side) ? p_amount : 0,
|
|
(SIDE_RIGHT == p_side) ? p_amount : 0,
|
|
(SIDE_BOTTOM == p_side) ? p_amount : 0);
|
|
return g;
|
|
}
|
|
|
|
inline Rect2i grow_side_bind(uint32_t p_side, int p_amount) const {
|
|
return grow_side(Side(p_side), p_amount);
|
|
}
|
|
|
|
inline Rect2i grow_individual(int p_left, int p_top, int p_right, int p_bottom) const {
|
|
Rect2i g = *this;
|
|
g.position.x -= p_left;
|
|
g.position.y -= p_top;
|
|
g.size.width += p_left + p_right;
|
|
g.size.height += p_top + p_bottom;
|
|
|
|
return g;
|
|
}
|
|
|
|
_FORCE_INLINE_ Rect2i expand(const Vector2i &p_vector) const {
|
|
Rect2i r = *this;
|
|
r.expand_to(p_vector);
|
|
return r;
|
|
}
|
|
|
|
inline void expand_to(const Point2i &p_vector) {
|
|
#ifdef MATH_CHECKS
|
|
if (unlikely(size.x < 0 || size.y < 0)) {
|
|
ERR_PRINT("Rect2i size is negative, this is not supported. Use Rect2i.abs() to get a Rect2i with a positive size.");
|
|
}
|
|
#endif
|
|
Point2i begin = position;
|
|
Point2i end = position + size;
|
|
|
|
if (p_vector.x < begin.x) {
|
|
begin.x = p_vector.x;
|
|
}
|
|
if (p_vector.y < begin.y) {
|
|
begin.y = p_vector.y;
|
|
}
|
|
|
|
if (p_vector.x > end.x) {
|
|
end.x = p_vector.x;
|
|
}
|
|
if (p_vector.y > end.y) {
|
|
end.y = p_vector.y;
|
|
}
|
|
|
|
position = begin;
|
|
size = end - begin;
|
|
}
|
|
|
|
_FORCE_INLINE_ Rect2i abs() const {
|
|
return Rect2i(Point2i(position.x + MIN(size.x, 0), position.y + MIN(size.y, 0)), size.abs());
|
|
}
|
|
|
|
_FORCE_INLINE_ void set_end(const Vector2i &p_end) {
|
|
size = p_end - position;
|
|
}
|
|
|
|
_FORCE_INLINE_ Vector2i get_end() const {
|
|
return position + size;
|
|
}
|
|
|
|
operator String() const;
|
|
operator Rect2() const;
|
|
|
|
Rect2i() {}
|
|
Rect2i(int p_x, int p_y, int p_width, int p_height) :
|
|
position(Point2i(p_x, p_y)),
|
|
size(Size2i(p_width, p_height)) {
|
|
}
|
|
Rect2i(const Point2i &p_pos, const Size2i &p_size) :
|
|
position(p_pos),
|
|
size(p_size) {
|
|
}
|
|
};
|
|
|
|
#endif // RECT2I_H
|