Kalakoi/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-15 02:49:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Visualize MarginContainer margins when selected

Browse Source 
This time as an EditorPlugin!

Improve rendering of inner area of MarginContainer

Decrease thickness and opacity of lines, and render margins as a rectangle rather than lines extending to the edges of the bounding box

Apply suggestions from code review

Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>

Use `get_margin_size`, change color of viz border, and trigger redraw on MarginContainer's draw signal
This commit is contained in:
Malcolm Anderson
2025-09-30 16:34:17 -07:00
parent 4a1c1c483b
commit 36c7bbb47a
3 changed files with 144 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
editor/register_editor_types.cpp
View File

@@ -106,6 +106,7 @@
#include "editor/scene/gradient_editor_plugin.h"
#include "editor/scene/gui/control_editor_plugin.h"
#include "editor/scene/gui/font_config_plugin.h"
#include "editor/scene/gui/margin_container_editor_plugin.h"
#include "editor/scene/gui/style_box_editor_plugin.h"
#include "editor/scene/gui/theme_editor_plugin.h"
#include "editor/scene/material_editor_plugin.h"
@@ -230,6 +231,7 @@ void register_editor_types() {
EditorPlugins::add_by_type<GradientTexture2DEditorPlugin>();
EditorPlugins::add_by_type<InputEventEditorPlugin>();
EditorPlugins::add_by_type<LightmapGIEditorPlugin>();
EditorPlugins::add_by_type<MarginContainerEditorPlugin>();
EditorPlugins::add_by_type<MaterialEditorPlugin>();
EditorPlugins::add_by_type<MeshEditorPlugin>();
EditorPlugins::add_by_type<MeshInstance3DEditorPlugin>();

94
editor/scene/gui/margin_container_editor_plugin.cpp Normal file
View File

@@ -0,0 +1,94 @@
/**************************************************************************/
/* margin_container_editor_plugin.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 "margin_container_editor_plugin.h"
#include "editor/scene/canvas_item_editor_plugin.h"
#include "editor/themes/editor_scale.h"
void MarginContainerEditorPlugin::edit(Object *p_object) {
if (margin_container) {
margin_container->disconnect(SNAME("draw"), callable_mp(CanvasItemEditor::get_singleton(), &CanvasItemEditor::update_viewport));
}
margin_container = Object::cast_to<MarginContainer>(p_object);
if (margin_container) {
margin_container->connect(SNAME("draw"), callable_mp(CanvasItemEditor::get_singleton(), &CanvasItemEditor::update_viewport));
}
CanvasItemEditor::get_singleton()->update_viewport();
}
bool MarginContainerEditorPlugin::handles(Object *p_object) const {
return Object::cast_to<MarginContainer>(p_object) != nullptr;
}
void MarginContainerEditorPlugin::forward_canvas_draw_over_viewport(Control *p_viewport_control) {
if (!margin_container) {
return;
}
Transform2D xform = CanvasItemEditor::get_singleton()->get_canvas_transform() * margin_container->get_screen_transform();
// NOTE: This color is copied from Camera2DEditor::forward_canvas_draw_over_viewport.
// We may want to unify them somehow in the future.
Color border_color = Color(1, 1, 0.25, 0.63);
int border_width = Math::round(1 * EDSCALE);
Rect2 rect = margin_container->_edit_get_rect();
int margin_left = margin_container->get_margin_size(SIDE_LEFT);
int margin_top = margin_container->get_margin_size(SIDE_TOP);
int margin_right = margin_container->get_margin_size(SIDE_RIGHT);
int margin_bottom = margin_container->get_margin_size(SIDE_BOTTOM);
Vector2 p1, p2;
// Calculate left margin line.
p1 = xform.xform(rect.position + Vector2(margin_left, margin_top));
p2 = xform.xform(rect.position + Vector2(margin_left, rect.size.y - margin_bottom));
p_viewport_control->draw_line(p1, p2, border_color, border_width);
// Calculate top margin line.
p1 = xform.xform(rect.position + Vector2(margin_left, margin_top));
p2 = xform.xform(rect.position + Vector2(rect.size.x - margin_right, margin_top));
p_viewport_control->draw_line(p1, p2, border_color, border_width);
// Calculate right margin line.
p1 = xform.xform(rect.position + Vector2(rect.size.x - margin_right, margin_top));
p2 = xform.xform(rect.position + Vector2(rect.size.x - margin_right, rect.size.y - margin_bottom));
p_viewport_control->draw_line(p1, p2, border_color, border_width);
// Calculate bottom margin line.
p1 = xform.xform(rect.position + Vector2(margin_left, rect.size.y - margin_bottom));
p2 = xform.xform(rect.position + Vector2(rect.size.x - margin_right, rect.size.y - margin_bottom));
p_viewport_control->draw_line(p1, p2, border_color, border_width);
}

48
editor/scene/gui/margin_container_editor_plugin.h Normal file
View File

@@ -0,0 +1,48 @@
/**************************************************************************/
/* margin_container_editor_plugin.h */
/**************************************************************************/
/* 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. */
/**************************************************************************/
#pragma once
#include "editor/plugins/editor_plugin.h"
#include "scene/gui/margin_container.h"
class CanvasItemEditor;
class MarginContainerEditorPlugin : public EditorPlugin {
GDCLASS(MarginContainerEditorPlugin, EditorPlugin);
MarginContainer *margin_container = nullptr;
public:
void forward_canvas_draw_over_viewport(Control *p_viewport_control) override;
virtual void edit(Object *p_object) override;
virtual bool handles(Object *p_object) const override;
};