Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 12:12:28 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #56104 from Geometror/add-flow-layout-container

Browse Source 
Add FlowContainer
This commit is contained in:
Rémi Verschelde 2022-01-18 20:26:29 +01:00 committed by GitHub
commit 030638e5b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 403 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/classes/FlowContainer.xml Normal file
View File

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="FlowContainer" inherits="Container" version="4.0">
<brief_description>
Base class for flow containers.
</brief_description>
<description>
Arranges child [Control] nodes vertically or horizontally in a left-to-right or top-to-bottom flow.
A line is filled with [Control] nodes until no more fit on the same line, similar to text in an autowrapped label.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_line_count" qualifiers="const">
<return type="int" />
<description>
Returns the current line count.
</description>
</method>
</methods>
</class>

19
doc/classes/HFlowContainer.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="HFlowContainer" inherits="FlowContainer" version="4.0">
<brief_description>
Horizontal flow container.
</brief_description>
<description>
Horizontal version of [FlowContainer].
</description>
<tutorials>
</tutorials>
<theme_items>
<theme_item name="hseparation" data_type="constant" type="int" default="4">
The horizontal separation of children nodes.
</theme_item>
<theme_item name="vseparation" data_type="constant" type="int" default="4">
The vertical separation of children nodes.
</theme_item>
</theme_items>
</class>

19
doc/classes/VFlowContainer.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VFlowContainer" inherits="FlowContainer" version="4.0">
<brief_description>
Vertical flow container.
</brief_description>
<description>
Vertical version of [FlowContainer].
</description>
<tutorials>
</tutorials>
<theme_items>
<theme_item name="hseparation" data_type="constant" type="int" default="4">
The horizontal separation of children nodes.
</theme_item>
<theme_item name="vseparation" data_type="constant" type="int" default="4">
The vertical separation of children nodes.
</theme_item>
</theme_items>
</class>

6
editor/editor_themes.cpp
View File

@ -1123,6 +1123,12 @@ Ref<Theme> create_editor_theme(const Ref<Theme> p_theme) {
theme->set_constant("margin_bottom", "MarginContainer", 0);
theme->set_constant("hseparation", "GridContainer", default_margin_size * EDSCALE);
theme->set_constant("vseparation", "GridContainer", default_margin_size * EDSCALE);
theme->set_constant("hseparation", "FlowContainer", default_margin_size * EDSCALE);
theme->set_constant("vseparation", "FlowContainer", default_margin_size * EDSCALE);
theme->set_constant("hseparation", "HFlowContainer", default_margin_size * EDSCALE);
theme->set_constant("vseparation", "HFlowContainer", default_margin_size * EDSCALE);
theme->set_constant("hseparation", "VFlowContainer", default_margin_size * EDSCALE);
theme->set_constant("vseparation", "VFlowContainer", default_margin_size * EDSCALE);
// Window

1
editor/icons/HFlowContainer.svg Normal file
View File

@ -0,0 +1 @@
<svg height="16" width="16" xmlns="http://www.w3.org/2000/svg"><path d="M3 1a2 2 0 0 0-2 2v10a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3a2 2 0 0 0-2-2H3zm0 2h10v10H3V3zm2 1c-.554 0-1 .446-1 1s.446 1 1 1h2c.554 0 1-.446 1-1s-.446-1-1-1H5zm4.996 0c-.554 0-1 .446-1 1s.446 1 1 1H11c.554 0 1-.446 1-1s-.446-1-1-1H9.996zM5 7c-.554 0-1 .446-1 1s.446 1 1 1 1-.446 1-1-.446-1-1-1zm3 0c-.554 0-1 .446-1 1s.446 1 1 1h3c.554 0 1-.446 1-1s-.446-1-1-1H8zm-3.004 3c-.554 0-1 .446-1 1s.446 1 1 1H9c.554 0 1-.446 1-1s-.446-1-1-1H4.996z" style="fill:#8eef97;fill-opacity:1"/></svg>
Side by Side

After

Width:  |  Height:  |  Size: 555 B

1
editor/icons/VFlowContainer.svg Normal file
View File

@ -0,0 +1 @@
<svg height="16" width="16" xmlns="http://www.w3.org/2000/svg"><path d="M3 1a2 2 0 0 0-2 2v10a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3a2 2 0 0 0-2-2H3zm0 2h10v10H3V3zm7.998.998c-.554 0-1 .446-1 1v4.004c0 .554.446 1 1 1s1-.446 1-1V4.998c0-.554-.446-1-1-1zm-6 .004c-.554 0-1 .446-1 1v2c0 .554.446 1 1 1s1-.446 1-1v-2c0-.554-.446-1-1-1zm3 0c-.554 0-1 .446-1 1s.446 1 1 1 1-.446 1-1-.446-1-1-1zm0 3c-.554 0-1 .446-1 1v3c0 .554.446 1 1 1s1-.446 1-1v-3c0-.554-.446-1-1-1zm-3 1.996c-.554 0-1 .446-1 1v1.004c0 .554.446 1 1 1s1-.446 1-1V9.998c0-.554-.446-1-1-1z" style="fill:#8eef97;fill-opacity:1"/></svg>
Side by Side

After

Width:  |  Height:  |  Size: 590 B

252
scene/gui/flow_container.cpp Normal file
View File

@ -0,0 +1,252 @@
/*************************************************************************/
/* flow_container.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* 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 "scene/gui/container.h"
#include "flow_container.h"
struct _LineData {
int child_count = 0;
int min_line_height = 0;
int min_line_length = 0;
int stretch_avail = 0;
float stretch_ratio_total = 0;
};
void FlowContainer::_resort() {
int separation_horizontal = get_theme_constant(SNAME("hseparation"));
int separation_vertical = get_theme_constant(SNAME("vseparation"));
bool rtl = is_layout_rtl();
Map<Control *, Size2i> children_minsize_cache;
Vector<_LineData> lines_data;
Vector2i ofs;
int line_height = 0;
int line_length = 0;
float line_stretch_ratio_total = 0;
int current_container_size = vertical ? get_rect().size.y : get_rect().size.x;
int children_in_current_line = 0;
// First pass for line wrapping and minimum size calculation.
for (int i = 0; i < get_child_count(); i++) {
Control *child = Object::cast_to<Control>(get_child(i));
if (!child || !child->is_visible_in_tree()) {
continue;
}
if (child->is_set_as_top_level()) {
continue;
}
Size2i child_msc = child->get_combined_minimum_size();
if (vertical) { /* VERTICAL */
if (children_in_current_line > 0) {
ofs.y += separation_vertical;
}
if (ofs.y + child_msc.y > current_container_size) {
line_length = ofs.y - separation_vertical;
lines_data.push_back(_LineData{ children_in_current_line, line_height, line_length, current_container_size - line_length, line_stretch_ratio_total });
// Move in new column (vertical line).
ofs.x += line_height + separation_horizontal;
ofs.y = 0;
line_height = 0;
line_stretch_ratio_total = 0;
children_in_current_line = 0;
}
line_height = MAX(line_height, child_msc.x);
if (child->get_v_size_flags() & SIZE_EXPAND) {
line_stretch_ratio_total += child->get_stretch_ratio();
}
ofs.y += child_msc.y;
} else { /* HORIZONTAL */
if (children_in_current_line > 0) {
ofs.x += separation_horizontal;
}
if (ofs.x + child_msc.x > current_container_size) {
line_length = ofs.x - separation_horizontal;
lines_data.push_back(_LineData{ children_in_current_line, line_height, line_length, current_container_size - line_length, line_stretch_ratio_total });
// Move in new line.
ofs.y += line_height + separation_vertical;
ofs.x = 0;
line_height = 0;
line_stretch_ratio_total = 0;
children_in_current_line = 0;
}
line_height = MAX(line_height, child_msc.y);
if (child->get_h_size_flags() & SIZE_EXPAND) {
line_stretch_ratio_total += child->get_stretch_ratio();
}
ofs.x += child_msc.x;
}
children_minsize_cache[child] = child_msc;
children_in_current_line++;
}
line_length = vertical ? (ofs.y) : (ofs.x);
lines_data.push_back(_LineData{ children_in_current_line, line_height, line_length, current_container_size - line_length, line_stretch_ratio_total });
// Second pass for in-line expansion and alignment.
int current_line_idx = 0;
int child_idx_in_line = 0;
ofs.x = 0;
ofs.y = 0;
for (int i = 0; i < get_child_count(); i++) {
Control *child = Object::cast_to<Control>(get_child(i));
if (!child || !child->is_visible_in_tree()) {
continue;
}
if (child->is_set_as_top_level()) {
continue;
}
Size2i child_size = children_minsize_cache[child];
_LineData line_data = lines_data[current_line_idx];
if (child_idx_in_line >= lines_data[current_line_idx].child_count) {
current_line_idx++;
child_idx_in_line = 0;
if (vertical) {
ofs.x += line_data.min_line_height + separation_horizontal;
ofs.y = 0;
} else {
ofs.x = 0;
ofs.y += line_data.min_line_height + separation_vertical;
}
line_data = lines_data[current_line_idx];
}
if (vertical) { /* VERTICAL */
if (child->get_h_size_flags() & (SIZE_FILL | SIZE_SHRINK_CENTER | SIZE_SHRINK_END)) {
child_size.width = line_data.min_line_height;
}
if (child->get_v_size_flags() & SIZE_EXPAND) {
int stretch = line_data.stretch_avail * child->get_stretch_ratio() / line_data.stretch_ratio_total;
child_size.height += stretch;
}
} else { /* HORIZONTAL */
if (child->get_v_size_flags() & (SIZE_FILL | SIZE_SHRINK_CENTER | SIZE_SHRINK_END)) {
child_size.height = line_data.min_line_height;
}
if (child->get_h_size_flags() & SIZE_EXPAND) {
int stretch = line_data.stretch_avail * child->get_stretch_ratio() / line_data.stretch_ratio_total;
child_size.width += stretch;
}
}
Rect2 child_rect = Rect2(ofs, child_size);
if (rtl) {
child_rect.position.x = get_rect().size.x - child_rect.position.x - child_rect.size.width;
}
fit_child_in_rect(child, child_rect);
if (vertical) { /* VERTICAL */
ofs.y += child_size.height + separation_vertical;
} else { /* HORIZONTAL */
ofs.x += child_size.width + separation_horizontal;
}
child_idx_in_line++;
}
cached_size = (vertical ? ofs.x : ofs.y) + line_height;
cached_line_count = lines_data.size();
}
Size2 FlowContainer::get_minimum_size() const {
Size2i minimum;
for (int i = 0; i < get_child_count(); i++) {
Control *c = Object::cast_to<Control>(get_child(i));
if (!c) {
continue;
}
if (c->is_set_as_top_level()) {
continue;
}
if (!c->is_visible()) {
continue;
}
Size2i size = c->get_combined_minimum_size();
if (vertical) { /* VERTICAL */
minimum.height = MAX(minimum.height, size.height);
minimum.width = cached_size;
} else { /* HORIZONTAL */
minimum.width = MAX(minimum.width, size.width);
minimum.height = cached_size;
}
}
return minimum;
}
void FlowContainer::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_SORT_CHILDREN: {
_resort();
update_minimum_size();
} break;
case NOTIFICATION_THEME_CHANGED: {
update_minimum_size();
} break;
case NOTIFICATION_TRANSLATION_CHANGED:
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
queue_sort();
} break;
}
}
int FlowContainer::get_line_count() const {
return cached_line_count;
}
FlowContainer::FlowContainer(bool p_vertical) {
vertical = p_vertical;
}
void FlowContainer::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_line_count"), &FlowContainer::get_line_count);
}

76
scene/gui/flow_container.h Normal file
View File

@ -0,0 +1,76 @@
/*************************************************************************/
/* flow_container.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* 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 FLOW_CONTAINER_H
#define FLOW_CONTAINER_H
class Container;
class FlowContainer : public Container {
GDCLASS(FlowContainer, Container);
private:
int cached_size = 0;
int cached_line_count = 0;
bool vertical = false;
void _resort();
protected:
void _notification(int p_what);
static void _bind_methods();
public:
int get_line_count() const;
virtual Size2 get_minimum_size() const override;
FlowContainer(bool p_vertical = false);
};
class HFlowContainer : public FlowContainer {
GDCLASS(HFlowContainer, FlowContainer);
public:
HFlowContainer() :
FlowContainer(false) {}
};
class VFlowContainer : public FlowContainer {
GDCLASS(VFlowContainer, FlowContainer);
public:
VFlowContainer() :
FlowContainer(true) {}
};
#endif // FLOW_CONTAINER_H

5
scene/register_scene_types.cpp
View File

@ -91,6 +91,7 @@
#include "scene/gui/control.h"
#include "scene/gui/dialogs.h"
#include "scene/gui/file_dialog.h"
#include "scene/gui/flow_container.h"
#include "scene/gui/graph_edit.h"
#include "scene/gui/graph_node.h"
#include "scene/gui/grid_container.h"
@ -353,6 +354,9 @@ void register_scene_types() {
GDREGISTER_CLASS(CenterContainer);
GDREGISTER_CLASS(ScrollContainer);
GDREGISTER_CLASS(PanelContainer);
GDREGISTER_VIRTUAL_CLASS(FlowContainer);
GDREGISTER_CLASS(HFlowContainer);
GDREGISTER_CLASS(VFlowContainer);
OS::get_singleton()->yield(); // may take time to init
@ -390,6 +394,7 @@ void register_scene_types() {
GDREGISTER_VIRTUAL_CLASS(SplitContainer);
GDREGISTER_CLASS(HSplitContainer);
GDREGISTER_CLASS(VSplitContainer);
GDREGISTER_CLASS(GraphNode);
GDREGISTER_CLASS(GraphEdit);

4
scene/resources/default_theme/default_theme.cpp
View File

@ -974,6 +974,10 @@ void fill_default_theme(Ref<Theme> &theme, const Ref<Font> &default_font, const
theme->set_constant("separation", "VSplitContainer", 12 * scale);
theme->set_constant("autohide", "HSplitContainer", 1 * scale);
theme->set_constant("autohide", "VSplitContainer", 1 * scale);
theme->set_constant("hseparation", "HFlowContainer", 4 * scale);
theme->set_constant("vseparation", "HFlowContainer", 4 * scale);
theme->set_constant("hseparation", "VFlowContainer", 4 * scale);
theme->set_constant("vseparation", "VFlowContainer", 4 * scale);
Ref<StyleBoxTexture> sb_pc = make_stylebox(tab_container_bg_png, 4, 4, 4, 4, 7, 7, 7, 7);
theme->set_stylebox("panel", "PanelContainer", sb_pc);