499 lines
14 KiB
C++
499 lines
14 KiB
C++
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#include "box_container.h"
|
|
|
|
#include "core/object/class_db.h"
|
|
#include "scene/gui/label.h"
|
|
#include "scene/gui/margin_container.h"
|
|
#include "scene/theme/theme_db.h"
|
|
|
|
struct _MinSizeCache {
|
|
int min_size = 0;
|
|
int desired_size = 0;
|
|
int max_size = -1;
|
|
real_t stretch_ratio = 0;
|
|
bool will_stretch = false;
|
|
int final_size = 0;
|
|
};
|
|
|
|
void BoxContainer::_resort() {
|
|
Size2i new_size = get_size();
|
|
Size2i combined_max_size = get_combined_maximum_size();
|
|
bool propagating_max_size = vertical ? is_propagating_maximum_size() && combined_max_size.height >= 0 : is_propagating_maximum_size() && combined_max_size.width >= 0;
|
|
|
|
bool rtl = is_layout_rtl();
|
|
|
|
bool first = true;
|
|
int children_count = 0;
|
|
int combined_min = 0;
|
|
int stretch_space = 0;
|
|
float stretch_ratio_total = 0.0;
|
|
int desired_extra_space = 0;
|
|
HashMap<Control *, _MinSizeCache> min_size_cache;
|
|
|
|
for (int i = 0; i < get_child_count(); i++) {
|
|
Control *c = as_sortable_control(get_child(i));
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
|
|
if (propagating_max_size) {
|
|
c->set_parent_maximum_size_cache(combined_max_size);
|
|
}
|
|
Size2i min_size = c->get_bound_minimum_size().ceil();
|
|
Size2i desired_size = c->get_bound_desired_size().ceil();
|
|
Size2i max_size = c->get_combined_maximum_size().floor();
|
|
_MinSizeCache msc;
|
|
|
|
if (vertical) { /* VERTICAL */
|
|
msc.min_size = min_size.height;
|
|
msc.desired_size = desired_size.height;
|
|
msc.max_size = max_size.height;
|
|
msc.will_stretch = c->get_v_size_flags().has_flag(SIZE_EXPAND);
|
|
|
|
} else { /* HORIZONTAL */
|
|
msc.min_size = min_size.width;
|
|
msc.desired_size = desired_size.width;
|
|
msc.max_size = max_size.width;
|
|
msc.will_stretch = c->get_h_size_flags().has_flag(SIZE_EXPAND);
|
|
}
|
|
|
|
if (msc.will_stretch) {
|
|
stretch_space += msc.min_size;
|
|
stretch_ratio_total += c->get_stretch_ratio();
|
|
}
|
|
|
|
combined_min += msc.min_size;
|
|
desired_extra_space += msc.desired_size - msc.min_size;
|
|
|
|
msc.final_size = msc.min_size;
|
|
min_size_cache[c] = msc;
|
|
children_count++;
|
|
}
|
|
|
|
if (children_count == 0) {
|
|
return;
|
|
}
|
|
|
|
int max_space = (vertical ? new_size.height : new_size.width);
|
|
if (propagating_max_size) {
|
|
max_space = MIN(max_space, vertical ? combined_max_size.height : combined_max_size.width);
|
|
}
|
|
max_space -= theme_cache.separation * (children_count - 1);
|
|
int stretch_diff = max_space - combined_min;
|
|
if (stretch_diff < 0) {
|
|
//avoid negative stretch space
|
|
stretch_diff = 0;
|
|
}
|
|
|
|
stretch_space += stretch_diff; //available stretch space.
|
|
|
|
// First, allocate extra space to Controls which have a desired size larger than their minimum size, up to their desired size, in proportion to how much extra space they want.
|
|
if (stretch_diff > 0 && desired_extra_space > 0) {
|
|
real_t space_available_ratio = MIN(real_t(stretch_diff) / real_t(desired_extra_space), 1.0);
|
|
|
|
for (Node *child : iterate_children()) {
|
|
Control *c = as_sortable_control(child, SortableVisibilityMode::VISIBLE);
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
|
|
_MinSizeCache &msc = min_size_cache[c];
|
|
|
|
if (msc.desired_size > msc.min_size) {
|
|
int desired_size_increase = floor((msc.desired_size - msc.min_size) * space_available_ratio);
|
|
|
|
if (msc.will_stretch) {
|
|
// Increase the minimum size to reflect the desired size allocation, so that the SIZE_EXPAND allocation does not shrink them back down.
|
|
msc.min_size += desired_size_increase;
|
|
} else {
|
|
// If the Control isn't stretchable
|
|
stretch_space -= desired_size_increase;
|
|
}
|
|
|
|
msc.final_size += desired_size_increase;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Second, allocate stretch space to Controls with the SIZE_EXPAND flag, in proportion to their stretch ratio.
|
|
while (stretch_ratio_total > 0) {
|
|
bool refit_successful = true;
|
|
float error = 0.0; // Keep track of accumulated error in pixels
|
|
|
|
for (int i = 0; i < get_child_count(); i++) {
|
|
Control *c = as_sortable_control(get_child(i));
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
|
|
ERR_FAIL_COND(!min_size_cache.has(c));
|
|
_MinSizeCache &msc = min_size_cache[c];
|
|
|
|
if (msc.will_stretch) {
|
|
float stretch_ratio = c->get_stretch_ratio();
|
|
float final_pixel_size = stretch_space * stretch_ratio / stretch_ratio_total;
|
|
|
|
// Add leftover fractional pixels to error accumulator and dump if greater than 1.
|
|
error += final_pixel_size - (int)final_pixel_size;
|
|
if (error >= 1) {
|
|
final_pixel_size += 1;
|
|
error -= 1;
|
|
}
|
|
|
|
if (final_pixel_size < msc.min_size) {
|
|
// If stretching would make the Control smaller than its minimum size, cap it and redistribute its unused share.
|
|
msc.will_stretch = false;
|
|
stretch_ratio_total -= stretch_ratio;
|
|
refit_successful = false;
|
|
stretch_space -= msc.min_size;
|
|
msc.final_size = msc.min_size;
|
|
break;
|
|
} else if (msc.max_size >= 0 && final_pixel_size > msc.max_size) {
|
|
// If stretching would exceed the Control's maximum size, cap it and redistribute its unused share.
|
|
msc.will_stretch = false;
|
|
stretch_ratio_total -= stretch_ratio;
|
|
refit_successful = false;
|
|
stretch_space -= msc.max_size;
|
|
msc.final_size = msc.max_size;
|
|
break;
|
|
} else {
|
|
msc.final_size = final_pixel_size;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (refit_successful) { //uf refit went well, break
|
|
break;
|
|
}
|
|
}
|
|
|
|
/** Final pass, draw and stretch elements **/
|
|
|
|
int ofs = 0;
|
|
int final_stretch_diff = max_space - combined_min;
|
|
for (int i = 0; i < get_child_count(); i++) {
|
|
Control *c = as_sortable_control(get_child(i));
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
|
|
ERR_FAIL_COND(!min_size_cache.has(c));
|
|
_MinSizeCache &msc = min_size_cache[c];
|
|
final_stretch_diff -= msc.final_size - msc.min_size;
|
|
}
|
|
|
|
if (final_stretch_diff < 0) {
|
|
final_stretch_diff = 0;
|
|
}
|
|
|
|
if (!vertical) {
|
|
switch (alignment) {
|
|
case ALIGNMENT_BEGIN:
|
|
if (rtl) {
|
|
ofs = final_stretch_diff;
|
|
}
|
|
break;
|
|
case ALIGNMENT_CENTER:
|
|
ofs = final_stretch_diff / 2;
|
|
break;
|
|
case ALIGNMENT_END:
|
|
if (!rtl) {
|
|
ofs = final_stretch_diff;
|
|
}
|
|
break;
|
|
}
|
|
} else {
|
|
switch (alignment) {
|
|
case ALIGNMENT_BEGIN:
|
|
break;
|
|
case ALIGNMENT_CENTER:
|
|
ofs = final_stretch_diff / 2;
|
|
break;
|
|
case ALIGNMENT_END:
|
|
ofs = final_stretch_diff;
|
|
break;
|
|
}
|
|
}
|
|
|
|
first = true;
|
|
int idx = 0;
|
|
|
|
int start;
|
|
int end;
|
|
int delta;
|
|
|
|
if ((rtl && !vertical) != reverse_sort) {
|
|
start = get_child_count() - 1;
|
|
end = -1;
|
|
delta = -1;
|
|
} else {
|
|
start = 0;
|
|
end = get_child_count();
|
|
delta = +1;
|
|
}
|
|
|
|
int accumulated_size = 0;
|
|
for (int i = start; i != end; i += delta) {
|
|
Control *c = as_sortable_control(get_child(i));
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
|
|
_MinSizeCache &msc = min_size_cache[c];
|
|
|
|
if (first) {
|
|
first = false;
|
|
} else {
|
|
ofs += theme_cache.separation;
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
if (propagating_max_size) {
|
|
if (vertical) {
|
|
c->set_parent_maximum_size_cache(Size2(combined_max_size.width, MAX(combined_max_size.height - accumulated_size, 0)));
|
|
} else {
|
|
c->set_parent_maximum_size_cache(Size2(MAX(combined_max_size.width - accumulated_size, 0), combined_max_size.height));
|
|
}
|
|
}
|
|
|
|
fit_child_in_rect(c, rect);
|
|
|
|
accumulated_size += size + theme_cache.separation;
|
|
ofs = to;
|
|
idx++;
|
|
}
|
|
}
|
|
|
|
Size2 BoxContainer::_get_minimum_size(bool p_use_desired_sizes) const {
|
|
/* Calculate MINIMUM SIZE */
|
|
|
|
Size2i minimum;
|
|
|
|
bool first = true;
|
|
|
|
for (int i = 0; i < get_child_count(); i++) {
|
|
Control *c = as_sortable_control(get_child(i), SortableVisibilityMode::VISIBLE);
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
|
|
Size2i size = p_use_desired_sizes ? c->get_bound_desired_size().ceil() : c->get_bound_minimum_size().ceil();
|
|
|
|
if (vertical) { /* VERTICAL */
|
|
|
|
if (size.width > minimum.width) {
|
|
minimum.width = size.width;
|
|
}
|
|
|
|
minimum.height += size.height + (first ? 0 : theme_cache.separation);
|
|
|
|
} else { /* HORIZONTAL */
|
|
|
|
if (size.height > minimum.height) {
|
|
minimum.height = size.height;
|
|
}
|
|
|
|
minimum.width += size.width + (first ? 0 : theme_cache.separation);
|
|
}
|
|
|
|
first = false;
|
|
}
|
|
|
|
return minimum;
|
|
}
|
|
|
|
Size2 BoxContainer::get_minimum_size() const {
|
|
return _get_minimum_size(false);
|
|
}
|
|
|
|
Size2 BoxContainer::get_desired_size() const {
|
|
return _get_minimum_size(true);
|
|
}
|
|
|
|
void BoxContainer::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_SORT_CHILDREN: {
|
|
_resort();
|
|
} break;
|
|
|
|
case NOTIFICATION_THEME_CHANGED: {
|
|
update_minimum_size();
|
|
} break;
|
|
|
|
case NOTIFICATION_TRANSLATION_CHANGED:
|
|
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
|
|
queue_sort();
|
|
} break;
|
|
}
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
void BoxContainer::set_reverse_sort(bool p_reverse_sort) {
|
|
if (reverse_sort == p_reverse_sort) {
|
|
return;
|
|
}
|
|
reverse_sort = p_reverse_sort;
|
|
queue_sort();
|
|
}
|
|
|
|
bool BoxContainer::is_reverse_sort() const {
|
|
return reverse_sort;
|
|
}
|
|
|
|
Control *BoxContainer::add_spacer(bool p_begin) {
|
|
Control *c = memnew(Control);
|
|
c->set_mouse_filter(MOUSE_FILTER_PASS); //allow spacer to pass mouse events
|
|
|
|
if (vertical) {
|
|
c->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
} else {
|
|
c->set_h_size_flags(SIZE_EXPAND_FILL);
|
|
}
|
|
|
|
add_child(c);
|
|
if (p_begin) {
|
|
move_child(c, 0);
|
|
}
|
|
|
|
return c;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
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);
|
|
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);
|
|
ClassDB::bind_method(D_METHOD("set_reverse_sort", "reverse_sort"), &BoxContainer::set_reverse_sort);
|
|
ClassDB::bind_method(D_METHOD("is_reverse_sort"), &BoxContainer::is_reverse_sort);
|
|
|
|
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");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "vertical"), "set_vertical", "is_vertical");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "reverse_sort"), "set_reverse_sort", "is_reverse_sort");
|
|
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_CONSTANT, BoxContainer, separation);
|
|
}
|
|
|
|
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");
|
|
l->set_text(p_label);
|
|
add_child(l);
|
|
MarginContainer *mc = memnew(MarginContainer);
|
|
mc->add_child(p_control, true);
|
|
add_child(mc);
|
|
if (p_expand) {
|
|
mc->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
}
|
|
p_control->set_accessibility_name(p_label);
|
|
|
|
return mc;
|
|
}
|