2021-05-07 13:41:39 +00:00
/*************************************************************************/
/* editor_zoom_widget.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 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 "editor_zoom_widget.h"
# include "core/os/keyboard.h"
# include "editor/editor_scale.h"
# include "editor/editor_settings.h"
void EditorZoomWidget : : _update_zoom_label ( ) {
String zoom_text ;
// The zoom level displayed is relative to the editor scale
// (like in most image editors). Its lower bound is clamped to 1 as some people
// lower the editor scale to increase the available real estate,
// even if their display doesn't have a particularly low DPI.
if ( zoom > = 10 ) {
// Don't show a decimal when the zoom level is higher than 1000 %.
zoom_text = TS - > format_number ( rtos ( Math : : round ( ( zoom / MAX ( 1 , EDSCALE ) ) * 100 ) ) ) + " " + TS - > percent_sign ( ) ;
} else {
zoom_text = TS - > format_number ( rtos ( Math : : snapped ( ( zoom / MAX ( 1 , EDSCALE ) ) * 100 , 0.1 ) ) ) + " " + TS - > percent_sign ( ) ;
}
zoom_reset - > set_text ( zoom_text ) ;
}
void EditorZoomWidget : : _button_zoom_minus ( ) {
2021-08-13 21:31:57 +00:00
set_zoom_by_increments ( - 6 , Input : : get_singleton ( ) - > is_key_pressed ( Key : : ALT ) ) ;
2021-07-17 21:22:52 +00:00
emit_signal ( SNAME ( " zoom_changed " ) , zoom ) ;
2021-05-07 13:41:39 +00:00
}
void EditorZoomWidget : : _button_zoom_reset ( ) {
2021-04-27 22:54:59 +00:00
set_zoom ( 1.0 * MAX ( 1 , EDSCALE ) ) ;
2021-07-17 21:22:52 +00:00
emit_signal ( SNAME ( " zoom_changed " ) , zoom ) ;
2021-05-07 13:41:39 +00:00
}
void EditorZoomWidget : : _button_zoom_plus ( ) {
2021-08-13 21:31:57 +00:00
set_zoom_by_increments ( 6 , Input : : get_singleton ( ) - > is_key_pressed ( Key : : ALT ) ) ;
2021-07-17 21:22:52 +00:00
emit_signal ( SNAME ( " zoom_changed " ) , zoom ) ;
2021-05-07 13:41:39 +00:00
}
float EditorZoomWidget : : get_zoom ( ) {
return zoom ;
}
void EditorZoomWidget : : set_zoom ( float p_zoom ) {
if ( p_zoom > 0 & & p_zoom ! = zoom ) {
zoom = p_zoom ;
_update_zoom_label ( ) ;
}
}
2021-04-27 22:54:59 +00:00
void EditorZoomWidget : : set_zoom_by_increments ( int p_increment_count , bool p_integer_only ) {
// Remove editor scale from the index computation.
const float zoom_noscale = zoom / MAX ( 1 , EDSCALE ) ;
if ( p_integer_only ) {
// Only visit integer scaling factors above 100%, and fractions with an integer denominator below 100%
// (1/2 = 50%, 1/3 = 33.33%, 1/4 = 25%, …).
// This is useful when working on pixel art projects to avoid distortion.
// This algorithm is designed to handle fractional start zoom values correctly
// (e.g. 190% will zoom up to 200% and down to 100%).
if ( zoom_noscale + p_increment_count * 0.001 > = 1.0 - CMP_EPSILON ) {
// New zoom is certain to be above 100%.
if ( p_increment_count > = 1 ) {
// Zooming.
set_zoom ( Math : : floor ( zoom_noscale + p_increment_count ) * MAX ( 1 , EDSCALE ) ) ;
} else {
// Dezooming.
set_zoom ( Math : : ceil ( zoom_noscale + p_increment_count ) * MAX ( 1 , EDSCALE ) ) ;
}
} else {
if ( p_increment_count > = 1 ) {
// Zooming. Convert the current zoom into a denominator.
float new_zoom = 1.0 / Math : : ceil ( 1.0 / zoom_noscale - p_increment_count ) ;
if ( Math : : is_equal_approx ( zoom_noscale , new_zoom ) ) {
// New zoom is identical to the old zoom, so try again.
// This can happen due to floating-point precision issues.
new_zoom = 1.0 / Math : : ceil ( 1.0 / zoom_noscale - p_increment_count - 1 ) ;
}
set_zoom ( new_zoom * MAX ( 1 , EDSCALE ) ) ;
} else {
// Dezooming. Convert the current zoom into a denominator.
float new_zoom = 1.0 / Math : : floor ( 1.0 / zoom_noscale - p_increment_count ) ;
if ( Math : : is_equal_approx ( zoom_noscale , new_zoom ) ) {
// New zoom is identical to the old zoom, so try again.
// This can happen due to floating-point precision issues.
new_zoom = 1.0 / Math : : floor ( 1.0 / zoom_noscale - p_increment_count + 1 ) ;
}
set_zoom ( new_zoom * MAX ( 1 , EDSCALE ) ) ;
}
}
} else {
// Base increment factor defined as the twelveth root of two.
// This allow a smooth geometric evolution of the zoom, with the advantage of
// visiting all integer power of two scale factors.
// note: this is analogous to the 'semitones' interval in the music world
// In order to avoid numerical imprecisions, we compute and edit a zoom index
// with the following relation: zoom = 2 ^ (index / 12)
2021-05-07 13:41:39 +00:00
2021-04-27 22:54:59 +00:00
if ( zoom < CMP_EPSILON | | p_increment_count = = 0 ) {
return ;
}
2021-05-07 13:41:39 +00:00
2021-04-27 22:54:59 +00:00
// zoom = 2**(index/12) => log2(zoom) = index/12
float closest_zoom_index = Math : : round ( Math : : log ( zoom_noscale ) * 12.f / Math : : log ( 2.f ) ) ;
2021-05-07 13:41:39 +00:00
2021-04-27 22:54:59 +00:00
float new_zoom_index = closest_zoom_index + p_increment_count ;
float new_zoom = Math : : pow ( 2.f , new_zoom_index / 12.f ) ;
2021-05-07 13:41:39 +00:00
2021-04-27 22:54:59 +00:00
// Restore Editor scale transformation
new_zoom * = MAX ( 1 , EDSCALE ) ;
2021-05-07 13:41:39 +00:00
2021-04-27 22:54:59 +00:00
set_zoom ( new_zoom ) ;
}
2021-05-07 13:41:39 +00:00
}
void EditorZoomWidget : : _notification ( int p_what ) {
switch ( p_what ) {
case NOTIFICATION_ENTER_TREE :
case NOTIFICATION_THEME_CHANGED :
2021-07-17 21:22:52 +00:00
zoom_minus - > set_icon ( get_theme_icon ( SNAME ( " ZoomLess " ) , SNAME ( " EditorIcons " ) ) ) ;
zoom_plus - > set_icon ( get_theme_icon ( SNAME ( " ZoomMore " ) , SNAME ( " EditorIcons " ) ) ) ;
2021-05-07 13:41:39 +00:00
break ;
default :
break ;
}
}
void EditorZoomWidget : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " set_zoom " , " zoom " ) , & EditorZoomWidget : : set_zoom ) ;
ClassDB : : bind_method ( D_METHOD ( " get_zoom " ) , & EditorZoomWidget : : get_zoom ) ;
2021-04-27 22:54:59 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_zoom_by_increments " , " increment " , " integer_only " ) , & EditorZoomWidget : : set_zoom_by_increments ) ;
2021-05-07 13:41:39 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : FLOAT , " zoom " ) , " set_zoom " , " get_zoom " ) ;
ADD_SIGNAL ( MethodInfo ( " zoom_changed " , PropertyInfo ( Variant : : FLOAT , " zoom " ) ) ) ;
}
EditorZoomWidget : : EditorZoomWidget ( ) {
// Zoom buttons
zoom_minus = memnew ( Button ) ;
zoom_minus - > set_flat ( true ) ;
add_child ( zoom_minus ) ;
zoom_minus - > connect ( " pressed " , callable_mp ( this , & EditorZoomWidget : : _button_zoom_minus ) ) ;
2021-08-13 21:31:57 +00:00
zoom_minus - > set_shortcut ( ED_SHORTCUT ( " canvas_item_editor/zoom_minus " , TTR ( " Zoom Out " ) , KeyModifierMask : : CMD | Key : : MINUS ) ) ;
2021-05-07 13:41:39 +00:00
zoom_minus - > set_shortcut_context ( this ) ;
zoom_minus - > set_focus_mode ( FOCUS_NONE ) ;
zoom_reset = memnew ( Button ) ;
zoom_reset - > set_flat ( true ) ;
add_child ( zoom_reset ) ;
zoom_reset - > add_theme_constant_override ( " outline_size " , 1 ) ;
zoom_reset - > add_theme_color_override ( " font_outline_color " , Color ( 0 , 0 , 0 ) ) ;
zoom_reset - > add_theme_color_override ( " font_color " , Color ( 1 , 1 , 1 ) ) ;
zoom_reset - > connect ( " pressed " , callable_mp ( this , & EditorZoomWidget : : _button_zoom_reset ) ) ;
2021-08-13 21:31:57 +00:00
zoom_reset - > set_shortcut ( ED_SHORTCUT ( " canvas_item_editor/zoom_reset " , TTR ( " Zoom Reset " ) , KeyModifierMask : : CMD | Key : : KEY_0 ) ) ;
2021-05-07 13:41:39 +00:00
zoom_reset - > set_shortcut_context ( this ) ;
zoom_reset - > set_focus_mode ( FOCUS_NONE ) ;
2021-11-25 02:58:47 +00:00
zoom_reset - > set_text_alignment ( HORIZONTAL_ALIGNMENT_CENTER ) ;
2021-05-07 13:41:39 +00:00
// Prevent the button's size from changing when the text size changes
zoom_reset - > set_custom_minimum_size ( Size2 ( 75 * EDSCALE , 0 ) ) ;
zoom_plus = memnew ( Button ) ;
zoom_plus - > set_flat ( true ) ;
add_child ( zoom_plus ) ;
zoom_plus - > connect ( " pressed " , callable_mp ( this , & EditorZoomWidget : : _button_zoom_plus ) ) ;
2021-08-13 21:31:57 +00:00
zoom_plus - > set_shortcut ( ED_SHORTCUT ( " canvas_item_editor/zoom_plus " , TTR ( " Zoom In " ) , KeyModifierMask : : CMD | Key : : EQUAL ) ) ; // Usually direct access key for PLUS
2021-05-07 13:41:39 +00:00
zoom_plus - > set_shortcut_context ( this ) ;
zoom_plus - > set_focus_mode ( FOCUS_NONE ) ;
_update_zoom_label ( ) ;
add_theme_constant_override ( " separation " , Math : : round ( - 8 * EDSCALE ) ) ;
}