gaming/godot
gaming/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot synced 2024-09-16 00:27:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #58517 from KoBeWi/size_matters

Browse source 
Add expand modes to TextureRect
This commit is contained in:
Rémi Verschelde 2023-01-12 20:06:26 +01:00
parent 73ab514657 dfc4367a47
commit 797fb296f0
No known key found for this signature in database
GPG key ID: C3336907360768E1
13 changed files with 86 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/classes/TextureRect.xml
View file

@ -10,15 +10,15 @@
<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
</tutorials>
<members>
<member name="expand_mode" type="int" setter="set_expand_mode" getter="get_expand_mode" enum="TextureRect.ExpandMode" default="0">
Defines how minimum size is determined based on the texture's size. See [enum ExpandMode] for options.
</member>
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h" default="false">
If [code]true[/code], texture is flipped horizontally.
</member>
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v" default="false">
If [code]true[/code], texture is flipped vertically.
</member>
<member name="ignore_texture_size" type="bool" setter="set_ignore_texture_size" getter="get_ignore_texture_size" default="false">
If [code]true[/code], the size of the texture won't be considered for minimum size calculation, so the [TextureRect] can be shrunk down past the texture size. Useful for preventing [TextureRect]s from breaking GUI layout regardless of their texture size.
</member>
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="1" />
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode" default="0">
Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode].
@ -28,6 +28,24 @@
</member>
</members>
<constants>
<constant name="EXPAND_KEEP_SIZE" value="0" enum="ExpandMode">
The minimum size will be equal to texture size, i.e. [TextureRect] can't be smaller than the texture.
</constant>
<constant name="EXPAND_IGNORE_SIZE" value="1" enum="ExpandMode">
The size of the texture won't be considered for minimum size calculation, so the [TextureRect] can be shrunk down past the texture size.
</constant>
<constant name="EXPAND_FIT_WIDTH" value="2" enum="ExpandMode">
The height of the texture will be ignored. Minimum width will be equal to the current height. Useful for horizontal layouts, e.g. inside [HBoxContainer].
</constant>
<constant name="EXPAND_FIT_WIDTH_PROPORTIONAL" value="3" enum="ExpandMode">
Same as [constant EXPAND_FIT_WIDTH], but keeps texture's aspect ratio.
</constant>
<constant name="EXPAND_FIT_HEIGHT" value="4" enum="ExpandMode">
The width of the texture will be ignored. Minimum height will be equal to the current width. Useful for vertical layouts, e.g. inside [VBoxContainer].
</constant>
<constant name="EXPAND_FIT_HEIGHT_PROPORTIONAL" value="5" enum="ExpandMode">
Same as [constant EXPAND_FIT_HEIGHT], but keeps texture's aspect ratio.
</constant>
<constant name="STRETCH_SCALE" value="0" enum="StretchMode">
Scale to fit the node's bounding rectangle.
</constant>

2
editor/debugger/editor_profiler.cpp
View file

@ -670,7 +670,7 @@ EditorProfiler::EditorProfiler() {
variables->connect("item_edited", callable_mp(this, &EditorProfiler::_item_edited));
graph = memnew(TextureRect);
graph->set_ignore_texture_size(true);
graph->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
graph->set_mouse_filter(MOUSE_FILTER_STOP);
graph->connect("draw", callable_mp(this, &EditorProfiler::_graph_tex_draw));
graph->connect("gui_input", callable_mp(this, &EditorProfiler::_graph_tex_input));

2
editor/debugger/editor_visual_profiler.cpp
View file

@ -798,7 +798,7 @@ EditorVisualProfiler::EditorVisualProfiler() {
variables->connect("cell_selected", callable_mp(this, &EditorVisualProfiler::_item_selected));
graph = memnew(TextureRect);
graph->set_ignore_texture_size(true);
graph->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
graph->set_mouse_filter(MOUSE_FILTER_STOP);
graph->connect("draw", callable_mp(this, &EditorVisualProfiler::_graph_tex_draw));
graph->connect("gui_input", callable_mp(this, &EditorVisualProfiler::_graph_tex_input));

2
editor/editor_resource_picker.cpp
View file

@ -958,7 +958,7 @@ EditorResourcePicker::EditorResourcePicker(bool p_hide_assign_button_controls) {
if (!p_hide_assign_button_controls) {
preview_rect = memnew(TextureRect);
preview_rect->set_ignore_texture_size(true);
preview_rect->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
preview_rect->set_anchors_and_offsets_preset(PRESET_FULL_RECT);
preview_rect->set_offset(SIDE_TOP, 1);
preview_rect->set_offset(SIDE_BOTTOM, -1);

2
editor/plugins/asset_library_editor_plugin.cpp
View file

@ -293,7 +293,7 @@ EditorAssetLibraryItemDescription::EditorAssetLibraryItemDescription() {
preview = memnew(TextureRect);
previews_vbox->add_child(preview);
preview->set_ignore_texture_size(true);
preview->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
preview->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
preview->set_custom_minimum_size(Size2(640 * EDSCALE, 345 * EDSCALE));
preview->set_v_size_flags(Control::SIZE_EXPAND_FILL);

2
editor/plugins/bone_map_editor_plugin.cpp
View file

@ -316,7 +316,7 @@ void BoneMapper::create_editor() {
profile_texture = memnew(TextureRect);
profile_texture->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
profile_texture->set_ignore_texture_size(true);
profile_texture->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
profile_texture->set_h_size_flags(Control::SIZE_FILL);
profile_texture->set_v_size_flags(Control::SIZE_FILL);
bone_mapper_field->add_child(profile_texture);

2
editor/plugins/gradient_texture_2d_editor_plugin.cpp
View file

@ -178,7 +178,7 @@ void GradientTexture2DEditorRect::_notification(int p_what) {
GradientTexture2DEditorRect::GradientTexture2DEditorRect() {
checkerboard = memnew(TextureRect);
checkerboard->set_stretch_mode(TextureRect::STRETCH_TILE);
checkerboard->set_ignore_texture_size(true);
checkerboard->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
checkerboard->set_draw_behind_parent(true);
add_child(checkerboard, false, INTERNAL_MODE_FRONT);

2
editor/plugins/sprite_frames_editor_plugin.cpp
View file

@ -1551,7 +1551,7 @@ SpriteFramesEditor::SpriteFramesEditor() {
split_sheet_vb->add_child(split_sheet_panel);
split_sheet_preview = memnew(TextureRect);
split_sheet_preview->set_ignore_texture_size(true);
split_sheet_preview->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
split_sheet_preview->set_mouse_filter(MOUSE_FILTER_PASS);
split_sheet_preview->connect("draw", callable_mp(this, &SpriteFramesEditor::_sheet_preview_draw));
split_sheet_preview->connect("gui_input", callable_mp(this, &SpriteFramesEditor::_sheet_preview_input));

2
editor/plugins/texture_editor_plugin.cpp
View file

@ -128,7 +128,7 @@ TexturePreview::TexturePreview(Ref<Texture2D> p_texture, bool p_show_metadata) {
texture_display->set_texture(p_texture);
texture_display->set_anchors_preset(TextureRect::PRESET_FULL_RECT);
texture_display->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
texture_display->set_ignore_texture_size(true);
texture_display->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
add_child(texture_display);
if (p_show_metadata) {

2
editor/plugins/tiles/atlas_merging_dialog.cpp
View file

@ -300,7 +300,7 @@ AtlasMergingDialog::AtlasMergingDialog() {
preview = memnew(TextureRect);
preview->set_h_size_flags(Control::SIZE_EXPAND_FILL);
preview->set_v_size_flags(Control::SIZE_EXPAND_FILL);
preview->set_ignore_texture_size(true);
preview->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
preview->hide();
preview->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
atlas_merging_right_panel->add_child(preview);

2
editor/project_manager.cpp
View file

@ -1233,7 +1233,7 @@ void ProjectList::load_project_icon(int p_index) {
// The default project icon is 128×128 to look crisp on hiDPI displays,
// but we want the actual displayed size to be 64×64 on loDPI displays.
item.control->icon->set_ignore_texture_size(true);
item.control->icon->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
item.control->icon->set_custom_minimum_size(Size2(64, 64) * EDSCALE);
item.control->icon->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);

54
scene/gui/texture_rect.cpp
View file

@ -110,22 +110,45 @@ void TextureRect::_notification(int p_what) {
draw_texture_rect(texture, Rect2(offset, size), tile);
}
} break;
case NOTIFICATION_RESIZED: {
update_minimum_size();
} break;
}
}
Size2 TextureRect::get_minimum_size() const {
if (!ignore_texture_size && !texture.is_null()) {
return texture->get_size();
} else {
return Size2();
if (!texture.is_null()) {
switch (expand_mode) {
case EXPAND_KEEP_SIZE: {
return texture->get_size();
} break;
case EXPAND_IGNORE_SIZE: {
return Size2();
} break;
case EXPAND_FIT_WIDTH: {
return Size2(get_size().y, 0);
} break;
case EXPAND_FIT_WIDTH_PROPORTIONAL: {
real_t ratio = real_t(texture->get_width()) / texture->get_height();
return Size2(get_size().y * ratio, 0);
} break;
case EXPAND_FIT_HEIGHT: {
return Size2(0, get_size().x);
} break;
case EXPAND_FIT_HEIGHT_PROPORTIONAL: {
real_t ratio = real_t(texture->get_height()) / texture->get_width();
return Size2(0, get_size().x * ratio);
} break;
}
}
return Size2();
}
void TextureRect::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_texture", "texture"), &TextureRect::set_texture);
ClassDB::bind_method(D_METHOD("get_texture"), &TextureRect::get_texture);
ClassDB::bind_method(D_METHOD("set_ignore_texture_size", "ignore"), &TextureRect::set_ignore_texture_size);
ClassDB::bind_method(D_METHOD("get_ignore_texture_size"), &TextureRect::get_ignore_texture_size);
ClassDB::bind_method(D_METHOD("set_expand_mode", "expand_mode"), &TextureRect::set_expand_mode);
ClassDB::bind_method(D_METHOD("get_expand_mode"), &TextureRect::get_expand_mode);
ClassDB::bind_method(D_METHOD("set_flip_h", "enable"), &TextureRect::set_flip_h);
ClassDB::bind_method(D_METHOD("is_flipped_h"), &TextureRect::is_flipped_h);
ClassDB::bind_method(D_METHOD("set_flip_v", "enable"), &TextureRect::set_flip_v);
@ -134,11 +157,18 @@ void TextureRect::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_stretch_mode"), &TextureRect::get_stretch_mode);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "texture", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"), "set_texture", "get_texture");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "ignore_texture_size"), "set_ignore_texture_size", "get_ignore_texture_size");
ADD_PROPERTY(PropertyInfo(Variant::INT, "expand_mode", PROPERTY_HINT_ENUM, "Keep Size,Ignore Size,Fit Width,Fit Width Proportional,Fit Height,Fit Height Proportional"), "set_expand_mode", "get_expand_mode");
ADD_PROPERTY(PropertyInfo(Variant::INT, "stretch_mode", PROPERTY_HINT_ENUM, "Scale,Tile,Keep,Keep Centered,Keep Aspect,Keep Aspect Centered,Keep Aspect Covered"), "set_stretch_mode", "get_stretch_mode");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "flip_h"), "set_flip_h", "is_flipped_h");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "flip_v"), "set_flip_v", "is_flipped_v");
BIND_ENUM_CONSTANT(EXPAND_KEEP_SIZE);
BIND_ENUM_CONSTANT(EXPAND_IGNORE_SIZE);
BIND_ENUM_CONSTANT(EXPAND_FIT_WIDTH);
BIND_ENUM_CONSTANT(EXPAND_FIT_WIDTH_PROPORTIONAL);
BIND_ENUM_CONSTANT(EXPAND_FIT_HEIGHT);
BIND_ENUM_CONSTANT(EXPAND_FIT_HEIGHT_PROPORTIONAL);
BIND_ENUM_CONSTANT(STRETCH_SCALE);
BIND_ENUM_CONSTANT(STRETCH_TILE);
BIND_ENUM_CONSTANT(STRETCH_KEEP);
@ -178,18 +208,18 @@ Ref<Texture2D> TextureRect::get_texture() const {
return texture;
}
void TextureRect::set_ignore_texture_size(bool p_ignore) {
if (ignore_texture_size == p_ignore) {
void TextureRect::set_expand_mode(ExpandMode p_mode) {
if (expand_mode == p_mode) {
return;
}
ignore_texture_size = p_ignore;
expand_mode = p_mode;
queue_redraw();
update_minimum_size();
}
bool TextureRect::get_ignore_texture_size() const {
return ignore_texture_size;
TextureRect::ExpandMode TextureRect::get_expand_mode() const {
return expand_mode;
}
void TextureRect::set_stretch_mode(StretchMode p_mode) {

16
scene/gui/texture_rect.h
View file

@ -37,6 +37,15 @@ class TextureRect : public Control {
GDCLASS(TextureRect, Control);
public:
enum ExpandMode {
EXPAND_KEEP_SIZE,
EXPAND_IGNORE_SIZE,
EXPAND_FIT_WIDTH,
EXPAND_FIT_WIDTH_PROPORTIONAL,
EXPAND_FIT_HEIGHT,
EXPAND_FIT_HEIGHT_PROPORTIONAL,
};
enum StretchMode {
STRETCH_SCALE,
STRETCH_TILE,
@ -48,10 +57,10 @@ public:
};
private:
bool ignore_texture_size = false;
bool hflip = false;
bool vflip = false;
Ref<Texture2D> texture;
ExpandMode expand_mode = EXPAND_KEEP_SIZE;
StretchMode stretch_mode = STRETCH_SCALE;
void _texture_changed();
@ -65,8 +74,8 @@ public:
void set_texture(const Ref<Texture2D> &p_tex);
Ref<Texture2D> get_texture() const;
void set_ignore_texture_size(bool p_ignore);
bool get_ignore_texture_size() const;
void set_expand_mode(ExpandMode p_mode);
ExpandMode get_expand_mode() const;
void set_stretch_mode(StretchMode p_mode);
StretchMode get_stretch_mode() const;
@ -81,6 +90,7 @@ public:
~TextureRect();
};
VARIANT_ENUM_CAST(TextureRect::ExpandMode);
VARIANT_ENUM_CAST(TextureRect::StretchMode);
#endif // TEXTURE_RECT_H