Merge pull request #42282 from andriyDev/DeleteYSort

Remove YSort node, move its functionality into Node2D

doc/classes/Node2D.xml

@@ -150,6 +150,10 @@
  <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
  Local [Transform2D].
  </member>
+ <member name="y_sort_enabled" type="bool" setter="set_y_sort_enabled" getter="is_y_sort_enabled" default="false">
+ If [code]true[/code], child nodes with the lowest Y position are drawn before those with a higher Y position. If [code]false[/code], Y-sorting is disabled. Y-sorting only affects children that inherit from [CanvasItem].
+ You can nest nodes with Y-sorting. Child Y-sorted nodes are sorted in the same space as the parent Y-sort. This feature allows you to organize a scene better or divide it into multiple ones without changing your scene tree.
+ </member>
  <member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative" default="true">
  If [code]true[/code], the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.
  </member>

scene/2d/node_2d.cpp

@@ -391,6 +391,15 @@ Point2 Node2D::to_global(Point2 p_local) const {
  return get_global_transform().xform(p_local);
 }
 
+void Node2D::set_y_sort_enabled(bool p_enabled) {
+ y_sort_enabled = p_enabled;
+ RS::get_singleton()->canvas_item_set_sort_children_by_y(get_canvas_item(), y_sort_enabled);
+}
+
+bool Node2D::is_y_sort_enabled() const {
+ return y_sort_enabled;
+}
+
 void Node2D::_bind_methods() {
  ClassDB::bind_method(D_METHOD("set_position", "position"), &Node2D::set_position);
  ClassDB::bind_method(D_METHOD("set_rotation", "radians"), &Node2D::set_rotation);
@@ -437,6 +446,9 @@ void Node2D::_bind_methods() {
  ClassDB::bind_method(D_METHOD("set_z_as_relative", "enable"), &Node2D::set_z_as_relative);
  ClassDB::bind_method(D_METHOD("is_z_relative"), &Node2D::is_z_relative);
 
+ ClassDB::bind_method(D_METHOD("set_y_sort_enabled", "enabled"), &Node2D::set_y_sort_enabled);
+ ClassDB::bind_method(D_METHOD("is_y_sort_enabled"), &Node2D::is_y_sort_enabled);
+
  ClassDB::bind_method(D_METHOD("get_relative_transform_to_parent", "parent"), &Node2D::get_relative_transform_to_parent);
 
  ADD_GROUP("Transform", "");
@@ -454,7 +466,8 @@ void Node2D::_bind_methods() {
  ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "global_scale", PROPERTY_HINT_NONE, "", 0), "set_global_scale", "get_global_scale");
  ADD_PROPERTY(PropertyInfo(Variant::TRANSFORM2D, "global_transform", PROPERTY_HINT_NONE, "", 0), "set_global_transform", "get_global_transform");
 
- ADD_GROUP("Z Index", "");
+ ADD_GROUP("Ordering", "");
  ADD_PROPERTY(PropertyInfo(Variant::INT, "z_index", PROPERTY_HINT_RANGE, itos(RS::CANVAS_ITEM_Z_MIN) + "," + itos(RS::CANVAS_ITEM_Z_MAX) + ",1"), "set_z_index", "get_z_index");
  ADD_PROPERTY(PropertyInfo(Variant::BOOL, "z_as_relative"), "set_z_as_relative", "is_z_relative");
+ ADD_PROPERTY(PropertyInfo(Variant::BOOL, "y_sort_enabled"), "set_y_sort_enabled", "is_y_sort_enabled");
 }

scene/2d/node_2d.h

@@ -42,6 +42,7 @@ class Node2D : public CanvasItem {
  real_t skew = 0.0;
  int z_index = 0;
  bool z_relative = true;
+ bool y_sort_enabled = false;
 
  Transform2D _mat;
 
@@ -117,6 +118,9 @@ class Node2D : public CanvasItem {
  void set_z_as_relative(bool p_enabled);
  bool is_z_relative() const;
 
+ virtual void set_y_sort_enabled(bool p_enabled);
+ virtual bool is_y_sort_enabled() const;
+
  Transform2D get_relative_transform_to_parent(const Node *p_parent) const;
 
  Transform2D get_transform() const override;

scene/2d/tile_map.cpp

@@ -334,6 +334,12 @@ TileMap::VisibilityMode TileMap::get_navigation_visibility_mode() {
  return show_navigation;
 }
 
+void TileMap::set_y_sort_enabled(bool p_enable) {
+ Node2D::set_y_sort_enabled(p_enable);
+ _recreate_quadrants();
+ emit_signal("changed");
+}
+
 void TileMap::update_dirty_quadrants() {
  if (!pending_update) {
  return;

scene/2d/tile_map.h

@@ -279,6 +279,7 @@ class TileMap : public Node2D {
  int get_effective_quadrant_size() const;
 
  void update_dirty_quadrants();
+ virtual void set_y_sort_enabled(bool p_enable) override;
 
  Vector2 map_to_world(const Vector2i &p_pos) const;
  Vector2i world_to_map(const Vector2 &p_pos) const;

scene/register_scene_types.cpp

@@ -65,7 +65,6 @@
 #include "scene/2d/tile_map.h"
 #include "scene/2d/touch_screen_button.h"
 #include "scene/2d/visibility_notifier_2d.h"
-#include "scene/2d/y_sort.h"
 #include "scene/animation/animation_blend_space_1d.h"
 #include "scene/animation/animation_blend_space_2d.h"
 #include "scene/animation/animation_blend_tree.h"
@@ -643,7 +642,6 @@ void register_scene_types() {
  ClassDB::register_class<DirectionalLight2D>();
  ClassDB::register_class<LightOccluder2D>();
  ClassDB::register_class<OccluderPolygon2D>();
- ClassDB::register_class<YSort>();
  ClassDB::register_class<BackBufferCopy>();
 
  OS::get_singleton()->yield(); //may take time to init
@@ -820,6 +818,7 @@ void register_scene_types() {
  ClassDB::add_compatibility_class("ToolButton", "Button");
  ClassDB::add_compatibility_class("Navigation3D", "Node3D");
  ClassDB::add_compatibility_class("Navigation2D", "Node2D");
+ ClassDB::add_compatibility_class("YSort", "Node2D");
 
  // Renamed in 4.0.
  // Keep alphabetical ordering to easily locate classes and avoid duplicates.

scene/resources/tile_set.cpp

@@ -3870,8 +3870,8 @@ void TileSetPluginAtlasRendering::tilemap_notification(TileMap *p_tile_map, int
  } break;
  case CanvasItem::NOTIFICATION_DRAW: {
  Ref<TileSet> tile_set = p_tile_map->get_tileset();
- if (tile_set.is_valid()) {
- RenderingServer::get_singleton()->canvas_item_set_sort_children_by_y(p_tile_map->get_canvas_item(), tile_set->is_y_sorting());
+ if (tile_set.is_valid() || p_tile_map->is_y_sort_enabled()) {
+ RenderingServer::get_singleton()->canvas_item_set_sort_children_by_y(p_tile_map->get_canvas_item(), tile_set->is_y_sorting() || p_tile_map->is_y_sort_enabled());
  }
  } break;
  }