godot/scene/gui/box_container.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

400 lines
11 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* box_container.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
2014-02-10 01:10:30 +00:00
#include "box_container.h"
2023-09-08 19:00:10 +00:00
#include "scene/gui/label.h"
#include "scene/gui/margin_container.h"
#include "scene/theme/theme_db.h"
2014-02-10 01:10:30 +00:00
struct _MinSizeCache {
int min_size = 0;
bool will_stretch = false;
int final_size = 0;
2014-02-10 01:10:30 +00:00
};
void BoxContainer::_resort() {
/** First pass, determine minimum size AND amount of stretchable elements */
2017-01-14 17:03:38 +00:00
Size2i new_size = get_size();
2014-02-10 01:10:30 +00:00
bool rtl = is_layout_rtl();
2014-02-10 01:10:30 +00:00
bool first = true;
int children_count = 0;
int stretch_min = 0;
int stretch_avail = 0;
float stretch_ratio_total = 0.0;
HashMap<Control *, _MinSizeCache> min_size_cache;
2014-02-10 01:10:30 +00:00
for (int i = 0; i < get_child_count(); i++) {
Control *c = as_sortable_control(get_child(i));
if (!c) {
2014-02-10 01:10:30 +00:00
continue;
}
2014-02-10 01:10:30 +00:00
Size2i size = c->get_combined_minimum_size();
_MinSizeCache msc;
if (vertical) { /* VERTICAL */
stretch_min += size.height;
msc.min_size = size.height;
msc.will_stretch = c->get_v_size_flags().has_flag(SIZE_EXPAND);
2014-02-10 01:10:30 +00:00
} else { /* HORIZONTAL */
stretch_min += size.width;
msc.min_size = size.width;
msc.will_stretch = c->get_h_size_flags().has_flag(SIZE_EXPAND);
2014-02-10 01:10:30 +00:00
}
if (msc.will_stretch) {
stretch_avail += msc.min_size;
stretch_ratio_total += c->get_stretch_ratio();
}
msc.final_size = msc.min_size;
min_size_cache[c] = msc;
children_count++;
}
if (children_count == 0) {
2014-02-10 01:10:30 +00:00
return;
}
2014-02-10 01:10:30 +00:00
int stretch_max = (vertical ? new_size.height : new_size.width) - (children_count - 1) * theme_cache.separation;
2014-02-10 01:10:30 +00:00
int stretch_diff = stretch_max - stretch_min;
if (stretch_diff < 0) {
//avoid negative stretch space
stretch_diff = 0;
}
stretch_avail += stretch_diff; //available stretch space.
/** Second, pass successively to discard elements that can't be stretched, this will run while stretchable
2014-02-10 01:10:30 +00:00
elements exist */
bool has_stretched = false;
while (stretch_ratio_total > 0) { // first of all, don't even be here if no stretchable objects exist
2014-02-10 01:10:30 +00:00
has_stretched = true;
2014-02-10 01:10:30 +00:00
bool refit_successful = true; //assume refit-test will go well
float error = 0.0; // Keep track of accumulated error in pixels
2014-02-10 01:10:30 +00:00
for (int i = 0; i < get_child_count(); i++) {
Control *c = as_sortable_control(get_child(i));
if (!c) {
2014-02-10 01:10:30 +00:00
continue;
}
2014-02-10 01:10:30 +00:00
ERR_FAIL_COND(!min_size_cache.has(c));
_MinSizeCache &msc = min_size_cache[c];
if (msc.will_stretch) { //wants to stretch
//let's see if it can really stretch
float final_pixel_size = stretch_avail * c->get_stretch_ratio() / stretch_ratio_total;
// Add leftover fractional pixels to error accumulator
error += final_pixel_size - (int)final_pixel_size;
2014-02-10 01:10:30 +00:00
if (final_pixel_size < msc.min_size) {
//if available stretching area is too small for widget,
//then remove it from stretching area
msc.will_stretch = false;
stretch_ratio_total -= c->get_stretch_ratio();
refit_successful = false;
stretch_avail -= msc.min_size;
msc.final_size = msc.min_size;
break;
} else {
msc.final_size = final_pixel_size;
// Dump accumulated error if one pixel or more
if (error >= 1) {
msc.final_size += 1;
error -= 1;
}
2014-02-10 01:10:30 +00:00
}
}
}
if (refit_successful) { //uf refit went well, break
2014-02-10 01:10:30 +00:00
break;
}
2014-02-10 01:10:30 +00:00
}
/** Final pass, draw and stretch elements **/
int ofs = 0;
if (!has_stretched) {
if (!vertical) {
switch (alignment) {
case ALIGNMENT_BEGIN:
if (rtl) {
ofs = stretch_diff;
}
break;
case ALIGNMENT_CENTER:
ofs = stretch_diff / 2;
break;
case ALIGNMENT_END:
if (!rtl) {
ofs = stretch_diff;
}
break;
}
} else {
switch (alignment) {
case ALIGNMENT_BEGIN:
break;
case ALIGNMENT_CENTER:
ofs = stretch_diff / 2;
break;
case ALIGNMENT_END:
ofs = stretch_diff;
break;
}
}
}
2014-02-10 01:10:30 +00:00
first = true;
int idx = 0;
int start;
int end;
int delta;
if (!rtl || vertical) {
start = 0;
end = get_child_count();
delta = +1;
} else {
start = get_child_count() - 1;
end = -1;
delta = -1;
}
for (int i = start; i != end; i += delta) {
Control *c = as_sortable_control(get_child(i));
if (!c) {
2014-02-10 01:10:30 +00:00
continue;
}
2014-02-10 01:10:30 +00:00
_MinSizeCache &msc = min_size_cache[c];
if (first) {
2014-02-10 01:10:30 +00:00
first = false;
} else {
ofs += theme_cache.separation;
}
2014-02-10 01:10:30 +00:00
int from = ofs;
int to = ofs + msc.final_size;
if (msc.will_stretch && idx == children_count - 1) {
//adjust so the last one always fits perfect
//compensating for numerical imprecision
to = vertical ? new_size.height : new_size.width;
}
int size = to - from;
Rect2 rect;
if (vertical) {
rect = Rect2(0, from, new_size.width, size);
} else {
rect = Rect2(from, 0, size, new_size.height);
}
fit_child_in_rect(c, rect);
ofs = to;
idx++;
}
}
Size2 BoxContainer::get_minimum_size() const {
/* Calculate MINIMUM SIZE */
Size2i minimum;
bool first = true;
for (int i = 0; i < get_child_count(); i++) {
Control *c = Object::cast_to<Control>(get_child(i));
if (!c || !c->is_visible() || c->is_set_as_top_level()) {
2014-02-10 01:10:30 +00:00
continue;
}
2014-02-10 01:10:30 +00:00
Size2i size = c->get_combined_minimum_size();
if (vertical) { /* VERTICAL */
if (size.width > minimum.width) {
minimum.width = size.width;
}
minimum.height += size.height + (first ? 0 : theme_cache.separation);
2014-02-10 01:10:30 +00:00
} else { /* HORIZONTAL */
if (size.height > minimum.height) {
minimum.height = size.height;
}
minimum.width += size.width + (first ? 0 : theme_cache.separation);
2014-02-10 01:10:30 +00:00
}
first = false;
}
return minimum;
}
void BoxContainer::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_SORT_CHILDREN: {
_resort();
} break;
case NOTIFICATION_THEME_CHANGED: {
2021-12-06 13:02:34 +00:00
update_minimum_size();
} break;
case NOTIFICATION_TRANSLATION_CHANGED:
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
queue_sort();
} break;
2014-02-10 01:10:30 +00:00
}
}
2022-08-22 11:08:57 +00:00
void BoxContainer::_validate_property(PropertyInfo &p_property) const {
if (is_fixed && p_property.name == "vertical") {
p_property.usage = PROPERTY_USAGE_NONE;
}
}
void BoxContainer::set_alignment(AlignmentMode p_alignment) {
if (alignment == p_alignment) {
return;
}
alignment = p_alignment;
_resort();
}
BoxContainer::AlignmentMode BoxContainer::get_alignment() const {
return alignment;
}
2022-08-22 11:08:57 +00:00
void BoxContainer::set_vertical(bool p_vertical) {
ERR_FAIL_COND_MSG(is_fixed, "Can't change orientation of " + get_class() + ".");
vertical = p_vertical;
update_minimum_size();
_resort();
}
bool BoxContainer::is_vertical() const {
return vertical;
}
Control *BoxContainer::add_spacer(bool p_begin) {
2014-02-10 01:10:30 +00:00
Control *c = memnew(Control);
c->set_mouse_filter(MOUSE_FILTER_PASS); //allow spacer to pass mouse events
if (vertical) {
2014-02-10 01:10:30 +00:00
c->set_v_size_flags(SIZE_EXPAND_FILL);
} else {
2014-02-10 01:10:30 +00:00
c->set_h_size_flags(SIZE_EXPAND_FILL);
}
2014-02-10 01:10:30 +00:00
add_child(c);
if (p_begin) {
2014-02-10 01:10:30 +00:00
move_child(c, 0);
}
return c;
2014-02-10 01:10:30 +00:00
}
Vector<int> BoxContainer::get_allowed_size_flags_horizontal() const {
Vector<int> flags;
flags.append(SIZE_FILL);
if (!vertical) {
flags.append(SIZE_EXPAND);
}
flags.append(SIZE_SHRINK_BEGIN);
flags.append(SIZE_SHRINK_CENTER);
flags.append(SIZE_SHRINK_END);
return flags;
}
Vector<int> BoxContainer::get_allowed_size_flags_vertical() const {
Vector<int> flags;
flags.append(SIZE_FILL);
if (vertical) {
flags.append(SIZE_EXPAND);
}
flags.append(SIZE_SHRINK_BEGIN);
flags.append(SIZE_SHRINK_CENTER);
flags.append(SIZE_SHRINK_END);
return flags;
}
2014-02-10 01:10:30 +00:00
BoxContainer::BoxContainer(bool p_vertical) {
vertical = p_vertical;
}
void BoxContainer::_bind_methods() {
ClassDB::bind_method(D_METHOD("add_spacer", "begin"), &BoxContainer::add_spacer);
ClassDB::bind_method(D_METHOD("set_alignment", "alignment"), &BoxContainer::set_alignment);
2022-08-22 11:08:57 +00:00
ClassDB::bind_method(D_METHOD("get_alignment"), &BoxContainer::get_alignment);
ClassDB::bind_method(D_METHOD("set_vertical", "vertical"), &BoxContainer::set_vertical);
ClassDB::bind_method(D_METHOD("is_vertical"), &BoxContainer::is_vertical);
BIND_ENUM_CONSTANT(ALIGNMENT_BEGIN);
BIND_ENUM_CONSTANT(ALIGNMENT_CENTER);
BIND_ENUM_CONSTANT(ALIGNMENT_END);
ADD_PROPERTY(PropertyInfo(Variant::INT, "alignment", PROPERTY_HINT_ENUM, "Begin,Center,End"), "set_alignment", "get_alignment");
2022-08-22 11:08:57 +00:00
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "vertical"), "set_vertical", "is_vertical");
2023-09-08 19:00:10 +00:00
BIND_THEME_ITEM(Theme::DATA_TYPE_CONSTANT, BoxContainer, separation);
}
2014-02-10 01:10:30 +00:00
MarginContainer *VBoxContainer::add_margin_child(const String &p_label, Control *p_control, bool p_expand) {
Label *l = memnew(Label);
l->set_theme_type_variation("HeaderSmall");
2014-02-10 01:10:30 +00:00
l->set_text(p_label);
add_child(l);
2014-02-10 01:10:30 +00:00
MarginContainer *mc = memnew(MarginContainer);
mc->add_theme_constant_override("margin_left", 0);
2021-10-21 14:46:07 +00:00
mc->add_child(p_control, true);
add_child(mc);
if (p_expand) {
2014-02-10 01:10:30 +00:00
mc->set_v_size_flags(SIZE_EXPAND_FILL);
}
2014-02-10 01:10:30 +00:00
return mc;
}