2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* container.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 14:16:55 +02:00
/* https://godotengine.org */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
2022-01-13 09:45:09 +01:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 02:10:30 +01:00
/* */
/* 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. */
/*************************************************************************/
2018-01-05 00:50:27 +01:00
2014-02-10 02:10:30 +01:00
# include "container.h"
2018-09-11 18:13:45 +02:00
# include "core/message_queue.h"
2017-03-05 16:44:50 +01:00
# include "scene/scene_string_names.h"
2014-02-10 02:10:30 +01:00
void Container : : _child_minsize_changed ( ) {
2018-05-15 22:12:35 +02:00
//Size2 ms = get_combined_minimum_size();
//if (ms.width > get_size().width || ms.height > get_size().height) {
minimum_size_changed ( ) ;
2014-02-10 02:10:30 +01:00
queue_sort ( ) ;
}
void Container : : add_child_notify ( Node * p_child ) {
2016-08-06 03:46:45 +02:00
Control : : add_child_notify ( p_child ) ;
2017-08-24 22:58:51 +02:00
Control * control = Object : : cast_to < Control > ( p_child ) ;
2021-05-05 12:44:11 +02:00
if ( ! control ) {
2014-02-10 02:10:30 +01:00
return ;
2021-05-05 12:44:11 +02:00
}
2014-02-10 02:10:30 +01:00
2017-03-05 16:44:50 +01:00
control - > connect ( " size_flags_changed " , this , " queue_sort " ) ;
control - > connect ( " minimum_size_changed " , this , " _child_minsize_changed " ) ;
control - > connect ( " visibility_changed " , this , " _child_minsize_changed " ) ;
2018-05-17 23:02:16 +02:00
minimum_size_changed ( ) ;
2014-02-10 02:10:30 +01:00
queue_sort ( ) ;
}
2015-11-28 17:05:39 +01:00
void Container : : move_child_notify ( Node * p_child ) {
2016-08-06 03:46:45 +02:00
Control : : move_child_notify ( p_child ) ;
2021-05-05 12:44:11 +02:00
if ( ! Object : : cast_to < Control > ( p_child ) ) {
2015-11-28 17:05:39 +01:00
return ;
2021-05-05 12:44:11 +02:00
}
2015-11-28 17:05:39 +01:00
2018-05-17 23:02:16 +02:00
minimum_size_changed ( ) ;
2015-11-28 17:05:39 +01:00
queue_sort ( ) ;
}
2014-02-10 02:10:30 +01:00
void Container : : remove_child_notify ( Node * p_child ) {
2016-08-06 03:46:45 +02:00
Control : : remove_child_notify ( p_child ) ;
2014-02-10 02:10:30 +01:00
2017-08-24 22:58:51 +02:00
Control * control = Object : : cast_to < Control > ( p_child ) ;
2021-05-05 12:44:11 +02:00
if ( ! control ) {
2014-02-10 02:10:30 +01:00
return ;
2021-05-05 12:44:11 +02:00
}
2014-02-10 02:10:30 +01:00
2017-03-05 16:44:50 +01:00
control - > disconnect ( " size_flags_changed " , this , " queue_sort " ) ;
control - > disconnect ( " minimum_size_changed " , this , " _child_minsize_changed " ) ;
control - > disconnect ( " visibility_changed " , this , " _child_minsize_changed " ) ;
2018-05-17 23:02:16 +02:00
minimum_size_changed ( ) ;
2014-02-10 02:10:30 +01:00
queue_sort ( ) ;
}
void Container : : _sort_children ( ) {
2021-05-05 12:44:11 +02:00
if ( ! is_inside_tree ( ) ) {
2014-02-10 02:10:30 +01:00
return ;
2021-05-05 12:44:11 +02:00
}
2014-02-10 02:10:30 +01:00
notification ( NOTIFICATION_SORT_CHILDREN ) ;
emit_signal ( SceneStringNames : : get_singleton ( ) - > sort_children ) ;
2017-03-05 16:44:50 +01:00
pending_sort = false ;
2014-02-10 02:10:30 +01:00
}
2017-03-05 16:44:50 +01:00
void Container : : fit_child_in_rect ( Control * p_child , const Rect2 & p_rect ) {
2019-01-03 13:59:37 +01:00
ERR_FAIL_COND ( ! p_child ) ;
2017-03-05 16:44:50 +01:00
ERR_FAIL_COND ( p_child - > get_parent ( ) ! = this ) ;
2014-02-10 02:10:30 +01:00
Size2 minsize = p_child - > get_combined_minimum_size ( ) ;
2017-03-05 16:44:50 +01:00
Rect2 r = p_rect ;
2014-02-10 02:10:30 +01:00
2017-03-05 16:44:50 +01:00
if ( ! ( p_child - > get_h_size_flags ( ) & SIZE_FILL ) ) {
2017-07-07 00:06:55 +02:00
r . size . x = minsize . width ;
if ( p_child - > get_h_size_flags ( ) & SIZE_SHRINK_END ) {
r . position . x + = p_rect . size . width - minsize . width ;
} else if ( p_child - > get_h_size_flags ( ) & SIZE_SHRINK_CENTER ) {
r . position . x + = Math : : floor ( ( p_rect . size . x - minsize . width ) / 2 ) ;
} else {
r . position . x + = 0 ;
}
2014-02-10 02:10:30 +01:00
}
2017-03-05 16:44:50 +01:00
if ( ! ( p_child - > get_v_size_flags ( ) & SIZE_FILL ) ) {
r . size . y = minsize . y ;
2017-07-07 00:06:55 +02:00
if ( p_child - > get_v_size_flags ( ) & SIZE_SHRINK_END ) {
r . position . y + = p_rect . size . height - minsize . height ;
} else if ( p_child - > get_v_size_flags ( ) & SIZE_SHRINK_CENTER ) {
r . position . y + = Math : : floor ( ( p_rect . size . y - minsize . height ) / 2 ) ;
} else {
r . position . y + = 0 ;
}
2014-02-10 02:10:30 +01:00
}
2021-05-05 12:44:11 +02:00
for ( int i = 0 ; i < 4 ; i + + ) {
2017-03-05 16:44:50 +01:00
p_child - > set_anchor ( Margin ( i ) , ANCHOR_BEGIN ) ;
2021-05-05 12:44:11 +02:00
}
2014-02-10 02:10:30 +01:00
2017-06-04 00:25:13 +02:00
p_child - > set_position ( r . position ) ;
2014-02-10 02:10:30 +01:00
p _child - > set_size ( r . size ) ;
2015-12-12 17:54:26 +01:00
p_child - > set_rotation ( 0 ) ;
2017-03-05 16:44:50 +01:00
p_child - > set_scale ( Vector2 ( 1 , 1 ) ) ;
2014-02-10 02:10:30 +01:00
}
void Container : : queue_sort ( ) {
2021-05-05 12:44:11 +02:00
if ( ! is_inside_tree ( ) ) {
2014-02-10 02:10:30 +01:00
return ;
2021-05-05 12:44:11 +02:00
}
2014-02-10 02:10:30 +01:00
2021-05-05 12:44:11 +02:00
if ( pending_sort ) {
2014-02-10 02:10:30 +01:00
return ;
2021-05-05 12:44:11 +02:00
}
2014-02-10 02:10:30 +01:00
2017-03-05 16:44:50 +01:00
MessageQueue : : get_singleton ( ) - > push_call ( this , " _sort_children " ) ;
pending_sort = true ;
2014-02-10 02:10:30 +01:00
}
void Container : : _notification ( int p_what ) {
2017-03-05 16:44:50 +01:00
switch ( p_what ) {
2014-11-06 01:20:42 +01:00
case NOTIFICATION_ENTER_TREE : {
2017-03-05 16:44:50 +01:00
pending_sort = false ;
2014-02-10 02:10:30 +01:00
queue_sort ( ) ;
} break ;
case NOTIFICATION_RESIZED : {
queue_sort ( ) ;
} break ;
case NOTIFICATION_THEME_CHANGED : {
queue_sort ( ) ;
} break ;
case NOTIFICATION_VISIBILITY_CHANGED : {
2017-01-13 14:45:50 +01:00
if ( is_visible_in_tree ( ) ) {
2014-02-10 02:10:30 +01:00
queue_sort ( ) ;
}
} break ;
}
}
2019-03-03 20:00:29 +01:00
String Container : : get_configuration_warning ( ) const {
String warning = Control : : get_configuration_warning ( ) ;
if ( get_class ( ) = = " Container " & & get_script ( ) . is_null ( ) ) {
if ( warning ! = String ( ) ) {
2019-07-09 00:17:04 +02:00
warning + = " \n \n " ;
2019-03-03 20:00:29 +01:00
}
2019-07-09 00:17:04 +02:00
warning + = TTR ( " Container by itself serves no purpose unless a script configures its children placement behavior. \n If you don't intend to add a script, use a plain Control node instead. " ) ;
2019-03-03 20:00:29 +01:00
}
return warning ;
}
2014-02-10 02:10:30 +01:00
void Container : : _bind_methods ( ) {
2017-03-05 16:44:50 +01:00
ClassDB : : bind_method ( D_METHOD ( " _sort_children " ) , & Container : : _sort_children ) ;
ClassDB : : bind_method ( D_METHOD ( " _child_minsize_changed " ) , & Container : : _child_minsize_changed ) ;
2014-02-10 02:10:30 +01:00
2017-03-05 16:44:50 +01:00
ClassDB : : bind_method ( D_METHOD ( " queue_sort " ) , & Container : : queue_sort ) ;
2017-08-09 13:19:41 +02:00
ClassDB : : bind_method ( D_METHOD ( " fit_child_in_rect " , " child " , " rect " ) , & Container : : fit_child_in_rect ) ;
2014-02-10 02:10:30 +01:00
2017-03-05 16:44:50 +01:00
BIND_CONSTANT ( NOTIFICATION_SORT_CHILDREN ) ;
2014-02-10 02:10:30 +01:00
ADD_SIGNAL ( MethodInfo ( " sort_children " ) ) ;
}
Container : : Container ( ) {
2017-03-05 16:44:50 +01:00
pending_sort = false ;
2014-02-10 02:10:30 +01:00
}