visual_instance_3d.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652
  1. /**************************************************************************/
  2. /* visual_instance_3d.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "visual_instance_3d.h"
  31. #include "core/config/project_settings.h"
  32. AABB VisualInstance3D::get_aabb() const {
  33. AABB ret;
  34. GDVIRTUAL_CALL(_get_aabb, ret);
  35. return ret;
  36. }
  37. void VisualInstance3D::_update_visibility() {
  38. if (!is_inside_tree()) {
  39. return;
  40. }
  41. bool already_visible = _is_vi_visible();
  42. bool visible = is_visible_in_tree();
  43. _set_vi_visible(visible);
  44. // If making visible, make sure the rendering server is up to date with the transform.
  45. if (visible && !already_visible) {
  46. if (!_is_using_identity_transform()) {
  47. Transform3D gt = get_global_transform();
  48. RS::get_singleton()->instance_set_transform(instance, gt);
  49. }
  50. }
  51. RS::get_singleton()->instance_set_visible(instance, visible);
  52. }
  53. void VisualInstance3D::set_instance_use_identity_transform(bool p_enable) {
  54. // Prevent sending instance transforms when using global coordinates.
  55. _set_use_identity_transform(p_enable);
  56. if (is_inside_tree()) {
  57. if (p_enable) {
  58. // Want to make sure instance is using identity transform.
  59. RS::get_singleton()->instance_set_transform(instance, Transform3D());
  60. } else {
  61. // Want to make sure instance is up to date.
  62. RS::get_singleton()->instance_set_transform(instance, get_global_transform());
  63. }
  64. }
  65. }
  66. void VisualInstance3D::fti_update_servers_xform() {
  67. if (!_is_using_identity_transform()) {
  68. RS::get_singleton()->instance_set_transform(get_instance(), _get_cached_global_transform_interpolated());
  69. }
  70. }
  71. void VisualInstance3D::_notification(int p_what) {
  72. switch (p_what) {
  73. case NOTIFICATION_ENTER_WORLD: {
  74. ERR_FAIL_COND(get_world_3d().is_null());
  75. RenderingServer::get_singleton()->instance_set_scenario(instance, get_world_3d()->get_scenario());
  76. _update_visibility();
  77. } break;
  78. case NOTIFICATION_TRANSFORM_CHANGED: {
  79. // ToDo : Can we turn off notify transform for physics interpolated cases?
  80. if (_is_vi_visible() && !(is_inside_tree() && get_tree()->is_physics_interpolation_enabled()) && !_is_using_identity_transform()) {
  81. // Physics interpolation global off, always send.
  82. RenderingServer::get_singleton()->instance_set_transform(instance, get_global_transform());
  83. }
  84. } break;
  85. case NOTIFICATION_RESET_PHYSICS_INTERPOLATION: {
  86. if (_is_vi_visible() && is_inside_tree()) {
  87. // Allow resetting motion vectors etc
  88. // at the same time as resetting physics interpolation,
  89. // giving users one common interface.
  90. RenderingServer::get_singleton()->instance_teleport(instance);
  91. }
  92. } break;
  93. case NOTIFICATION_EXIT_WORLD: {
  94. RenderingServer::get_singleton()->instance_set_scenario(instance, RID());
  95. RenderingServer::get_singleton()->instance_attach_skeleton(instance, RID());
  96. _set_vi_visible(false);
  97. } break;
  98. case NOTIFICATION_VISIBILITY_CHANGED: {
  99. _update_visibility();
  100. } break;
  101. }
  102. }
  103. RID VisualInstance3D::get_instance() const {
  104. return instance;
  105. }
  106. void VisualInstance3D::set_layer_mask(uint32_t p_mask) {
  107. layers = p_mask;
  108. RenderingServer::get_singleton()->instance_set_layer_mask(instance, p_mask);
  109. }
  110. uint32_t VisualInstance3D::get_layer_mask() const {
  111. return layers;
  112. }
  113. void VisualInstance3D::set_layer_mask_value(int p_layer_number, bool p_value) {
  114. ERR_FAIL_COND_MSG(p_layer_number < 1, "Render layer number must be between 1 and 20 inclusive.");
  115. ERR_FAIL_COND_MSG(p_layer_number > 20, "Render layer number must be between 1 and 20 inclusive.");
  116. uint32_t mask = get_layer_mask();
  117. if (p_value) {
  118. mask |= 1 << (p_layer_number - 1);
  119. } else {
  120. mask &= ~(1 << (p_layer_number - 1));
  121. }
  122. set_layer_mask(mask);
  123. }
  124. bool VisualInstance3D::get_layer_mask_value(int p_layer_number) const {
  125. ERR_FAIL_COND_V_MSG(p_layer_number < 1, false, "Render layer number must be between 1 and 20 inclusive.");
  126. ERR_FAIL_COND_V_MSG(p_layer_number > 20, false, "Render layer number must be between 1 and 20 inclusive.");
  127. return layers & (1 << (p_layer_number - 1));
  128. }
  129. void VisualInstance3D::set_sorting_offset(float p_offset) {
  130. sorting_offset = p_offset;
  131. RenderingServer::get_singleton()->instance_set_pivot_data(instance, sorting_offset, sorting_use_aabb_center);
  132. }
  133. float VisualInstance3D::get_sorting_offset() const {
  134. return sorting_offset;
  135. }
  136. void VisualInstance3D::set_sorting_use_aabb_center(bool p_enabled) {
  137. sorting_use_aabb_center = p_enabled;
  138. RenderingServer::get_singleton()->instance_set_pivot_data(instance, sorting_offset, sorting_use_aabb_center);
  139. }
  140. bool VisualInstance3D::is_sorting_use_aabb_center() const {
  141. return sorting_use_aabb_center;
  142. }
  143. void VisualInstance3D::_bind_methods() {
  144. ClassDB::bind_method(D_METHOD("set_base", "base"), &VisualInstance3D::set_base);
  145. ClassDB::bind_method(D_METHOD("get_base"), &VisualInstance3D::get_base);
  146. ClassDB::bind_method(D_METHOD("get_instance"), &VisualInstance3D::get_instance);
  147. ClassDB::bind_method(D_METHOD("set_layer_mask", "mask"), &VisualInstance3D::set_layer_mask);
  148. ClassDB::bind_method(D_METHOD("get_layer_mask"), &VisualInstance3D::get_layer_mask);
  149. ClassDB::bind_method(D_METHOD("set_layer_mask_value", "layer_number", "value"), &VisualInstance3D::set_layer_mask_value);
  150. ClassDB::bind_method(D_METHOD("get_layer_mask_value", "layer_number"), &VisualInstance3D::get_layer_mask_value);
  151. ClassDB::bind_method(D_METHOD("set_sorting_offset", "offset"), &VisualInstance3D::set_sorting_offset);
  152. ClassDB::bind_method(D_METHOD("get_sorting_offset"), &VisualInstance3D::get_sorting_offset);
  153. ClassDB::bind_method(D_METHOD("set_sorting_use_aabb_center", "enabled"), &VisualInstance3D::set_sorting_use_aabb_center);
  154. ClassDB::bind_method(D_METHOD("is_sorting_use_aabb_center"), &VisualInstance3D::is_sorting_use_aabb_center);
  155. GDVIRTUAL_BIND(_get_aabb);
  156. ADD_PROPERTY(PropertyInfo(Variant::INT, "layers", PROPERTY_HINT_LAYERS_3D_RENDER), "set_layer_mask", "get_layer_mask");
  157. ADD_GROUP("Sorting", "sorting_");
  158. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "sorting_offset", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_sorting_offset", "get_sorting_offset");
  159. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "sorting_use_aabb_center", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_sorting_use_aabb_center", "is_sorting_use_aabb_center");
  160. }
  161. void VisualInstance3D::set_base(const RID &p_base) {
  162. RenderingServer::get_singleton()->instance_set_base(instance, p_base);
  163. base = p_base;
  164. }
  165. RID VisualInstance3D::get_base() const {
  166. return base;
  167. }
  168. VisualInstance3D::VisualInstance3D() {
  169. _define_ancestry(AncestralClass::VISUAL_INSTANCE_3D);
  170. instance = RenderingServer::get_singleton()->instance_create();
  171. RenderingServer::get_singleton()->instance_attach_object_instance_id(instance, get_instance_id());
  172. set_notify_transform(true);
  173. }
  174. VisualInstance3D::~VisualInstance3D() {
  175. ERR_FAIL_NULL(RenderingServer::get_singleton());
  176. RenderingServer::get_singleton()->free_rid(instance);
  177. }
  178. void GeometryInstance3D::set_material_override(const Ref<Material> &p_material) {
  179. if (material_override.is_valid()) {
  180. material_override->disconnect(CoreStringName(property_list_changed), callable_mp((Object *)this, &Object::notify_property_list_changed));
  181. }
  182. material_override = p_material;
  183. if (material_override.is_valid()) {
  184. material_override->connect(CoreStringName(property_list_changed), callable_mp((Object *)this, &Object::notify_property_list_changed));
  185. }
  186. RS::get_singleton()->instance_geometry_set_material_override(get_instance(), p_material.is_valid() ? p_material->get_rid() : RID());
  187. }
  188. Ref<Material> GeometryInstance3D::get_material_override() const {
  189. return material_override;
  190. }
  191. void GeometryInstance3D::set_material_overlay(const Ref<Material> &p_material) {
  192. material_overlay = p_material;
  193. RS::get_singleton()->instance_geometry_set_material_overlay(get_instance(), p_material.is_valid() ? p_material->get_rid() : RID());
  194. }
  195. Ref<Material> GeometryInstance3D::get_material_overlay() const {
  196. return material_overlay;
  197. }
  198. void GeometryInstance3D::set_transparency(float p_transparency) {
  199. transparency = CLAMP(p_transparency, 0.0f, 1.0f);
  200. RS::get_singleton()->instance_geometry_set_transparency(get_instance(), transparency);
  201. update_configuration_warnings();
  202. }
  203. float GeometryInstance3D::get_transparency() const {
  204. return transparency;
  205. }
  206. void GeometryInstance3D::set_visibility_range_begin(float p_dist) {
  207. visibility_range_begin = p_dist;
  208. RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin, (RS::VisibilityRangeFadeMode)visibility_range_fade_mode);
  209. update_configuration_warnings();
  210. }
  211. float GeometryInstance3D::get_visibility_range_begin() const {
  212. return visibility_range_begin;
  213. }
  214. void GeometryInstance3D::set_visibility_range_end(float p_dist) {
  215. visibility_range_end = p_dist;
  216. RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin, (RS::VisibilityRangeFadeMode)visibility_range_fade_mode);
  217. update_configuration_warnings();
  218. }
  219. float GeometryInstance3D::get_visibility_range_end() const {
  220. return visibility_range_end;
  221. }
  222. void GeometryInstance3D::set_visibility_range_begin_margin(float p_dist) {
  223. visibility_range_begin_margin = p_dist;
  224. RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin, (RS::VisibilityRangeFadeMode)visibility_range_fade_mode);
  225. update_configuration_warnings();
  226. }
  227. float GeometryInstance3D::get_visibility_range_begin_margin() const {
  228. return visibility_range_begin_margin;
  229. }
  230. void GeometryInstance3D::set_visibility_range_end_margin(float p_dist) {
  231. visibility_range_end_margin = p_dist;
  232. RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin, (RS::VisibilityRangeFadeMode)visibility_range_fade_mode);
  233. update_configuration_warnings();
  234. }
  235. float GeometryInstance3D::get_visibility_range_end_margin() const {
  236. return visibility_range_end_margin;
  237. }
  238. void GeometryInstance3D::set_visibility_range_fade_mode(VisibilityRangeFadeMode p_mode) {
  239. visibility_range_fade_mode = p_mode;
  240. RS::get_singleton()->instance_geometry_set_visibility_range(get_instance(), visibility_range_begin, visibility_range_end, visibility_range_begin_margin, visibility_range_end_margin, (RS::VisibilityRangeFadeMode)visibility_range_fade_mode);
  241. update_configuration_warnings();
  242. }
  243. GeometryInstance3D::VisibilityRangeFadeMode GeometryInstance3D::get_visibility_range_fade_mode() const {
  244. return visibility_range_fade_mode;
  245. }
  246. const StringName *GeometryInstance3D::_instance_uniform_get_remap(const StringName &p_name) const {
  247. StringName *r = instance_shader_parameter_property_remap.getptr(p_name);
  248. if (!r) {
  249. String s = p_name;
  250. #ifndef DISABLE_DEPRECATED
  251. if (s.begins_with("shader_uniforms/")) {
  252. s = s.replace("shader_uniforms/", "instance_shader_parameters/");
  253. }
  254. #endif // DISABLE_DEPRECATED
  255. if (s.begins_with("instance_shader_parameters/")) {
  256. StringName pname = StringName(s);
  257. StringName name = s.replace("instance_shader_parameters/", "");
  258. instance_shader_parameter_property_remap[pname] = name;
  259. return instance_shader_parameter_property_remap.getptr(pname);
  260. }
  261. return nullptr;
  262. }
  263. return r;
  264. }
  265. bool GeometryInstance3D::_set(const StringName &p_name, const Variant &p_value) {
  266. const StringName *r = _instance_uniform_get_remap(p_name);
  267. if (r) {
  268. set_instance_shader_parameter(*r, p_value);
  269. return true;
  270. }
  271. #ifndef DISABLE_DEPRECATED
  272. if (p_name == SNAME("use_in_baked_light") && bool(p_value)) {
  273. set_gi_mode(GI_MODE_STATIC);
  274. return true;
  275. }
  276. if (p_name == SNAME("use_dynamic_gi") && bool(p_value)) {
  277. set_gi_mode(GI_MODE_DYNAMIC);
  278. return true;
  279. }
  280. #endif // DISABLE_DEPRECATED
  281. return false;
  282. }
  283. bool GeometryInstance3D::_get(const StringName &p_name, Variant &r_ret) const {
  284. const StringName *r = _instance_uniform_get_remap(p_name);
  285. if (r) {
  286. r_ret = get_instance_shader_parameter(*r);
  287. return true;
  288. }
  289. return false;
  290. }
  291. void GeometryInstance3D::_get_property_list(List<PropertyInfo> *p_list) const {
  292. List<PropertyInfo> pinfo;
  293. RS::get_singleton()->instance_geometry_get_shader_parameter_list(get_instance(), &pinfo);
  294. for (PropertyInfo &pi : pinfo) {
  295. bool has_def_value = false;
  296. Variant def_value = RS::get_singleton()->instance_geometry_get_shader_parameter_default_value(get_instance(), pi.name);
  297. if (def_value.get_type() != Variant::NIL) {
  298. has_def_value = true;
  299. }
  300. if (instance_shader_parameters.has(pi.name)) {
  301. pi.usage = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE | (has_def_value ? (PROPERTY_USAGE_CHECKABLE | PROPERTY_USAGE_CHECKED) : PROPERTY_USAGE_NONE);
  302. } else {
  303. pi.usage = PROPERTY_USAGE_EDITOR | (has_def_value ? PROPERTY_USAGE_CHECKABLE : PROPERTY_USAGE_NONE); //do not save if not changed
  304. }
  305. pi.name = "instance_shader_parameters/" + pi.name;
  306. p_list->push_back(pi);
  307. }
  308. }
  309. void GeometryInstance3D::set_cast_shadows_setting(ShadowCastingSetting p_shadow_casting_setting) {
  310. shadow_casting_setting = p_shadow_casting_setting;
  311. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(get_instance(), (RS::ShadowCastingSetting)p_shadow_casting_setting);
  312. }
  313. GeometryInstance3D::ShadowCastingSetting GeometryInstance3D::get_cast_shadows_setting() const {
  314. return shadow_casting_setting;
  315. }
  316. void GeometryInstance3D::set_extra_cull_margin(float p_margin) {
  317. ERR_FAIL_COND(p_margin < 0);
  318. extra_cull_margin = p_margin;
  319. RS::get_singleton()->instance_set_extra_visibility_margin(get_instance(), extra_cull_margin);
  320. }
  321. float GeometryInstance3D::get_extra_cull_margin() const {
  322. return extra_cull_margin;
  323. }
  324. void GeometryInstance3D::set_lod_bias(float p_bias) {
  325. ERR_FAIL_COND(p_bias < 0.0);
  326. lod_bias = p_bias;
  327. RS::get_singleton()->instance_geometry_set_lod_bias(get_instance(), lod_bias);
  328. }
  329. float GeometryInstance3D::get_lod_bias() const {
  330. return lod_bias;
  331. }
  332. void GeometryInstance3D::set_instance_shader_parameter(const StringName &p_name, const Variant &p_value) {
  333. if (p_value.get_type() == Variant::NIL) {
  334. Variant def_value = RS::get_singleton()->instance_geometry_get_shader_parameter_default_value(get_instance(), p_name);
  335. RS::get_singleton()->instance_geometry_set_shader_parameter(get_instance(), p_name, def_value);
  336. instance_shader_parameters.erase(p_value);
  337. } else {
  338. instance_shader_parameters[p_name] = p_value;
  339. if (p_value.get_type() == Variant::OBJECT) {
  340. RID tex_id = p_value;
  341. RS::get_singleton()->instance_geometry_set_shader_parameter(get_instance(), p_name, tex_id);
  342. } else {
  343. RS::get_singleton()->instance_geometry_set_shader_parameter(get_instance(), p_name, p_value);
  344. }
  345. }
  346. }
  347. Variant GeometryInstance3D::get_instance_shader_parameter(const StringName &p_name) const {
  348. return RS::get_singleton()->instance_geometry_get_shader_parameter(get_instance(), p_name);
  349. }
  350. void GeometryInstance3D::set_custom_aabb(AABB p_aabb) {
  351. if (p_aabb == custom_aabb) {
  352. return;
  353. }
  354. custom_aabb = p_aabb;
  355. RS::get_singleton()->instance_set_custom_aabb(get_instance(), custom_aabb);
  356. update_gizmos();
  357. }
  358. AABB GeometryInstance3D::get_custom_aabb() const {
  359. return custom_aabb;
  360. }
  361. void GeometryInstance3D::set_lightmap_texel_scale(float p_scale) {
  362. lightmap_texel_scale = p_scale;
  363. }
  364. float GeometryInstance3D::get_lightmap_texel_scale() const {
  365. return lightmap_texel_scale;
  366. }
  367. #ifndef DISABLE_DEPRECATED
  368. void GeometryInstance3D::set_lightmap_scale(LightmapScale p_scale) {
  369. ERR_FAIL_INDEX(p_scale, LIGHTMAP_SCALE_MAX);
  370. switch (p_scale) {
  371. case GeometryInstance3D::LIGHTMAP_SCALE_1X:
  372. lightmap_texel_scale = 1.0f;
  373. break;
  374. case GeometryInstance3D::LIGHTMAP_SCALE_2X:
  375. lightmap_texel_scale = 2.0f;
  376. break;
  377. case GeometryInstance3D::LIGHTMAP_SCALE_4X:
  378. lightmap_texel_scale = 4.0f;
  379. break;
  380. case GeometryInstance3D::LIGHTMAP_SCALE_8X:
  381. lightmap_texel_scale = 8.0f;
  382. break;
  383. case GeometryInstance3D::LIGHTMAP_SCALE_MAX:
  384. break; // Can't happen, but silences warning.
  385. }
  386. }
  387. GeometryInstance3D::LightmapScale GeometryInstance3D::get_lightmap_scale() const {
  388. // Return closest approximation.
  389. if (lightmap_texel_scale < 1.5f) {
  390. return GeometryInstance3D::LIGHTMAP_SCALE_1X;
  391. } else if (lightmap_texel_scale < 3.0f) {
  392. return GeometryInstance3D::LIGHTMAP_SCALE_2X;
  393. } else if (lightmap_texel_scale < 6.0f) {
  394. return GeometryInstance3D::LIGHTMAP_SCALE_4X;
  395. }
  396. return GeometryInstance3D::LIGHTMAP_SCALE_8X;
  397. }
  398. #endif // DISABLE_DEPRECATED
  399. void GeometryInstance3D::set_gi_mode(GIMode p_mode) {
  400. switch (p_mode) {
  401. case GI_MODE_DISABLED: {
  402. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  403. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_USE_DYNAMIC_GI, false);
  404. } break;
  405. case GI_MODE_STATIC: {
  406. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_USE_BAKED_LIGHT, true);
  407. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_USE_DYNAMIC_GI, false);
  408. } break;
  409. case GI_MODE_DYNAMIC: {
  410. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  411. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_USE_DYNAMIC_GI, true);
  412. } break;
  413. }
  414. gi_mode = p_mode;
  415. }
  416. GeometryInstance3D::GIMode GeometryInstance3D::get_gi_mode() const {
  417. return gi_mode;
  418. }
  419. void GeometryInstance3D::set_ignore_occlusion_culling(bool p_enabled) {
  420. ignore_occlusion_culling = p_enabled;
  421. RS::get_singleton()->instance_geometry_set_flag(get_instance(), RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, ignore_occlusion_culling);
  422. }
  423. bool GeometryInstance3D::is_ignoring_occlusion_culling() {
  424. return ignore_occlusion_culling;
  425. }
  426. Ref<TriangleMesh> GeometryInstance3D::generate_triangle_mesh() const {
  427. return Ref<TriangleMesh>();
  428. }
  429. PackedStringArray GeometryInstance3D::get_configuration_warnings() const {
  430. PackedStringArray warnings = VisualInstance3D::get_configuration_warnings();
  431. if (!Math::is_zero_approx(visibility_range_end) && visibility_range_end <= visibility_range_begin) {
  432. warnings.push_back(RTR("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."));
  433. }
  434. if ((visibility_range_fade_mode == VISIBILITY_RANGE_FADE_SELF || visibility_range_fade_mode == VISIBILITY_RANGE_FADE_DEPENDENCIES) && !Math::is_zero_approx(visibility_range_begin) && Math::is_zero_approx(visibility_range_begin_margin)) {
  435. warnings.push_back(RTR("The GeometryInstance3D is configured to fade in smoothly over distance, but the fade transition distance is set to 0.\nTo resolve this, increase Visibility Range Begin Margin above 0."));
  436. }
  437. if ((visibility_range_fade_mode == VISIBILITY_RANGE_FADE_SELF || visibility_range_fade_mode == VISIBILITY_RANGE_FADE_DEPENDENCIES) && !Math::is_zero_approx(visibility_range_end) && Math::is_zero_approx(visibility_range_end_margin)) {
  438. warnings.push_back(RTR("The GeometryInstance3D is configured to fade out smoothly over distance, but the fade transition distance is set to 0.\nTo resolve this, increase Visibility Range End Margin above 0."));
  439. }
  440. if (!Math::is_zero_approx(transparency) && OS::get_singleton()->get_current_rendering_method() != "forward_plus") {
  441. warnings.push_back(RTR("GeometryInstance3D transparency is only available when using the Forward+ renderer."));
  442. }
  443. if ((visibility_range_fade_mode == VISIBILITY_RANGE_FADE_SELF || visibility_range_fade_mode == VISIBILITY_RANGE_FADE_DEPENDENCIES) && OS::get_singleton()->get_current_rendering_method() != "forward_plus") {
  444. warnings.push_back(RTR("GeometryInstance3D visibility range transparency fade is only available when using the Forward+ renderer."));
  445. }
  446. return warnings;
  447. }
  448. void GeometryInstance3D::_validate_property(PropertyInfo &p_property) const {
  449. if (p_property.name == "sorting_offset" || p_property.name == "sorting_use_aabb_center") {
  450. p_property.usage = PROPERTY_USAGE_DEFAULT;
  451. }
  452. }
  453. void GeometryInstance3D::_bind_methods() {
  454. ClassDB::bind_method(D_METHOD("set_material_override", "material"), &GeometryInstance3D::set_material_override);
  455. ClassDB::bind_method(D_METHOD("get_material_override"), &GeometryInstance3D::get_material_override);
  456. ClassDB::bind_method(D_METHOD("set_material_overlay", "material"), &GeometryInstance3D::set_material_overlay);
  457. ClassDB::bind_method(D_METHOD("get_material_overlay"), &GeometryInstance3D::get_material_overlay);
  458. ClassDB::bind_method(D_METHOD("set_cast_shadows_setting", "shadow_casting_setting"), &GeometryInstance3D::set_cast_shadows_setting);
  459. ClassDB::bind_method(D_METHOD("get_cast_shadows_setting"), &GeometryInstance3D::get_cast_shadows_setting);
  460. ClassDB::bind_method(D_METHOD("set_lod_bias", "bias"), &GeometryInstance3D::set_lod_bias);
  461. ClassDB::bind_method(D_METHOD("get_lod_bias"), &GeometryInstance3D::get_lod_bias);
  462. ClassDB::bind_method(D_METHOD("set_transparency", "transparency"), &GeometryInstance3D::set_transparency);
  463. ClassDB::bind_method(D_METHOD("get_transparency"), &GeometryInstance3D::get_transparency);
  464. ClassDB::bind_method(D_METHOD("set_visibility_range_end_margin", "distance"), &GeometryInstance3D::set_visibility_range_end_margin);
  465. ClassDB::bind_method(D_METHOD("get_visibility_range_end_margin"), &GeometryInstance3D::get_visibility_range_end_margin);
  466. ClassDB::bind_method(D_METHOD("set_visibility_range_end", "distance"), &GeometryInstance3D::set_visibility_range_end);
  467. ClassDB::bind_method(D_METHOD("get_visibility_range_end"), &GeometryInstance3D::get_visibility_range_end);
  468. ClassDB::bind_method(D_METHOD("set_visibility_range_begin_margin", "distance"), &GeometryInstance3D::set_visibility_range_begin_margin);
  469. ClassDB::bind_method(D_METHOD("get_visibility_range_begin_margin"), &GeometryInstance3D::get_visibility_range_begin_margin);
  470. ClassDB::bind_method(D_METHOD("set_visibility_range_begin", "distance"), &GeometryInstance3D::set_visibility_range_begin);
  471. ClassDB::bind_method(D_METHOD("get_visibility_range_begin"), &GeometryInstance3D::get_visibility_range_begin);
  472. ClassDB::bind_method(D_METHOD("set_visibility_range_fade_mode", "mode"), &GeometryInstance3D::set_visibility_range_fade_mode);
  473. ClassDB::bind_method(D_METHOD("get_visibility_range_fade_mode"), &GeometryInstance3D::get_visibility_range_fade_mode);
  474. ClassDB::bind_method(D_METHOD("set_instance_shader_parameter", "name", "value"), &GeometryInstance3D::set_instance_shader_parameter);
  475. ClassDB::bind_method(D_METHOD("get_instance_shader_parameter", "name"), &GeometryInstance3D::get_instance_shader_parameter);
  476. ClassDB::bind_method(D_METHOD("set_extra_cull_margin", "margin"), &GeometryInstance3D::set_extra_cull_margin);
  477. ClassDB::bind_method(D_METHOD("get_extra_cull_margin"), &GeometryInstance3D::get_extra_cull_margin);
  478. ClassDB::bind_method(D_METHOD("set_lightmap_texel_scale", "scale"), &GeometryInstance3D::set_lightmap_texel_scale);
  479. ClassDB::bind_method(D_METHOD("get_lightmap_texel_scale"), &GeometryInstance3D::get_lightmap_texel_scale);
  480. #ifndef DISABLE_DEPRECATED
  481. ClassDB::bind_method(D_METHOD("set_lightmap_scale", "scale"), &GeometryInstance3D::set_lightmap_scale);
  482. ClassDB::bind_method(D_METHOD("get_lightmap_scale"), &GeometryInstance3D::get_lightmap_scale);
  483. #endif // DISABLE_DEPRECATED
  484. ClassDB::bind_method(D_METHOD("set_gi_mode", "mode"), &GeometryInstance3D::set_gi_mode);
  485. ClassDB::bind_method(D_METHOD("get_gi_mode"), &GeometryInstance3D::get_gi_mode);
  486. ClassDB::bind_method(D_METHOD("set_ignore_occlusion_culling", "ignore_culling"), &GeometryInstance3D::set_ignore_occlusion_culling);
  487. ClassDB::bind_method(D_METHOD("is_ignoring_occlusion_culling"), &GeometryInstance3D::is_ignoring_occlusion_culling);
  488. ClassDB::bind_method(D_METHOD("set_custom_aabb", "aabb"), &GeometryInstance3D::set_custom_aabb);
  489. ClassDB::bind_method(D_METHOD("get_custom_aabb"), &GeometryInstance3D::get_custom_aabb);
  490. ClassDB::bind_method(D_METHOD("get_aabb"), &GeometryInstance3D::get_aabb);
  491. ADD_GROUP("Geometry", "");
  492. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "material_override", PROPERTY_HINT_RESOURCE_TYPE, "BaseMaterial3D,ShaderMaterial", PROPERTY_USAGE_DEFAULT), "set_material_override", "get_material_override");
  493. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "material_overlay", PROPERTY_HINT_RESOURCE_TYPE, "BaseMaterial3D,ShaderMaterial", PROPERTY_USAGE_DEFAULT), "set_material_overlay", "get_material_overlay");
  494. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "transparency", PROPERTY_HINT_RANGE, "0.0,1.0,0.01"), "set_transparency", "get_transparency");
  495. ADD_PROPERTY(PropertyInfo(Variant::INT, "cast_shadow", PROPERTY_HINT_ENUM, "Off,On,Double-Sided,Shadows Only"), "set_cast_shadows_setting", "get_cast_shadows_setting");
  496. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "extra_cull_margin", PROPERTY_HINT_RANGE, "0,16384,0.01,suffix:m"), "set_extra_cull_margin", "get_extra_cull_margin");
  497. ADD_PROPERTY(PropertyInfo(Variant::AABB, "custom_aabb", PROPERTY_HINT_NONE, "suffix:m"), "set_custom_aabb", "get_custom_aabb");
  498. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "lod_bias", PROPERTY_HINT_RANGE, "0.001,128,0.001"), "set_lod_bias", "get_lod_bias");
  499. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "ignore_occlusion_culling"), "set_ignore_occlusion_culling", "is_ignoring_occlusion_culling");
  500. ADD_GROUP("Global Illumination", "gi_");
  501. ADD_PROPERTY(PropertyInfo(Variant::INT, "gi_mode", PROPERTY_HINT_ENUM, "Disabled,Static,Dynamic"), "set_gi_mode", "get_gi_mode");
  502. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "gi_lightmap_texel_scale", PROPERTY_HINT_RANGE, "0.01,10,0.0001,or_greater"), "set_lightmap_texel_scale", "get_lightmap_texel_scale");
  503. #ifndef DISABLE_DEPRECATED
  504. ADD_PROPERTY(PropertyInfo(Variant::INT, "gi_lightmap_scale", PROPERTY_HINT_ENUM, String::utf8("1×,2×,4×,8×"), PROPERTY_USAGE_NONE), "set_lightmap_scale", "get_lightmap_scale");
  505. #endif // DISABLE_DEPRECATED
  506. ADD_GROUP("Visibility Range", "visibility_range_");
  507. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "visibility_range_begin", PROPERTY_HINT_RANGE, "0.0,4096.0,0.01,or_greater,suffix:m"), "set_visibility_range_begin", "get_visibility_range_begin");
  508. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "visibility_range_begin_margin", PROPERTY_HINT_RANGE, "0.0,4096.0,0.01,or_greater,suffix:m"), "set_visibility_range_begin_margin", "get_visibility_range_begin_margin");
  509. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "visibility_range_end", PROPERTY_HINT_RANGE, "0.0,4096.0,0.01,or_greater,suffix:m"), "set_visibility_range_end", "get_visibility_range_end");
  510. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "visibility_range_end_margin", PROPERTY_HINT_RANGE, "0.0,4096.0,0.01,or_greater,suffix:m"), "set_visibility_range_end_margin", "get_visibility_range_end_margin");
  511. ADD_PROPERTY(PropertyInfo(Variant::INT, "visibility_range_fade_mode", PROPERTY_HINT_ENUM, "Disabled,Self,Dependencies"), "set_visibility_range_fade_mode", "get_visibility_range_fade_mode");
  512. BIND_ENUM_CONSTANT(SHADOW_CASTING_SETTING_OFF);
  513. BIND_ENUM_CONSTANT(SHADOW_CASTING_SETTING_ON);
  514. BIND_ENUM_CONSTANT(SHADOW_CASTING_SETTING_DOUBLE_SIDED);
  515. BIND_ENUM_CONSTANT(SHADOW_CASTING_SETTING_SHADOWS_ONLY);
  516. BIND_ENUM_CONSTANT(GI_MODE_DISABLED);
  517. BIND_ENUM_CONSTANT(GI_MODE_STATIC);
  518. BIND_ENUM_CONSTANT(GI_MODE_DYNAMIC);
  519. BIND_ENUM_CONSTANT(LIGHTMAP_SCALE_1X);
  520. BIND_ENUM_CONSTANT(LIGHTMAP_SCALE_2X);
  521. BIND_ENUM_CONSTANT(LIGHTMAP_SCALE_4X);
  522. BIND_ENUM_CONSTANT(LIGHTMAP_SCALE_8X);
  523. BIND_ENUM_CONSTANT(LIGHTMAP_SCALE_MAX);
  524. BIND_ENUM_CONSTANT(VISIBILITY_RANGE_FADE_DISABLED);
  525. BIND_ENUM_CONSTANT(VISIBILITY_RANGE_FADE_SELF);
  526. BIND_ENUM_CONSTANT(VISIBILITY_RANGE_FADE_DEPENDENCIES);
  527. }
  528. GeometryInstance3D::GeometryInstance3D() {
  529. _define_ancestry(AncestralClass::GEOMETRY_INSTANCE_3D);
  530. }
  531. GeometryInstance3D::~GeometryInstance3D() {
  532. if (material_overlay.is_valid()) {
  533. set_material_overlay(Ref<Material>());
  534. }
  535. if (material_override.is_valid()) {
  536. set_material_override(Ref<Material>());
  537. }
  538. }