Make Editor Help text possible to be zoomed in/out #37196

dreamsComeTrue · 2020-03-20T23:31:28Z

While regular code editor has posibility of text zooming in/out, help tabs didn't have similar functionality.
It is possible to change its size (for 3 different 'categories'/sections in help text area) - but only by going into editor properties, adjusting it manually, saving and observing how documentation text would look like.

With following PR, it's possible to use regular mouse scroll gestures (CTRL + whell up/down), keyboard shortcuts (CTRL + plus, CTRL + minus, CTRL + zero), and magnify gesture to control text size of documentation/help area

Production edit: This closes Allow to change font size/zoom level in the Editor help with a shortcut (Ctrl + Mouse Wheel) godot-proposals#1914.

Calinou · 2020-03-20T23:38:54Z

Great work 🙂

I noticed the "Inherits"/"Inherited By" link text at the top isn't affected by the font size changes. Do you know why that happens?

Also, would it be possible to apply line spacing changes earlier so the text doesn't appear broken for a short duration?

dreamsComeTrue · 2020-03-20T23:41:43Z

Great work slightly_smiling_face

I noticed the "Inherits"/"Inherited By" link text at the top isn't affected. Is it possible to fix that?

Heh, I knew it someone will notice that - and I was thinking about that too - actually - strangely - the font, that SHOULD be used to affect that part is being 'poped out' from the stack, just before those links are being rendered. I was afraid - it might be done that way for any particular reason, but now, as I have your blessing to modify it - it's not a problem to adjust them as well :)

EDIT: fixed, updated, new GIF 😄

Also, would it be possible to apply line spacing changes earlier so the text doesn't appear broken for a short duration?

EDIT2: The weird issue with text not layouting correct instantly is not introduced by me - it's just how RichTextLabel takes much time to re-layout itself - I am just changing it's font size.

Even if you go into Editor Settings and try to change TextEditor/Help - one of those 3 fonts - either with fast clicking or slow - it doesn't matter, as Editor waits a bit to redraw everything, and only then - renders correct layout.
I believe, if we're using scroll wheel, and doing rapid movements - Godot can't keep up with rebuilding bbcode inside of RichTextLabel resulting in half-second of gibberish..

EDIT3: IDK whether it would help, but I've mirrored the same functionality as in regular Code Editor - so basically there is a timer underneath, with very small timeout, which is being triggered when no other updates are requested - for me it smoothes zooming process a little, but - still - bbcode is the problem here (or maybe rebuilding fonts for every change?) - but those are internals of RichTextLabel

Calinou

The feature looks good to me, but make sure to update the code style to follow the latest master branch.

In the future, we should simplify the editor help font size settings to only have a single "base" setting and compute all other values (title and source) automatically. This will make editor settings easier to adjust for people.

Calinou · 2021-03-25T19:05:34Z

editor/editor_help.cpp

@@ -168,6 +169,121 @@ void EditorHelp::_class_desc_select(const String &p_select) {
 }

 void EditorHelp::_class_desc_input(const Ref<InputEvent> &p_input) {
+


Suggested change

Calinou · 2021-03-25T19:05:41Z

editor/editor_help.cpp

+	Ref<InputEventMouseButton> mb = p_input;
+
+	if (mb.is_valid()) {
+


Suggested change

Calinou · 2021-03-25T19:05:46Z

editor/editor_help.cpp

+
+	Ref<InputEventMagnifyGesture> magnify_gesture = p_input;
+	if (magnify_gesture.is_valid()) {
+


Suggested change

Calinou · 2021-03-25T19:05:50Z

editor/editor_help.cpp

+	Ref<InputEventKey> k = p_input;
+
+	if (k.is_valid()) {
+


Suggested change

Calinou · 2021-03-25T19:05:57Z

editor/editor_help.cpp

+	if (font_resize_timer->get_time_left() == 0)
+		font_resize_timer->start();


Suggested change

if (font_resize_timer->get_time_left() == 0)

font_resize_timer->start();

if (font_resize_timer->get_time_left() == 0) {

font_resize_timer->start();

}

Calinou · 2021-03-25T19:06:05Z

editor/editor_help.cpp

+
+	int new_font_size = CLAMP(font->get_size() + p_delta, 8 * EDSCALE, 96 * EDSCALE);
+	if (new_font_size != font->get_size()) {
+


Suggested change

Calinou · 2021-03-25T19:06:08Z

editor/editor_help.cpp

+	Ref<DynamicFont> font = get_font(p_name, "EditorFonts");
+
+	if (font.is_valid()) {
+


Suggested change

Calinou · 2021-03-25T19:09:04Z

editor/editor_help.cpp

+	_set_dafault_doc_font_size("doc", "text_editor/help/help_font_size", 15);
+	_set_dafault_doc_font_size("doc_bold", "text_editor/help/help_font_size", 15);
+	_set_dafault_doc_font_size("doc_title", "text_editor/help/help_title_font_size", 23);
+	_set_dafault_doc_font_size("doc_source", "text_editor/help/help_source_font_size", 14);


Typo:

Suggested change

_set_dafault_doc_font_size("doc", "text_editor/help/help_font_size", 15);

_set_dafault_doc_font_size("doc_bold", "text_editor/help/help_font_size", 15);

_set_dafault_doc_font_size("doc_title", "text_editor/help/help_title_font_size", 23);

_set_dafault_doc_font_size("doc_source", "text_editor/help/help_source_font_size", 14);

_set_default_doc_font_size("doc", "text_editor/help/help_font_size", 15);

_set_default_doc_font_size("doc_bold", "text_editor/help/help_font_size", 15);

_set_default_doc_font_size("doc_title", "text_editor/help/help_title_font_size", 23);

_set_default_doc_font_size("doc_source", "text_editor/help/help_source_font_size", 14);

Calinou · 2021-03-25T19:09:13Z

editor/editor_help.h

+	void _zoom_out();
+	void _reset_zoom();
+	void _zoom_changed();
+	void _set_dafault_doc_font_size(const String &p_name, const String &p_config_path, int size);


Typo:

Suggested change

void _set_dafault_doc_font_size(const String &p_name, const String &p_config_path, int size);

void _set_default_doc_font_size(const String &p_name, const String &p_config_path, int size);

Calinou · 2021-03-25T19:09:24Z

editor/editor_help.cpp

+		font_resize_timer->start();
+}
+
+void EditorHelp::_set_dafault_doc_font_size(const String &p_name, const String &p_config_path, int size) {


Typo:

Suggested change

void EditorHelp::_set_dafault_doc_font_size(const String &p_name, const String &p_config_path, int size) {

void EditorHelp::_set_default_doc_font_size(const String &p_name, const String &p_config_path, int size) {

akien-mga · 2022-07-28T15:35:01Z

This needs to be updated to address review comment, and maybe the implementation might differ now in 4.0.

It would make sense to leave the editor settings unchanged, and instead save a zoom ratio in editor metadata to scale the font size. This zoom should also be displayed somewhere (like in the 2D/3D viewports) so it can be easily reset when non default.

Calinou added enhancement topic:editor usability labels Mar 20, 2020

dreamsComeTrue force-pushed the help-zoom-text branch 2 times, most recently from c6168c0 to 93e68a2 Compare March 21, 2020 00:15

Make Editor Help text possible to be zoomed in/out

edacef3

dreamsComeTrue force-pushed the help-zoom-text branch from 93e68a2 to edacef3 Compare March 22, 2020 10:50

Calinou added this to the 4.0 milestone Jan 5, 2021

Calinou requested changes Mar 25, 2021

View reviewed changes

YuriSizov requested a review from a team August 24, 2021 23:00

akien-mga modified the milestones: 4.0, 4.x Jul 28, 2022

akien-mga added needs work salvageable labels Jul 28, 2022

Calinou mentioned this pull request Apr 2, 2024

Allow to change font size/zoom level in the Editor help with a shortcut (Ctrl + Mouse Wheel) godotengine/godot-proposals#1914

Open

Chaosus mentioned this pull request Aug 10, 2024

Allow zooming in Editor Help #95366

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Make Editor Help text possible to be zoomed in/out #37196

Make Editor Help text possible to be zoomed in/out #37196

dreamsComeTrue commented Mar 20, 2020 •

edited by Calinou

Loading

Uh oh!

Calinou commented Mar 20, 2020 •

edited

Loading

Uh oh!

dreamsComeTrue commented Mar 20, 2020 •

edited

Loading

Uh oh!

Calinou left a comment

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

Calinou Mar 25, 2021

Uh oh!

akien-mga commented Jul 28, 2022

Uh oh!

Uh oh!

		@@ -168,6 +169,121 @@ void EditorHelp::_class_desc_select(const String &p_select) {
		}

		void EditorHelp::_class_desc_input(const Ref<InputEvent> &p_input) {

		Ref<InputEventMouseButton> mb = p_input;

		if (mb.is_valid()) {


		Ref<InputEventMagnifyGesture> magnify_gesture = p_input;
		if (magnify_gesture.is_valid()) {

		if (font_resize_timer->get_time_left() == 0)
		font_resize_timer->start();


		int new_font_size = CLAMP(font->get_size() + p_delta, 8 * EDSCALE, 96 * EDSCALE);
		if (new_font_size != font->get_size()) {

		Ref<DynamicFont> font = get_font(p_name, "EditorFonts");

		if (font.is_valid()) {

	void _set_dafault_doc_font_size(const String &p_name, const String &p_config_path, int size);
	void _set_default_doc_font_size(const String &p_name, const String &p_config_path, int size);

	void EditorHelp::_set_dafault_doc_font_size(const String &p_name, const String &p_config_path, int size) {
	void EditorHelp::_set_default_doc_font_size(const String &p_name, const String &p_config_path, int size) {

Uh oh!

Make Editor Help text possible to be zoomed in/out #37196

Are you sure you want to change the base?

Make Editor Help text possible to be zoomed in/out #37196

Conversation

dreamsComeTrue commented Mar 20, 2020 • edited by Calinou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Calinou commented Mar 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dreamsComeTrue commented Mar 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Calinou left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akien-mga commented Jul 28, 2022

Uh oh!

Uh oh!

dreamsComeTrue commented Mar 20, 2020 •

edited by Calinou

Loading

Calinou commented Mar 20, 2020 •

edited

Loading

dreamsComeTrue commented Mar 20, 2020 •

edited

Loading