Skip to content

Commit

Permalink
Merge pull request godotengine#61337 from reduz/improve-stylebox-preview
Browse files Browse the repository at this point in the history 
Improve StyleBox preview
  • Loading branch information
@akien-mga
akien-mga authored May 26, 2022
2 parents 08e540a + b4c6900 commit 69b30ea
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 7 deletions.
1 change: 1 addition & 0 deletions editor/icons/StyleBoxGridInvisible.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions editor/icons/StyleBoxGridVisible.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 60 additions & 2 deletions editor/plugins/style_box_editor_plugin.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@

#include "editor/editor_scale.h"

bool StyleBoxPreview::grid_preview_enabled = true;

void StyleBoxPreview::_grid_preview_toggled(bool p_active) {
grid_preview_enabled = p_active;
preview->update();
}

bool EditorInspectorPluginStyleBox::can_handle(Object *p_object) {
return Object::cast_to<StyleBox>(p_object) != nullptr;
}
Expand All @@ -53,35 +60,86 @@ void StyleBoxPreview::edit(const Ref<StyleBox> &p_stylebox) {
preview->add_theme_style_override("panel", stylebox);
stylebox->connect("changed", callable_mp(this, &StyleBoxPreview::_sb_changed));
}
Ref<StyleBoxTexture> sbt = p_stylebox;
grid_preview->set_visible(sbt.is_valid());
_sb_changed();
}

void StyleBoxPreview::_sb_changed() {
preview->update();
}

void StyleBoxPreview::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_ENTER_TREE:
case NOTIFICATION_THEME_CHANGED: {
if (!is_inside_tree()) {
// TODO: This is a workaround because `NOTIFICATION_THEME_CHANGED`
// is getting called for some reason when the `TexturePreview` is
// getting destroyed, which causes `get_theme_font()` to return `nullptr`.
// See https://github.com/godotengine/godot/issues/50743.
break;
}
grid_preview->set_normal_texture(get_theme_icon(SNAME("StyleBoxGridInvisible"), SNAME("EditorIcons")));
grid_preview->set_pressed_texture(get_theme_icon(SNAME("StyleBoxGridVisible"), SNAME("EditorIcons")));
grid_preview->set_hover_texture(get_theme_icon(SNAME("StyleBoxGridVisible"), SNAME("EditorIcons")));
checkerboard->set_texture(get_theme_icon(SNAME("Checkerboard"), SNAME("EditorIcons")));
} break;
}
}

void StyleBoxPreview::_redraw() {
if (stylebox.is_valid()) {
Ref<Texture2D> grid_texture_disabled = get_theme_icon(SNAME("StyleBoxGridInvisible"), SNAME("EditorIcons"));
Rect2 preview_rect = preview->get_rect();
preview_rect.position += grid_texture_disabled->get_size();
preview_rect.size -= grid_texture_disabled->get_size() * 2;

// Re-adjust preview panel to fit all drawn content
Rect2 draw_rect = stylebox->get_draw_rect(preview_rect);
preview_rect.size -= draw_rect.size - preview_rect.size;
preview_rect.position -= draw_rect.position - preview_rect.position;

preview->draw_style_box(stylebox, preview_rect);

Ref<StyleBoxTexture> sbt = stylebox;
if (sbt.is_valid() && grid_preview->is_pressed()) {
for (int i = 0; i < 2; i++) {
Color c = i == 1 ? Color(1, 1, 1, 0.8) : Color(0, 0, 0, 0.4);
int x = draw_rect.position.x + sbt->get_margin(SIDE_LEFT) + (1 - i);
preview->draw_line(Point2(x, 0), Point2(x, preview->get_size().height), c);
int x2 = draw_rect.position.x + draw_rect.size.width - sbt->get_margin(SIDE_RIGHT) + (1 - i);
preview->draw_line(Point2(x2, 0), Point2(x2, preview->get_size().height), c);
int y = draw_rect.position.y + sbt->get_margin(SIDE_TOP) + (1 - i);
preview->draw_line(Point2(0, y), Point2(preview->get_size().width, y), c);
int y2 = draw_rect.position.y + draw_rect.size.height - sbt->get_margin(SIDE_BOTTOM) + (1 - i);
preview->draw_line(Point2(0, y2), Point2(preview->get_size().width, y2), c);
}
}
}
}

void StyleBoxPreview::_bind_methods() {
}

StyleBoxPreview::StyleBoxPreview() {
checkerboard = memnew(TextureRect);
checkerboard->set_stretch_mode(TextureRect::STRETCH_TILE);
checkerboard->set_texture_repeat(CanvasItem::TEXTURE_REPEAT_ENABLED);
checkerboard->set_custom_minimum_size(Size2(0.0, 150.0) * EDSCALE);

preview = memnew(Control);
preview->set_custom_minimum_size(Size2(0, 150 * EDSCALE));
preview->set_clip_contents(true);
preview->connect("draw", callable_mp(this, &StyleBoxPreview::_redraw));
add_margin_child(TTR("Preview:"), preview);
checkerboard->add_child(preview);
preview->set_anchors_and_offsets_preset(PRESET_WIDE);

add_margin_child(TTR("Preview:"), checkerboard);
grid_preview = memnew(TextureButton);
preview->add_child(grid_preview);
grid_preview->set_toggle_mode(true);
grid_preview->connect("toggled", callable_mp(this, &StyleBoxPreview::_grid_preview_toggled));
grid_preview->set_pressed(grid_preview_enabled);
}

StyleBoxEditorPlugin::StyleBoxEditorPlugin() {
Expand Down
5 changes: 5 additions & 0 deletions editor/plugins/style_box_editor_plugin.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,16 @@
class StyleBoxPreview : public VBoxContainer {
GDCLASS(StyleBoxPreview, VBoxContainer);

TextureRect *checkerboard = nullptr;
TextureButton *grid_preview = nullptr;
Control *preview = nullptr;
Ref<StyleBox> stylebox;

void _sb_changed();
void _redraw();
void _notification(int p_what);
static bool grid_preview_enabled;
void _grid_preview_toggled(bool p_active);

protected:
static void _bind_methods();
Expand Down
12 changes: 7 additions & 5 deletions scene/resources/style_box.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ void StyleBox::_bind_methods() {

ClassDB::bind_method(D_METHOD("draw", "canvas_item", "rect"), &StyleBox::draw);

ADD_GROUP("Content Margin", "content_margin_");
ADD_GROUP("Content Margins", "content_margin_");
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "content_margin_left", PROPERTY_HINT_RANGE, "-1,2048,1"), "set_default_margin", "get_default_margin", SIDE_LEFT);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "content_margin_top", PROPERTY_HINT_RANGE, "-1,2048,1"), "set_default_margin", "get_default_margin", SIDE_TOP);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "content_margin_right", PROPERTY_HINT_RANGE, "-1,2048,1"), "set_default_margin", "get_default_margin", SIDE_RIGHT);
Expand Down Expand Up @@ -315,15 +315,14 @@ void StyleBoxTexture::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_v_axis_stretch_mode"), &StyleBoxTexture::get_v_axis_stretch_mode);

ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "texture", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"), "set_texture", "get_texture");
ADD_PROPERTY(PropertyInfo(Variant::RECT2, "region_rect"), "set_region_rect", "get_region_rect");

ADD_GROUP("Margin", "margin_");
ADD_GROUP("Margins", "margin_");
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "margin_left", PROPERTY_HINT_RANGE, "0,2048,1"), "set_margin_size", "get_margin_size", SIDE_LEFT);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "margin_top", PROPERTY_HINT_RANGE, "0,2048,1"), "set_margin_size", "get_margin_size", SIDE_TOP);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "margin_right", PROPERTY_HINT_RANGE, "0,2048,1"), "set_margin_size", "get_margin_size", SIDE_RIGHT);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "margin_bottom", PROPERTY_HINT_RANGE, "0,2048,1"), "set_margin_size", "get_margin_size", SIDE_BOTTOM);

ADD_GROUP("Expand Margin", "expand_margin_");
ADD_GROUP("Expand Margins", "expand_margin_");
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "expand_margin_left", PROPERTY_HINT_RANGE, "0,2048,1"), "set_expand_margin_size", "get_expand_margin_size", SIDE_LEFT);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "expand_margin_top", PROPERTY_HINT_RANGE, "0,2048,1"), "set_expand_margin_size", "get_expand_margin_size", SIDE_TOP);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "expand_margin_right", PROPERTY_HINT_RANGE, "0,2048,1"), "set_expand_margin_size", "get_expand_margin_size", SIDE_RIGHT);
Expand All @@ -333,6 +332,9 @@ void StyleBoxTexture::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::INT, "axis_stretch_horizontal", PROPERTY_HINT_ENUM, "Stretch,Tile,Tile Fit"), "set_h_axis_stretch_mode", "get_h_axis_stretch_mode");
ADD_PROPERTY(PropertyInfo(Variant::INT, "axis_stretch_vertical", PROPERTY_HINT_ENUM, "Stretch,Tile,Tile Fit"), "set_v_axis_stretch_mode", "get_v_axis_stretch_mode");

ADD_GROUP("Sub-Region", "region_");
ADD_PROPERTY(PropertyInfo(Variant::RECT2, "region_rect"), "set_region_rect", "get_region_rect");

ADD_GROUP("Modulate", "modulate_");
ADD_PROPERTY(PropertyInfo(Variant::COLOR, "modulate_color"), "set_modulate", "get_modulate");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_center"), "set_draw_center", "is_draw_center_enabled");
Expand Down Expand Up @@ -921,7 +923,7 @@ void StyleBoxFlat::_bind_methods() {

ADD_PROPERTY(PropertyInfo(Variant::INT, "corner_detail", PROPERTY_HINT_RANGE, "1,20,1"), "set_corner_detail", "get_corner_detail");

ADD_GROUP("Expand Margin", "expand_margin_");
ADD_GROUP("Expand Margins", "expand_margin_");
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "expand_margin_left", PROPERTY_HINT_RANGE, "0,2048,1"), "set_expand_margin", "get_expand_margin", SIDE_LEFT);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "expand_margin_top", PROPERTY_HINT_RANGE, "0,2048,1"), "set_expand_margin", "get_expand_margin", SIDE_TOP);
ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, "expand_margin_right", PROPERTY_HINT_RANGE, "0,2048,1"), "set_expand_margin", "get_expand_margin", SIDE_RIGHT);
Expand Down

0 comments on commit 69b30ea

Please sign in to comment.