node_3d.cpp 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074
  1. /*************************************************************************/
  2. /* node_3d.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  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 "node_3d.h"
  31. #include "core/object/message_queue.h"
  32. #include "scene/3d/visual_instance_3d.h"
  33. #include "scene/main/viewport.h"
  34. #include "scene/property_utils.h"
  35. #include "scene/scene_string_names.h"
  36. /*
  37. possible algorithms:
  38. Algorithm 1: (current)
  39. definition of invalidation: global is invalid
  40. 1) If a node sets a LOCAL, it produces an invalidation of everything above
  41. . a) If above is invalid, don't keep invalidating upwards
  42. 2) If a node sets a GLOBAL, it is converted to LOCAL (and forces validation of everything pending below)
  43. drawback: setting/reading globals is useful and used very often, and using affine inverses is slow
  44. ---
  45. Algorithm 2: (no longer current)
  46. definition of invalidation: NONE dirty, LOCAL dirty, GLOBAL dirty
  47. 1) If a node sets a LOCAL, it must climb the tree and set it as GLOBAL dirty
  48. . a) marking GLOBALs as dirty up all the tree must be done always
  49. 2) If a node sets a GLOBAL, it marks local as dirty, and that's all?
  50. //is clearing the dirty state correct in this case?
  51. drawback: setting a local down the tree forces many tree walks often
  52. --
  53. future: no idea
  54. */
  55. Node3DGizmo::Node3DGizmo() {
  56. }
  57. void Node3D::_notify_dirty() {
  58. #ifdef TOOLS_ENABLED
  59. if ((!data.gizmos.is_empty() || data.notify_transform) && !data.ignore_notification && !xform_change.in_list()) {
  60. #else
  61. if (data.notify_transform && !data.ignore_notification && !xform_change.in_list()) {
  62. #endif
  63. get_tree()->xform_change_list.add(&xform_change);
  64. }
  65. }
  66. void Node3D::_update_local_transform() const {
  67. // This function is called when the local transform (data.local_transform) is dirty and the right value is contained in the Euler rotation and scale.
  68. data.local_transform.basis.set_euler_scale(data.euler_rotation, data.scale, data.euler_rotation_order);
  69. data.dirty &= ~DIRTY_LOCAL_TRANSFORM;
  70. }
  71. void Node3D::_update_rotation_and_scale() const {
  72. // This function is called when the Euler rotation (data.euler_rotation) is dirty and the right value is contained in the local transform
  73. data.scale = data.local_transform.basis.get_scale();
  74. data.euler_rotation = data.local_transform.basis.get_euler_normalized(data.euler_rotation_order);
  75. data.dirty &= ~DIRTY_EULER_ROTATION_AND_SCALE;
  76. }
  77. void Node3D::_propagate_transform_changed(Node3D *p_origin) {
  78. if (!is_inside_tree()) {
  79. return;
  80. }
  81. data.children_lock++;
  82. for (Node3D *&E : data.children) {
  83. if (E->data.top_level_active) {
  84. continue; //don't propagate to a top_level
  85. }
  86. E->_propagate_transform_changed(p_origin);
  87. }
  88. #ifdef TOOLS_ENABLED
  89. if ((!data.gizmos.is_empty() || data.notify_transform) && !data.ignore_notification && !xform_change.in_list()) {
  90. #else
  91. if (data.notify_transform && !data.ignore_notification && !xform_change.in_list()) {
  92. #endif
  93. get_tree()->xform_change_list.add(&xform_change);
  94. }
  95. data.dirty |= DIRTY_GLOBAL_TRANSFORM;
  96. data.children_lock--;
  97. }
  98. void Node3D::_notification(int p_what) {
  99. switch (p_what) {
  100. case NOTIFICATION_ENTER_TREE: {
  101. ERR_FAIL_COND(!get_tree());
  102. Node *p = get_parent();
  103. if (p) {
  104. data.parent = Object::cast_to<Node3D>(p);
  105. }
  106. if (data.parent) {
  107. data.C = data.parent->data.children.push_back(this);
  108. } else {
  109. data.C = nullptr;
  110. }
  111. if (data.top_level && !Engine::get_singleton()->is_editor_hint()) {
  112. if (data.parent) {
  113. data.local_transform = data.parent->get_global_transform() * get_transform();
  114. data.dirty = DIRTY_EULER_ROTATION_AND_SCALE; // As local transform was updated, rot/scale should be dirty.
  115. }
  116. data.top_level_active = true;
  117. }
  118. data.dirty |= DIRTY_GLOBAL_TRANSFORM; // Global is always dirty upon entering a scene.
  119. _notify_dirty();
  120. notification(NOTIFICATION_ENTER_WORLD);
  121. _update_visibility_parent(true);
  122. } break;
  123. case NOTIFICATION_EXIT_TREE: {
  124. notification(NOTIFICATION_EXIT_WORLD, true);
  125. if (xform_change.in_list()) {
  126. get_tree()->xform_change_list.remove(&xform_change);
  127. }
  128. if (data.C) {
  129. data.parent->data.children.erase(data.C);
  130. }
  131. data.parent = nullptr;
  132. data.C = nullptr;
  133. data.top_level_active = false;
  134. _update_visibility_parent(true);
  135. } break;
  136. case NOTIFICATION_ENTER_WORLD: {
  137. data.inside_world = true;
  138. data.viewport = nullptr;
  139. Node *parent = get_parent();
  140. while (parent && !data.viewport) {
  141. data.viewport = Object::cast_to<Viewport>(parent);
  142. parent = parent->get_parent();
  143. }
  144. ERR_FAIL_COND(!data.viewport);
  145. if (get_script_instance()) {
  146. get_script_instance()->call(SceneStringNames::get_singleton()->_enter_world);
  147. }
  148. #ifdef TOOLS_ENABLED
  149. if (Engine::get_singleton()->is_editor_hint() && get_tree()->is_node_being_edited(this)) {
  150. get_tree()->call_group_flags(SceneTree::GROUP_CALL_DEFERRED, SceneStringNames::get_singleton()->_spatial_editor_group, SceneStringNames::get_singleton()->_request_gizmo, this);
  151. }
  152. #endif
  153. } break;
  154. case NOTIFICATION_EXIT_WORLD: {
  155. #ifdef TOOLS_ENABLED
  156. clear_gizmos();
  157. #endif
  158. if (get_script_instance()) {
  159. get_script_instance()->call(SceneStringNames::get_singleton()->_exit_world);
  160. }
  161. data.viewport = nullptr;
  162. data.inside_world = false;
  163. } break;
  164. case NOTIFICATION_TRANSFORM_CHANGED: {
  165. #ifdef TOOLS_ENABLED
  166. for (int i = 0; i < data.gizmos.size(); i++) {
  167. data.gizmos.write[i]->transform();
  168. }
  169. #endif
  170. } break;
  171. }
  172. }
  173. void Node3D::set_basis(const Basis &p_basis) {
  174. set_transform(Transform3D(p_basis, data.local_transform.origin));
  175. }
  176. void Node3D::set_quaternion(const Quaternion &p_quaternion) {
  177. if (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE) {
  178. // We need the scale part, so if these are dirty, update it
  179. data.scale = data.local_transform.basis.get_scale();
  180. data.dirty &= ~DIRTY_EULER_ROTATION_AND_SCALE;
  181. }
  182. data.local_transform.basis = Basis(p_quaternion, data.scale);
  183. // Rotscale should not be marked dirty because that would cause precision loss issues with the scale. Instead reconstruct rotation now.
  184. data.euler_rotation = data.local_transform.basis.get_euler_normalized(data.euler_rotation_order);
  185. data.dirty = DIRTY_NONE;
  186. _propagate_transform_changed(this);
  187. if (data.notify_local_transform) {
  188. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  189. }
  190. }
  191. Vector3 Node3D::get_global_position() const {
  192. return get_global_transform().get_origin();
  193. }
  194. void Node3D::set_global_position(const Vector3 &p_position) {
  195. Transform3D transform = get_global_transform();
  196. transform.set_origin(p_position);
  197. set_global_transform(transform);
  198. }
  199. Vector3 Node3D::get_global_rotation() const {
  200. return get_global_transform().get_basis().get_euler();
  201. }
  202. void Node3D::set_global_rotation(const Vector3 &p_euler_rad) {
  203. Transform3D transform = get_global_transform();
  204. Basis new_basis = transform.get_basis();
  205. new_basis.set_euler(p_euler_rad);
  206. transform.set_basis(new_basis);
  207. set_global_transform(transform);
  208. }
  209. void Node3D::set_transform(const Transform3D &p_transform) {
  210. data.local_transform = p_transform;
  211. data.dirty = DIRTY_EULER_ROTATION_AND_SCALE; // Make rot/scale dirty.
  212. _propagate_transform_changed(this);
  213. if (data.notify_local_transform) {
  214. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  215. }
  216. }
  217. Basis Node3D::get_basis() const {
  218. return get_transform().basis;
  219. }
  220. Quaternion Node3D::get_quaternion() const {
  221. if (data.dirty & DIRTY_LOCAL_TRANSFORM) {
  222. _update_local_transform();
  223. }
  224. return data.local_transform.basis.get_rotation_quaternion();
  225. }
  226. void Node3D::set_global_transform(const Transform3D &p_transform) {
  227. Transform3D xform = (data.parent && !data.top_level_active)
  228. ? data.parent->get_global_transform().affine_inverse() * p_transform
  229. : p_transform;
  230. set_transform(xform);
  231. }
  232. Transform3D Node3D::get_transform() const {
  233. if (data.dirty & DIRTY_LOCAL_TRANSFORM) {
  234. _update_local_transform();
  235. }
  236. return data.local_transform;
  237. }
  238. Transform3D Node3D::get_global_transform() const {
  239. ERR_FAIL_COND_V(!is_inside_tree(), Transform3D());
  240. if (data.dirty & DIRTY_GLOBAL_TRANSFORM) {
  241. if (data.dirty & DIRTY_LOCAL_TRANSFORM) {
  242. _update_local_transform();
  243. }
  244. if (data.parent && !data.top_level_active) {
  245. data.global_transform = data.parent->get_global_transform() * data.local_transform;
  246. } else {
  247. data.global_transform = data.local_transform;
  248. }
  249. if (data.disable_scale) {
  250. data.global_transform.basis.orthonormalize();
  251. }
  252. data.dirty &= ~DIRTY_GLOBAL_TRANSFORM;
  253. }
  254. return data.global_transform;
  255. }
  256. #ifdef TOOLS_ENABLED
  257. Transform3D Node3D::get_global_gizmo_transform() const {
  258. return get_global_transform();
  259. }
  260. Transform3D Node3D::get_local_gizmo_transform() const {
  261. return get_transform();
  262. }
  263. #endif
  264. Node3D *Node3D::get_parent_node_3d() const {
  265. if (data.top_level) {
  266. return nullptr;
  267. }
  268. return Object::cast_to<Node3D>(get_parent());
  269. }
  270. Transform3D Node3D::get_relative_transform(const Node *p_parent) const {
  271. if (p_parent == this) {
  272. return Transform3D();
  273. }
  274. ERR_FAIL_COND_V(!data.parent, Transform3D());
  275. if (p_parent == data.parent) {
  276. return get_transform();
  277. } else {
  278. return data.parent->get_relative_transform(p_parent) * get_transform();
  279. }
  280. }
  281. void Node3D::set_position(const Vector3 &p_position) {
  282. data.local_transform.origin = p_position;
  283. _propagate_transform_changed(this);
  284. if (data.notify_local_transform) {
  285. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  286. }
  287. }
  288. void Node3D::set_rotation_edit_mode(RotationEditMode p_mode) {
  289. if (data.rotation_edit_mode == p_mode) {
  290. return;
  291. }
  292. bool transform_changed = false;
  293. if (data.rotation_edit_mode == ROTATION_EDIT_MODE_BASIS && !(data.dirty & DIRTY_LOCAL_TRANSFORM)) {
  294. data.local_transform.orthogonalize();
  295. transform_changed = true;
  296. }
  297. data.rotation_edit_mode = p_mode;
  298. if (p_mode == ROTATION_EDIT_MODE_EULER && (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE)) {
  299. // If going to Euler mode, ensure that vectors are _not_ dirty, else the retrieved value may be wrong.
  300. // Otherwise keep what is there, so switching back and forth between modes does not break the vectors.
  301. _update_rotation_and_scale();
  302. }
  303. if (transform_changed) {
  304. _propagate_transform_changed(this);
  305. if (data.notify_local_transform) {
  306. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  307. }
  308. }
  309. notify_property_list_changed();
  310. }
  311. Node3D::RotationEditMode Node3D::get_rotation_edit_mode() const {
  312. return data.rotation_edit_mode;
  313. }
  314. void Node3D::set_rotation_order(RotationOrder p_order) {
  315. Basis::EulerOrder order = Basis::EulerOrder(p_order);
  316. if (data.euler_rotation_order == order) {
  317. return;
  318. }
  319. ERR_FAIL_INDEX(int32_t(order), 6);
  320. bool transform_changed = false;
  321. if (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE) {
  322. _update_rotation_and_scale();
  323. } else if (data.dirty & DIRTY_LOCAL_TRANSFORM) {
  324. data.euler_rotation = Basis::from_euler(data.euler_rotation, data.euler_rotation_order).get_euler_normalized(order);
  325. transform_changed = true;
  326. } else {
  327. data.dirty |= DIRTY_LOCAL_TRANSFORM;
  328. transform_changed = true;
  329. }
  330. data.euler_rotation_order = order;
  331. if (transform_changed) {
  332. _propagate_transform_changed(this);
  333. if (data.notify_local_transform) {
  334. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  335. }
  336. }
  337. notify_property_list_changed(); // Will change the rotation property.
  338. }
  339. Node3D::RotationOrder Node3D::get_rotation_order() const {
  340. return RotationOrder(data.euler_rotation_order);
  341. }
  342. void Node3D::set_rotation(const Vector3 &p_euler_rad) {
  343. if (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE) {
  344. // Update scale only if rotation and scale are dirty, as rotation will be overridden.
  345. data.scale = data.local_transform.basis.get_scale();
  346. data.dirty &= ~DIRTY_EULER_ROTATION_AND_SCALE;
  347. }
  348. data.euler_rotation = p_euler_rad;
  349. data.dirty = DIRTY_LOCAL_TRANSFORM;
  350. _propagate_transform_changed(this);
  351. if (data.notify_local_transform) {
  352. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  353. }
  354. }
  355. void Node3D::set_scale(const Vector3 &p_scale) {
  356. if (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE) {
  357. // Update rotation only if rotation and scale are dirty, as scale will be overridden.
  358. data.euler_rotation = data.local_transform.basis.get_euler_normalized(data.euler_rotation_order);
  359. data.dirty &= ~DIRTY_EULER_ROTATION_AND_SCALE;
  360. }
  361. data.scale = p_scale;
  362. data.dirty = DIRTY_LOCAL_TRANSFORM;
  363. _propagate_transform_changed(this);
  364. if (data.notify_local_transform) {
  365. notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED);
  366. }
  367. }
  368. Vector3 Node3D::get_position() const {
  369. return data.local_transform.origin;
  370. }
  371. Vector3 Node3D::get_rotation() const {
  372. if (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE) {
  373. _update_rotation_and_scale();
  374. }
  375. return data.euler_rotation;
  376. }
  377. Vector3 Node3D::get_scale() const {
  378. if (data.dirty & DIRTY_EULER_ROTATION_AND_SCALE) {
  379. _update_rotation_and_scale();
  380. }
  381. return data.scale;
  382. }
  383. void Node3D::update_gizmos() {
  384. #ifdef TOOLS_ENABLED
  385. if (!is_inside_world()) {
  386. return;
  387. }
  388. if (data.gizmos.is_empty()) {
  389. get_tree()->call_group_flags(SceneTree::GROUP_CALL_DEFERRED, SceneStringNames::get_singleton()->_spatial_editor_group, SceneStringNames::get_singleton()->_request_gizmo, this);
  390. return;
  391. }
  392. if (data.gizmos_dirty) {
  393. return;
  394. }
  395. data.gizmos_dirty = true;
  396. MessageQueue::get_singleton()->push_callable(callable_mp(this, &Node3D::_update_gizmos));
  397. #endif
  398. }
  399. void Node3D::set_subgizmo_selection(Ref<Node3DGizmo> p_gizmo, int p_id, Transform3D p_transform) {
  400. #ifdef TOOLS_ENABLED
  401. if (!is_inside_world()) {
  402. return;
  403. }
  404. if (Engine::get_singleton()->is_editor_hint() && get_tree()->is_node_being_edited(this)) {
  405. get_tree()->call_group_flags(SceneTree::GROUP_CALL_DEFERRED, SceneStringNames::get_singleton()->_spatial_editor_group, SceneStringNames::get_singleton()->_set_subgizmo_selection, this, p_gizmo, p_id, p_transform);
  406. }
  407. #endif
  408. }
  409. void Node3D::clear_subgizmo_selection() {
  410. #ifdef TOOLS_ENABLED
  411. if (!is_inside_world()) {
  412. return;
  413. }
  414. if (data.gizmos.is_empty()) {
  415. return;
  416. }
  417. if (Engine::get_singleton()->is_editor_hint() && get_tree()->is_node_being_edited(this)) {
  418. get_tree()->call_group_flags(SceneTree::GROUP_CALL_DEFERRED, SceneStringNames::get_singleton()->_spatial_editor_group, SceneStringNames::get_singleton()->_clear_subgizmo_selection, this);
  419. }
  420. #endif
  421. }
  422. void Node3D::add_gizmo(Ref<Node3DGizmo> p_gizmo) {
  423. #ifdef TOOLS_ENABLED
  424. if (data.gizmos_disabled || p_gizmo.is_null()) {
  425. return;
  426. }
  427. data.gizmos.push_back(p_gizmo);
  428. if (p_gizmo.is_valid() && is_inside_world()) {
  429. p_gizmo->create();
  430. if (is_visible_in_tree()) {
  431. p_gizmo->redraw();
  432. }
  433. p_gizmo->transform();
  434. }
  435. #endif
  436. }
  437. void Node3D::remove_gizmo(Ref<Node3DGizmo> p_gizmo) {
  438. #ifdef TOOLS_ENABLED
  439. int idx = data.gizmos.find(p_gizmo);
  440. if (idx != -1) {
  441. p_gizmo->free();
  442. data.gizmos.remove_at(idx);
  443. }
  444. #endif
  445. }
  446. void Node3D::clear_gizmos() {
  447. #ifdef TOOLS_ENABLED
  448. for (int i = 0; i < data.gizmos.size(); i++) {
  449. data.gizmos.write[i]->free();
  450. }
  451. data.gizmos.clear();
  452. #endif
  453. }
  454. TypedArray<Node3DGizmo> Node3D::get_gizmos_bind() const {
  455. TypedArray<Node3DGizmo> ret;
  456. #ifdef TOOLS_ENABLED
  457. for (int i = 0; i < data.gizmos.size(); i++) {
  458. ret.push_back(Variant(data.gizmos[i].ptr()));
  459. }
  460. #endif
  461. return ret;
  462. }
  463. Vector<Ref<Node3DGizmo>> Node3D::get_gizmos() const {
  464. #ifdef TOOLS_ENABLED
  465. return data.gizmos;
  466. #else
  467. return Vector<Ref<Node3DGizmo>>();
  468. #endif
  469. }
  470. void Node3D::_update_gizmos() {
  471. #ifdef TOOLS_ENABLED
  472. if (data.gizmos_disabled || !is_inside_world() || !data.gizmos_dirty) {
  473. data.gizmos_dirty = false;
  474. return;
  475. }
  476. data.gizmos_dirty = false;
  477. for (int i = 0; i < data.gizmos.size(); i++) {
  478. if (is_visible_in_tree()) {
  479. data.gizmos.write[i]->redraw();
  480. } else {
  481. data.gizmos.write[i]->clear();
  482. }
  483. }
  484. #endif
  485. }
  486. void Node3D::set_disable_gizmos(bool p_enabled) {
  487. #ifdef TOOLS_ENABLED
  488. data.gizmos_disabled = p_enabled;
  489. if (!p_enabled) {
  490. clear_gizmos();
  491. }
  492. #endif
  493. }
  494. void Node3D::set_disable_scale(bool p_enabled) {
  495. data.disable_scale = p_enabled;
  496. }
  497. bool Node3D::is_scale_disabled() const {
  498. return data.disable_scale;
  499. }
  500. void Node3D::set_as_top_level(bool p_enabled) {
  501. if (data.top_level == p_enabled) {
  502. return;
  503. }
  504. if (is_inside_tree() && !Engine::get_singleton()->is_editor_hint()) {
  505. if (p_enabled) {
  506. set_transform(get_global_transform());
  507. } else if (data.parent) {
  508. set_transform(data.parent->get_global_transform().affine_inverse() * get_global_transform());
  509. }
  510. data.top_level = p_enabled;
  511. data.top_level_active = p_enabled;
  512. } else {
  513. data.top_level = p_enabled;
  514. }
  515. }
  516. bool Node3D::is_set_as_top_level() const {
  517. return data.top_level;
  518. }
  519. Ref<World3D> Node3D::get_world_3d() const {
  520. ERR_FAIL_COND_V(!is_inside_world(), Ref<World3D>());
  521. ERR_FAIL_COND_V(!data.viewport, Ref<World3D>());
  522. return data.viewport->find_world_3d();
  523. }
  524. void Node3D::_propagate_visibility_changed() {
  525. notification(NOTIFICATION_VISIBILITY_CHANGED);
  526. emit_signal(SceneStringNames::get_singleton()->visibility_changed);
  527. #ifdef TOOLS_ENABLED
  528. if (!data.gizmos.is_empty()) {
  529. data.gizmos_dirty = true;
  530. _update_gizmos();
  531. }
  532. #endif
  533. for (Node3D *c : data.children) {
  534. if (!c || !c->data.visible) {
  535. continue;
  536. }
  537. c->_propagate_visibility_changed();
  538. }
  539. }
  540. void Node3D::show() {
  541. set_visible(true);
  542. }
  543. void Node3D::hide() {
  544. set_visible(false);
  545. }
  546. void Node3D::set_visible(bool p_visible) {
  547. if (data.visible == p_visible) {
  548. return;
  549. }
  550. data.visible = p_visible;
  551. if (!is_inside_tree()) {
  552. return;
  553. }
  554. _propagate_visibility_changed();
  555. }
  556. bool Node3D::is_visible() const {
  557. return data.visible;
  558. }
  559. bool Node3D::is_visible_in_tree() const {
  560. const Node3D *s = this;
  561. while (s) {
  562. if (!s->data.visible) {
  563. return false;
  564. }
  565. s = s->data.parent;
  566. }
  567. return true;
  568. }
  569. void Node3D::rotate_object_local(const Vector3 &p_axis, real_t p_angle) {
  570. Transform3D t = get_transform();
  571. t.basis.rotate_local(p_axis, p_angle);
  572. set_transform(t);
  573. }
  574. void Node3D::rotate(const Vector3 &p_axis, real_t p_angle) {
  575. Transform3D t = get_transform();
  576. t.basis.rotate(p_axis, p_angle);
  577. set_transform(t);
  578. }
  579. void Node3D::rotate_x(real_t p_angle) {
  580. Transform3D t = get_transform();
  581. t.basis.rotate(Vector3(1, 0, 0), p_angle);
  582. set_transform(t);
  583. }
  584. void Node3D::rotate_y(real_t p_angle) {
  585. Transform3D t = get_transform();
  586. t.basis.rotate(Vector3(0, 1, 0), p_angle);
  587. set_transform(t);
  588. }
  589. void Node3D::rotate_z(real_t p_angle) {
  590. Transform3D t = get_transform();
  591. t.basis.rotate(Vector3(0, 0, 1), p_angle);
  592. set_transform(t);
  593. }
  594. void Node3D::translate(const Vector3 &p_offset) {
  595. Transform3D t = get_transform();
  596. t.translate_local(p_offset);
  597. set_transform(t);
  598. }
  599. void Node3D::translate_object_local(const Vector3 &p_offset) {
  600. Transform3D t = get_transform();
  601. Transform3D s;
  602. s.translate_local(p_offset);
  603. set_transform(t * s);
  604. }
  605. void Node3D::scale(const Vector3 &p_ratio) {
  606. Transform3D t = get_transform();
  607. t.basis.scale(p_ratio);
  608. set_transform(t);
  609. }
  610. void Node3D::scale_object_local(const Vector3 &p_scale) {
  611. Transform3D t = get_transform();
  612. t.basis.scale_local(p_scale);
  613. set_transform(t);
  614. }
  615. void Node3D::global_rotate(const Vector3 &p_axis, real_t p_angle) {
  616. Transform3D t = get_global_transform();
  617. t.basis.rotate(p_axis, p_angle);
  618. set_global_transform(t);
  619. }
  620. void Node3D::global_scale(const Vector3 &p_scale) {
  621. Transform3D t = get_global_transform();
  622. t.basis.scale(p_scale);
  623. set_global_transform(t);
  624. }
  625. void Node3D::global_translate(const Vector3 &p_offset) {
  626. Transform3D t = get_global_transform();
  627. t.origin += p_offset;
  628. set_global_transform(t);
  629. }
  630. void Node3D::orthonormalize() {
  631. Transform3D t = get_transform();
  632. t.orthonormalize();
  633. set_transform(t);
  634. }
  635. void Node3D::set_identity() {
  636. set_transform(Transform3D());
  637. }
  638. void Node3D::look_at(const Vector3 &p_target, const Vector3 &p_up) {
  639. Vector3 origin = get_global_transform().origin;
  640. look_at_from_position(origin, p_target, p_up);
  641. }
  642. void Node3D::look_at_from_position(const Vector3 &p_pos, const Vector3 &p_target, const Vector3 &p_up) {
  643. ERR_FAIL_COND_MSG(p_pos.is_equal_approx(p_target), "Node origin and target are in the same position, look_at() failed.");
  644. ERR_FAIL_COND_MSG(p_up.is_equal_approx(Vector3()), "The up vector can't be zero, look_at() failed.");
  645. ERR_FAIL_COND_MSG(p_up.cross(p_target - p_pos).is_equal_approx(Vector3()), "Up vector and direction between node origin and target are aligned, look_at() failed.");
  646. Transform3D lookat = Transform3D(Basis::looking_at(p_target - p_pos, p_up), p_pos);
  647. Vector3 original_scale = get_scale();
  648. set_global_transform(lookat);
  649. set_scale(original_scale);
  650. }
  651. Vector3 Node3D::to_local(Vector3 p_global) const {
  652. return get_global_transform().affine_inverse().xform(p_global);
  653. }
  654. Vector3 Node3D::to_global(Vector3 p_local) const {
  655. return get_global_transform().xform(p_local);
  656. }
  657. void Node3D::set_notify_transform(bool p_enabled) {
  658. data.notify_transform = p_enabled;
  659. }
  660. bool Node3D::is_transform_notification_enabled() const {
  661. return data.notify_transform;
  662. }
  663. void Node3D::set_notify_local_transform(bool p_enabled) {
  664. data.notify_local_transform = p_enabled;
  665. }
  666. bool Node3D::is_local_transform_notification_enabled() const {
  667. return data.notify_local_transform;
  668. }
  669. void Node3D::force_update_transform() {
  670. ERR_FAIL_COND(!is_inside_tree());
  671. if (!xform_change.in_list()) {
  672. return; //nothing to update
  673. }
  674. get_tree()->xform_change_list.remove(&xform_change);
  675. notification(NOTIFICATION_TRANSFORM_CHANGED);
  676. }
  677. void Node3D::_update_visibility_parent(bool p_update_root) {
  678. RID new_parent;
  679. if (!visibility_parent_path.is_empty()) {
  680. if (!p_update_root) {
  681. return;
  682. }
  683. Node *parent = get_node_or_null(visibility_parent_path);
  684. ERR_FAIL_COND_MSG(!parent, "Can't find visibility parent node at path: " + visibility_parent_path);
  685. ERR_FAIL_COND_MSG(parent == this, "The visibility parent can't be the same node.");
  686. GeometryInstance3D *gi = Object::cast_to<GeometryInstance3D>(parent);
  687. ERR_FAIL_COND_MSG(!gi, "The visibility parent node must be a GeometryInstance3D, at path: " + visibility_parent_path);
  688. new_parent = gi ? gi->get_instance() : RID();
  689. } else if (data.parent) {
  690. new_parent = data.parent->data.visibility_parent;
  691. }
  692. if (new_parent == data.visibility_parent) {
  693. return;
  694. }
  695. data.visibility_parent = new_parent;
  696. VisualInstance3D *vi = Object::cast_to<VisualInstance3D>(this);
  697. if (vi) {
  698. RS::get_singleton()->instance_set_visibility_parent(vi->get_instance(), data.visibility_parent);
  699. }
  700. for (Node3D *c : data.children) {
  701. c->_update_visibility_parent(false);
  702. }
  703. }
  704. void Node3D::set_visibility_parent(const NodePath &p_path) {
  705. visibility_parent_path = p_path;
  706. if (is_inside_tree()) {
  707. _update_visibility_parent(true);
  708. }
  709. }
  710. NodePath Node3D::get_visibility_parent() const {
  711. return visibility_parent_path;
  712. }
  713. void Node3D::_validate_property(PropertyInfo &p_property) const {
  714. if (data.rotation_edit_mode != ROTATION_EDIT_MODE_BASIS && p_property.name == "basis") {
  715. p_property.usage = 0;
  716. }
  717. if (data.rotation_edit_mode == ROTATION_EDIT_MODE_BASIS && p_property.name == "scale") {
  718. p_property.usage = 0;
  719. }
  720. if (data.rotation_edit_mode != ROTATION_EDIT_MODE_QUATERNION && p_property.name == "quaternion") {
  721. p_property.usage = 0;
  722. }
  723. if (data.rotation_edit_mode != ROTATION_EDIT_MODE_EULER && p_property.name == "rotation") {
  724. p_property.usage = 0;
  725. }
  726. if (data.rotation_edit_mode != ROTATION_EDIT_MODE_EULER && p_property.name == "rotation_order") {
  727. p_property.usage = 0;
  728. }
  729. }
  730. bool Node3D::_property_can_revert(const StringName &p_name) const {
  731. if (p_name == "basis") {
  732. return true;
  733. } else if (p_name == "scale") {
  734. return true;
  735. } else if (p_name == "quaternion") {
  736. return true;
  737. } else if (p_name == "rotation") {
  738. return true;
  739. } else if (p_name == "position") {
  740. return true;
  741. }
  742. return false;
  743. }
  744. bool Node3D::_property_get_revert(const StringName &p_name, Variant &r_property) const {
  745. bool valid = false;
  746. if (p_name == "basis") {
  747. Variant variant = PropertyUtils::get_property_default_value(this, "transform", &valid);
  748. if (valid && variant.get_type() == Variant::Type::TRANSFORM3D) {
  749. r_property = Transform3D(variant).get_basis();
  750. } else {
  751. r_property = Basis();
  752. }
  753. } else if (p_name == "scale") {
  754. Variant variant = PropertyUtils::get_property_default_value(this, "transform", &valid);
  755. if (valid && variant.get_type() == Variant::Type::TRANSFORM3D) {
  756. r_property = Transform3D(variant).get_basis().get_scale();
  757. } else {
  758. r_property = Vector3(1.0, 1.0, 1.0);
  759. }
  760. } else if (p_name == "quaternion") {
  761. Variant variant = PropertyUtils::get_property_default_value(this, "transform", &valid);
  762. if (valid && variant.get_type() == Variant::Type::TRANSFORM3D) {
  763. r_property = Quaternion(Transform3D(variant).get_basis().get_rotation_quaternion());
  764. } else {
  765. r_property = Quaternion();
  766. }
  767. } else if (p_name == "rotation") {
  768. Variant variant = PropertyUtils::get_property_default_value(this, "transform", &valid);
  769. if (valid && variant.get_type() == Variant::Type::TRANSFORM3D) {
  770. r_property = Transform3D(variant).get_basis().get_euler_normalized(data.euler_rotation_order);
  771. } else {
  772. r_property = Vector3();
  773. }
  774. } else if (p_name == "position") {
  775. Variant variant = PropertyUtils::get_property_default_value(this, "transform", &valid);
  776. if (valid) {
  777. r_property = Transform3D(variant).get_origin();
  778. } else {
  779. r_property = Vector3();
  780. }
  781. } else {
  782. return false;
  783. }
  784. return true;
  785. }
  786. void Node3D::_bind_methods() {
  787. ClassDB::bind_method(D_METHOD("set_transform", "local"), &Node3D::set_transform);
  788. ClassDB::bind_method(D_METHOD("get_transform"), &Node3D::get_transform);
  789. ClassDB::bind_method(D_METHOD("set_position", "position"), &Node3D::set_position);
  790. ClassDB::bind_method(D_METHOD("get_position"), &Node3D::get_position);
  791. ClassDB::bind_method(D_METHOD("set_rotation", "euler"), &Node3D::set_rotation);
  792. ClassDB::bind_method(D_METHOD("get_rotation"), &Node3D::get_rotation);
  793. ClassDB::bind_method(D_METHOD("set_rotation_order", "order"), &Node3D::set_rotation_order);
  794. ClassDB::bind_method(D_METHOD("get_rotation_order"), &Node3D::get_rotation_order);
  795. ClassDB::bind_method(D_METHOD("set_rotation_edit_mode", "edit_mode"), &Node3D::set_rotation_edit_mode);
  796. ClassDB::bind_method(D_METHOD("get_rotation_edit_mode"), &Node3D::get_rotation_edit_mode);
  797. ClassDB::bind_method(D_METHOD("set_scale", "scale"), &Node3D::set_scale);
  798. ClassDB::bind_method(D_METHOD("get_scale"), &Node3D::get_scale);
  799. ClassDB::bind_method(D_METHOD("set_quaternion", "quaternion"), &Node3D::set_quaternion);
  800. ClassDB::bind_method(D_METHOD("get_quaternion"), &Node3D::get_quaternion);
  801. ClassDB::bind_method(D_METHOD("set_basis", "basis"), &Node3D::set_basis);
  802. ClassDB::bind_method(D_METHOD("get_basis"), &Node3D::get_basis);
  803. ClassDB::bind_method(D_METHOD("set_global_transform", "global"), &Node3D::set_global_transform);
  804. ClassDB::bind_method(D_METHOD("get_global_transform"), &Node3D::get_global_transform);
  805. ClassDB::bind_method(D_METHOD("set_global_position", "position"), &Node3D::set_global_position);
  806. ClassDB::bind_method(D_METHOD("get_global_position"), &Node3D::get_global_position);
  807. ClassDB::bind_method(D_METHOD("set_global_rotation", "radians"), &Node3D::set_global_rotation);
  808. ClassDB::bind_method(D_METHOD("get_global_rotation"), &Node3D::get_global_rotation);
  809. ClassDB::bind_method(D_METHOD("get_parent_node_3d"), &Node3D::get_parent_node_3d);
  810. ClassDB::bind_method(D_METHOD("set_ignore_transform_notification", "enabled"), &Node3D::set_ignore_transform_notification);
  811. ClassDB::bind_method(D_METHOD("set_as_top_level", "enable"), &Node3D::set_as_top_level);
  812. ClassDB::bind_method(D_METHOD("is_set_as_top_level"), &Node3D::is_set_as_top_level);
  813. ClassDB::bind_method(D_METHOD("set_disable_scale", "disable"), &Node3D::set_disable_scale);
  814. ClassDB::bind_method(D_METHOD("is_scale_disabled"), &Node3D::is_scale_disabled);
  815. ClassDB::bind_method(D_METHOD("get_world_3d"), &Node3D::get_world_3d);
  816. ClassDB::bind_method(D_METHOD("force_update_transform"), &Node3D::force_update_transform);
  817. ClassDB::bind_method(D_METHOD("set_visibility_parent", "path"), &Node3D::set_visibility_parent);
  818. ClassDB::bind_method(D_METHOD("get_visibility_parent"), &Node3D::get_visibility_parent);
  819. ClassDB::bind_method(D_METHOD("update_gizmos"), &Node3D::update_gizmos);
  820. ClassDB::bind_method(D_METHOD("add_gizmo", "gizmo"), &Node3D::add_gizmo);
  821. ClassDB::bind_method(D_METHOD("get_gizmos"), &Node3D::get_gizmos_bind);
  822. ClassDB::bind_method(D_METHOD("clear_gizmos"), &Node3D::clear_gizmos);
  823. ClassDB::bind_method(D_METHOD("set_subgizmo_selection", "gizmo", "id", "transform"), &Node3D::set_subgizmo_selection);
  824. ClassDB::bind_method(D_METHOD("clear_subgizmo_selection"), &Node3D::clear_subgizmo_selection);
  825. ClassDB::bind_method(D_METHOD("set_visible", "visible"), &Node3D::set_visible);
  826. ClassDB::bind_method(D_METHOD("is_visible"), &Node3D::is_visible);
  827. ClassDB::bind_method(D_METHOD("is_visible_in_tree"), &Node3D::is_visible_in_tree);
  828. ClassDB::bind_method(D_METHOD("show"), &Node3D::show);
  829. ClassDB::bind_method(D_METHOD("hide"), &Node3D::hide);
  830. ClassDB::bind_method(D_METHOD("set_notify_local_transform", "enable"), &Node3D::set_notify_local_transform);
  831. ClassDB::bind_method(D_METHOD("is_local_transform_notification_enabled"), &Node3D::is_local_transform_notification_enabled);
  832. ClassDB::bind_method(D_METHOD("set_notify_transform", "enable"), &Node3D::set_notify_transform);
  833. ClassDB::bind_method(D_METHOD("is_transform_notification_enabled"), &Node3D::is_transform_notification_enabled);
  834. ClassDB::bind_method(D_METHOD("rotate", "axis", "angle"), &Node3D::rotate);
  835. ClassDB::bind_method(D_METHOD("global_rotate", "axis", "angle"), &Node3D::global_rotate);
  836. ClassDB::bind_method(D_METHOD("global_scale", "scale"), &Node3D::global_scale);
  837. ClassDB::bind_method(D_METHOD("global_translate", "offset"), &Node3D::global_translate);
  838. ClassDB::bind_method(D_METHOD("rotate_object_local", "axis", "angle"), &Node3D::rotate_object_local);
  839. ClassDB::bind_method(D_METHOD("scale_object_local", "scale"), &Node3D::scale_object_local);
  840. ClassDB::bind_method(D_METHOD("translate_object_local", "offset"), &Node3D::translate_object_local);
  841. ClassDB::bind_method(D_METHOD("rotate_x", "angle"), &Node3D::rotate_x);
  842. ClassDB::bind_method(D_METHOD("rotate_y", "angle"), &Node3D::rotate_y);
  843. ClassDB::bind_method(D_METHOD("rotate_z", "angle"), &Node3D::rotate_z);
  844. ClassDB::bind_method(D_METHOD("translate", "offset"), &Node3D::translate);
  845. ClassDB::bind_method(D_METHOD("orthonormalize"), &Node3D::orthonormalize);
  846. ClassDB::bind_method(D_METHOD("set_identity"), &Node3D::set_identity);
  847. ClassDB::bind_method(D_METHOD("look_at", "target", "up"), &Node3D::look_at, DEFVAL(Vector3(0, 1, 0)));
  848. ClassDB::bind_method(D_METHOD("look_at_from_position", "position", "target", "up"), &Node3D::look_at_from_position, DEFVAL(Vector3(0, 1, 0)));
  849. ClassDB::bind_method(D_METHOD("to_local", "global_point"), &Node3D::to_local);
  850. ClassDB::bind_method(D_METHOD("to_global", "local_point"), &Node3D::to_global);
  851. BIND_CONSTANT(NOTIFICATION_TRANSFORM_CHANGED);
  852. BIND_CONSTANT(NOTIFICATION_ENTER_WORLD);
  853. BIND_CONSTANT(NOTIFICATION_EXIT_WORLD);
  854. BIND_CONSTANT(NOTIFICATION_VISIBILITY_CHANGED);
  855. BIND_ENUM_CONSTANT(ROTATION_EDIT_MODE_EULER);
  856. BIND_ENUM_CONSTANT(ROTATION_EDIT_MODE_QUATERNION);
  857. BIND_ENUM_CONSTANT(ROTATION_EDIT_MODE_BASIS);
  858. BIND_ENUM_CONSTANT(ROTATION_ORDER_XYZ);
  859. BIND_ENUM_CONSTANT(ROTATION_ORDER_XZY);
  860. BIND_ENUM_CONSTANT(ROTATION_ORDER_YXZ);
  861. BIND_ENUM_CONSTANT(ROTATION_ORDER_YZX);
  862. BIND_ENUM_CONSTANT(ROTATION_ORDER_ZXY);
  863. BIND_ENUM_CONSTANT(ROTATION_ORDER_ZYX);
  864. ADD_GROUP("Transform", "");
  865. ADD_PROPERTY(PropertyInfo(Variant::TRANSFORM3D, "transform", PROPERTY_HINT_NONE, "suffix:m", PROPERTY_USAGE_NO_EDITOR), "set_transform", "get_transform");
  866. ADD_PROPERTY(PropertyInfo(Variant::TRANSFORM3D, "global_transform", PROPERTY_HINT_NONE, "suffix:m", PROPERTY_USAGE_NONE), "set_global_transform", "get_global_transform");
  867. ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, "position", PROPERTY_HINT_RANGE, "-99999,99999,0.001,or_greater,or_lesser,no_slider,suffix:m", PROPERTY_USAGE_EDITOR), "set_position", "get_position");
  868. ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, "rotation", PROPERTY_HINT_RANGE, "-360,360,0.1,or_lesser,or_greater,radians", PROPERTY_USAGE_EDITOR), "set_rotation", "get_rotation");
  869. ADD_PROPERTY(PropertyInfo(Variant::QUATERNION, "quaternion", PROPERTY_HINT_HIDE_QUATERNION_EDIT, "", PROPERTY_USAGE_EDITOR), "set_quaternion", "get_quaternion");
  870. ADD_PROPERTY(PropertyInfo(Variant::BASIS, "basis", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_EDITOR), "set_basis", "get_basis");
  871. ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, "scale", PROPERTY_HINT_LINK, "", PROPERTY_USAGE_EDITOR), "set_scale", "get_scale");
  872. ADD_PROPERTY(PropertyInfo(Variant::INT, "rotation_edit_mode", PROPERTY_HINT_ENUM, "Euler,Quaternion,Basis"), "set_rotation_edit_mode", "get_rotation_edit_mode");
  873. ADD_PROPERTY(PropertyInfo(Variant::INT, "rotation_order", PROPERTY_HINT_ENUM, "XYZ,XZY,YXZ,YZX,ZXY,ZYX"), "set_rotation_order", "get_rotation_order");
  874. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "top_level"), "set_as_top_level", "is_set_as_top_level");
  875. ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, "global_position", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_global_position", "get_global_position");
  876. ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, "global_rotation", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_global_rotation", "get_global_rotation");
  877. ADD_GROUP("Visibility", "");
  878. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "visible"), "set_visible", "is_visible");
  879. ADD_PROPERTY(PropertyInfo(Variant::NODE_PATH, "visibility_parent", PROPERTY_HINT_NODE_PATH_VALID_TYPES, "GeometryInstance3D"), "set_visibility_parent", "get_visibility_parent");
  880. ADD_SIGNAL(MethodInfo("visibility_changed"));
  881. }
  882. Node3D::Node3D() :
  883. xform_change(this) {}