From 48fc5b2480dc394feae9cd7c4ec62cf8740cddbc Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 28 Jul 2021 19:33:14 +0200 Subject: [PATCH] Add node configuration warning for GeometryInstance3D distance --- scene/3d/visual_instance_3d.cpp | 12 ++++++++++++ scene/3d/visual_instance_3d.h | 1 + 2 files changed, 13 insertions(+) diff --git a/scene/3d/visual_instance_3d.cpp b/scene/3d/visual_instance_3d.cpp index 70a7021f228..c1558191593 100644 --- a/scene/3d/visual_instance_3d.cpp +++ b/scene/3d/visual_instance_3d.cpp @@ -153,6 +153,7 @@ Ref GeometryInstance3D::get_material_override() const { void GeometryInstance3D::set_visibility_range_begin(float p_dist) { visibility_range_begin = p_dist; RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin); + update_configuration_warnings(); } float GeometryInstance3D::get_visibility_range_begin() const { @@ -162,6 +163,7 @@ float GeometryInstance3D::get_visibility_range_begin() const { void GeometryInstance3D::set_visibility_range_end(float p_dist) { visibility_range_end = p_dist; RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin); + update_configuration_warnings(); } float GeometryInstance3D::get_visibility_range_end() const { @@ -351,6 +353,16 @@ bool GeometryInstance3D::is_ignoring_occlusion_culling() { return ignore_occlusion_culling; } +TypedArray GeometryInstance3D::get_configuration_warnings() const { + TypedArray warnings = Node::get_configuration_warnings(); + + if (!Math::is_zero_approx(visibility_range_end) && visibility_range_end <= visibility_range_begin) { + warnings.push_back(TTR("The GeometryInstance3D visibility range's End distance is set to a non-zero value, but is lower than the Begin distance.\nThis means the GeometryInstance3D will never be visible.\nTo resolve this, set the End distance to 0 or to a value greater than the Begin distance.")); + } + + return warnings; +} + void GeometryInstance3D::_bind_methods() { ClassDB::bind_method(D_METHOD("set_material_override", "material"), &GeometryInstance3D::set_material_override); ClassDB::bind_method(D_METHOD("get_material_override"), &GeometryInstance3D::get_material_override); diff --git a/scene/3d/visual_instance_3d.h b/scene/3d/visual_instance_3d.h index 2d5699859b0..97aac149a11 100644 --- a/scene/3d/visual_instance_3d.h +++ b/scene/3d/visual_instance_3d.h @@ -177,6 +177,7 @@ public: void set_ignore_occlusion_culling(bool p_enabled); bool is_ignoring_occlusion_culling(); + TypedArray get_configuration_warnings() const override; GeometryInstance3D(); };