gpu_particles_2d.cpp 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895
  1. /**************************************************************************/
  2. /* gpu_particles_2d.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 "gpu_particles_2d.h"
  31. #include "scene/2d/cpu_particles_2d.h"
  32. #include "scene/resources/atlas_texture.h"
  33. #include "scene/resources/canvas_item_material.h"
  34. #include "scene/resources/curve_texture.h"
  35. #include "scene/resources/gradient_texture.h"
  36. #include "scene/resources/particle_process_material.h"
  37. void GPUParticles2D::set_emitting(bool p_emitting) {
  38. // Do not return even if `p_emitting == emitting` because `emitting` is just an approximation.
  39. if (p_emitting && one_shot) {
  40. if (!active && !emitting) {
  41. // Last cycle ended.
  42. active = true;
  43. time = 0;
  44. signal_canceled = false;
  45. emission_time = lifetime;
  46. active_time = lifetime * (2 - explosiveness_ratio);
  47. } else {
  48. signal_canceled = true;
  49. }
  50. set_process_internal(true);
  51. } else if (!p_emitting) {
  52. if (one_shot) {
  53. set_process_internal(true);
  54. } else {
  55. set_process_internal(false);
  56. }
  57. }
  58. emitting = p_emitting;
  59. RS::get_singleton()->particles_set_emitting(particles, p_emitting);
  60. }
  61. void GPUParticles2D::set_amount(int p_amount) {
  62. ERR_FAIL_COND_MSG(p_amount < 1, "Amount of particles cannot be smaller than 1.");
  63. amount = p_amount;
  64. RS::get_singleton()->particles_set_amount(particles, amount);
  65. }
  66. void GPUParticles2D::set_lifetime(double p_lifetime) {
  67. ERR_FAIL_COND_MSG(p_lifetime <= 0, "Particles lifetime must be greater than 0.");
  68. lifetime = p_lifetime;
  69. RS::get_singleton()->particles_set_lifetime(particles, lifetime);
  70. }
  71. void GPUParticles2D::set_one_shot(bool p_enable) {
  72. one_shot = p_enable;
  73. RS::get_singleton()->particles_set_one_shot(particles, one_shot);
  74. if (is_emitting()) {
  75. set_process_internal(true);
  76. if (!one_shot) {
  77. RenderingServer::get_singleton()->particles_restart(particles);
  78. }
  79. }
  80. if (!one_shot) {
  81. set_process_internal(false);
  82. }
  83. }
  84. void GPUParticles2D::set_pre_process_time(double p_time) {
  85. pre_process_time = p_time;
  86. RS::get_singleton()->particles_set_pre_process_time(particles, pre_process_time);
  87. }
  88. void GPUParticles2D::set_explosiveness_ratio(real_t p_ratio) {
  89. explosiveness_ratio = p_ratio;
  90. RS::get_singleton()->particles_set_explosiveness_ratio(particles, explosiveness_ratio);
  91. }
  92. void GPUParticles2D::set_randomness_ratio(real_t p_ratio) {
  93. randomness_ratio = p_ratio;
  94. RS::get_singleton()->particles_set_randomness_ratio(particles, randomness_ratio);
  95. }
  96. void GPUParticles2D::set_visibility_rect(const Rect2 &p_visibility_rect) {
  97. visibility_rect = p_visibility_rect;
  98. AABB aabb;
  99. aabb.position.x = p_visibility_rect.position.x;
  100. aabb.position.y = p_visibility_rect.position.y;
  101. aabb.size.x = p_visibility_rect.size.x;
  102. aabb.size.y = p_visibility_rect.size.y;
  103. RS::get_singleton()->particles_set_custom_aabb(particles, aabb);
  104. queue_redraw();
  105. }
  106. void GPUParticles2D::set_use_local_coordinates(bool p_enable) {
  107. local_coords = p_enable;
  108. RS::get_singleton()->particles_set_use_local_coordinates(particles, local_coords);
  109. set_notify_transform(!p_enable);
  110. if (!p_enable && is_inside_tree()) {
  111. _update_particle_emission_transform();
  112. }
  113. }
  114. void GPUParticles2D::_update_particle_emission_transform() {
  115. Transform2D xf2d = get_global_transform();
  116. Transform3D xf;
  117. xf.basis.set_column(0, Vector3(xf2d.columns[0].x, xf2d.columns[0].y, 0));
  118. xf.basis.set_column(1, Vector3(xf2d.columns[1].x, xf2d.columns[1].y, 0));
  119. xf.set_origin(Vector3(xf2d.get_origin().x, xf2d.get_origin().y, 0));
  120. RS::get_singleton()->particles_set_emission_transform(particles, xf);
  121. }
  122. void GPUParticles2D::set_process_material(const Ref<Material> &p_material) {
  123. process_material = p_material;
  124. Ref<ParticleProcessMaterial> pm = p_material;
  125. if (pm.is_valid() && !pm->get_particle_flag(ParticleProcessMaterial::PARTICLE_FLAG_DISABLE_Z) && pm->get_gravity() == Vector3(0, -9.8, 0)) {
  126. // Likely a new (3D) material, modify it to match 2D space
  127. pm->set_particle_flag(ParticleProcessMaterial::PARTICLE_FLAG_DISABLE_Z, true);
  128. pm->set_gravity(Vector3(0, 98, 0));
  129. }
  130. RID material_rid;
  131. if (process_material.is_valid()) {
  132. material_rid = process_material->get_rid();
  133. }
  134. RS::get_singleton()->particles_set_process_material(particles, material_rid);
  135. update_configuration_warnings();
  136. }
  137. void GPUParticles2D::set_trail_enabled(bool p_enabled) {
  138. trail_enabled = p_enabled;
  139. RS::get_singleton()->particles_set_trails(particles, trail_enabled, trail_lifetime);
  140. queue_redraw();
  141. update_configuration_warnings();
  142. RS::get_singleton()->particles_set_transform_align(particles, p_enabled ? RS::PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY : RS::PARTICLES_TRANSFORM_ALIGN_DISABLED);
  143. }
  144. void GPUParticles2D::set_trail_lifetime(double p_seconds) {
  145. ERR_FAIL_COND(p_seconds < 0.01);
  146. trail_lifetime = p_seconds;
  147. RS::get_singleton()->particles_set_trails(particles, trail_enabled, trail_lifetime);
  148. queue_redraw();
  149. }
  150. void GPUParticles2D::set_trail_sections(int p_sections) {
  151. ERR_FAIL_COND(p_sections < 2);
  152. ERR_FAIL_COND(p_sections > 128);
  153. trail_sections = p_sections;
  154. queue_redraw();
  155. }
  156. void GPUParticles2D::set_trail_section_subdivisions(int p_subdivisions) {
  157. ERR_FAIL_COND(p_subdivisions < 1);
  158. ERR_FAIL_COND(p_subdivisions > 1024);
  159. trail_section_subdivisions = p_subdivisions;
  160. queue_redraw();
  161. }
  162. void GPUParticles2D::set_interp_to_end(float p_interp) {
  163. interp_to_end_factor = CLAMP(p_interp, 0.0, 1.0);
  164. RS::get_singleton()->particles_set_interp_to_end(particles, interp_to_end_factor);
  165. }
  166. #ifdef TOOLS_ENABLED
  167. void GPUParticles2D::set_show_visibility_rect(bool p_show_visibility_rect) {
  168. show_visibility_rect = p_show_visibility_rect;
  169. queue_redraw();
  170. }
  171. #endif
  172. bool GPUParticles2D::is_trail_enabled() const {
  173. return trail_enabled;
  174. }
  175. double GPUParticles2D::get_trail_lifetime() const {
  176. return trail_lifetime;
  177. }
  178. void GPUParticles2D::_update_collision_size() {
  179. real_t csize = collision_base_size;
  180. if (texture.is_valid()) {
  181. csize *= (texture->get_width() + texture->get_height()) / 4.0; //half size since its a radius
  182. }
  183. RS::get_singleton()->particles_set_collision_base_size(particles, csize);
  184. }
  185. void GPUParticles2D::set_collision_base_size(real_t p_size) {
  186. collision_base_size = p_size;
  187. _update_collision_size();
  188. }
  189. real_t GPUParticles2D::get_collision_base_size() const {
  190. return collision_base_size;
  191. }
  192. void GPUParticles2D::set_speed_scale(double p_scale) {
  193. speed_scale = p_scale;
  194. RS::get_singleton()->particles_set_speed_scale(particles, p_scale);
  195. }
  196. bool GPUParticles2D::is_emitting() const {
  197. return emitting;
  198. }
  199. int GPUParticles2D::get_amount() const {
  200. return amount;
  201. }
  202. double GPUParticles2D::get_lifetime() const {
  203. return lifetime;
  204. }
  205. int GPUParticles2D::get_trail_sections() const {
  206. return trail_sections;
  207. }
  208. int GPUParticles2D::get_trail_section_subdivisions() const {
  209. return trail_section_subdivisions;
  210. }
  211. bool GPUParticles2D::get_one_shot() const {
  212. return one_shot;
  213. }
  214. double GPUParticles2D::get_pre_process_time() const {
  215. return pre_process_time;
  216. }
  217. real_t GPUParticles2D::get_explosiveness_ratio() const {
  218. return explosiveness_ratio;
  219. }
  220. real_t GPUParticles2D::get_randomness_ratio() const {
  221. return randomness_ratio;
  222. }
  223. Rect2 GPUParticles2D::get_visibility_rect() const {
  224. return visibility_rect;
  225. }
  226. bool GPUParticles2D::get_use_local_coordinates() const {
  227. return local_coords;
  228. }
  229. Ref<Material> GPUParticles2D::get_process_material() const {
  230. return process_material;
  231. }
  232. double GPUParticles2D::get_speed_scale() const {
  233. return speed_scale;
  234. }
  235. void GPUParticles2D::set_draw_order(DrawOrder p_order) {
  236. draw_order = p_order;
  237. RS::get_singleton()->particles_set_draw_order(particles, RS::ParticlesDrawOrder(p_order));
  238. }
  239. GPUParticles2D::DrawOrder GPUParticles2D::get_draw_order() const {
  240. return draw_order;
  241. }
  242. void GPUParticles2D::set_fixed_fps(int p_count) {
  243. fixed_fps = p_count;
  244. RS::get_singleton()->particles_set_fixed_fps(particles, p_count);
  245. }
  246. int GPUParticles2D::get_fixed_fps() const {
  247. return fixed_fps;
  248. }
  249. void GPUParticles2D::set_fractional_delta(bool p_enable) {
  250. fractional_delta = p_enable;
  251. RS::get_singleton()->particles_set_fractional_delta(particles, p_enable);
  252. }
  253. bool GPUParticles2D::get_fractional_delta() const {
  254. return fractional_delta;
  255. }
  256. void GPUParticles2D::set_interpolate(bool p_enable) {
  257. interpolate = p_enable;
  258. RS::get_singleton()->particles_set_interpolate(particles, p_enable);
  259. }
  260. bool GPUParticles2D::get_interpolate() const {
  261. return interpolate;
  262. }
  263. float GPUParticles2D::get_interp_to_end() const {
  264. return interp_to_end_factor;
  265. }
  266. PackedStringArray GPUParticles2D::get_configuration_warnings() const {
  267. PackedStringArray warnings = Node2D::get_configuration_warnings();
  268. if (process_material.is_null()) {
  269. warnings.push_back(RTR("A material to process the particles is not assigned, so no behavior is imprinted."));
  270. } else {
  271. CanvasItemMaterial *mat = Object::cast_to<CanvasItemMaterial>(get_material().ptr());
  272. if (get_material().is_null() || (mat && !mat->get_particles_animation())) {
  273. const ParticleProcessMaterial *process = Object::cast_to<ParticleProcessMaterial>(process_material.ptr());
  274. if (process &&
  275. (process->get_param_max(ParticleProcessMaterial::PARAM_ANIM_SPEED) != 0.0 || process->get_param_max(ParticleProcessMaterial::PARAM_ANIM_OFFSET) != 0.0 ||
  276. process->get_param_texture(ParticleProcessMaterial::PARAM_ANIM_SPEED).is_valid() || process->get_param_texture(ParticleProcessMaterial::PARAM_ANIM_OFFSET).is_valid())) {
  277. warnings.push_back(RTR("Particles2D animation requires the usage of a CanvasItemMaterial with \"Particles Animation\" enabled."));
  278. }
  279. }
  280. }
  281. if (trail_enabled && OS::get_singleton()->get_current_rendering_method() == "gl_compatibility") {
  282. warnings.push_back(RTR("Particle trails are only available when using the Forward+ or Mobile renderers."));
  283. }
  284. if (sub_emitter != NodePath() && OS::get_singleton()->get_current_rendering_method() == "gl_compatibility") {
  285. warnings.push_back(RTR("Particle sub-emitters are not available when using the Compatibility renderer."));
  286. }
  287. return warnings;
  288. }
  289. Rect2 GPUParticles2D::capture_rect() const {
  290. AABB aabb = RS::get_singleton()->particles_get_current_aabb(particles);
  291. Rect2 r;
  292. r.position.x = aabb.position.x;
  293. r.position.y = aabb.position.y;
  294. r.size.x = aabb.size.x;
  295. r.size.y = aabb.size.y;
  296. return r;
  297. }
  298. void GPUParticles2D::set_texture(const Ref<Texture2D> &p_texture) {
  299. if (texture.is_valid()) {
  300. texture->disconnect_changed(callable_mp(this, &GPUParticles2D::_texture_changed));
  301. }
  302. texture = p_texture;
  303. if (texture.is_valid()) {
  304. texture->connect_changed(callable_mp(this, &GPUParticles2D::_texture_changed));
  305. }
  306. _update_collision_size();
  307. queue_redraw();
  308. }
  309. Ref<Texture2D> GPUParticles2D::get_texture() const {
  310. return texture;
  311. }
  312. void GPUParticles2D::_validate_property(PropertyInfo &p_property) const {
  313. if (p_property.name == "emitting") {
  314. p_property.hint = one_shot ? PROPERTY_HINT_ONESHOT : PROPERTY_HINT_NONE;
  315. }
  316. }
  317. void GPUParticles2D::emit_particle(const Transform2D &p_transform2d, const Vector2 &p_velocity2d, const Color &p_color, const Color &p_custom, uint32_t p_emit_flags) {
  318. Transform3D emit_transform;
  319. emit_transform.basis.set_column(0, Vector3(p_transform2d.columns[0].x, p_transform2d.columns[0].y, 0));
  320. emit_transform.basis.set_column(1, Vector3(p_transform2d.columns[1].x, p_transform2d.columns[1].y, 0));
  321. emit_transform.set_origin(Vector3(p_transform2d.get_origin().x, p_transform2d.get_origin().y, 0));
  322. Vector3 velocity = Vector3(p_velocity2d.x, p_velocity2d.y, 0);
  323. RS::get_singleton()->particles_emit(particles, emit_transform, velocity, p_color, p_custom, p_emit_flags);
  324. }
  325. void GPUParticles2D::_attach_sub_emitter() {
  326. Node *n = get_node_or_null(sub_emitter);
  327. if (n) {
  328. GPUParticles2D *sen = Object::cast_to<GPUParticles2D>(n);
  329. if (sen && sen != this) {
  330. RS::get_singleton()->particles_set_subemitter(particles, sen->particles);
  331. }
  332. }
  333. }
  334. void GPUParticles2D::_texture_changed() {
  335. // Changes to the texture need to trigger an update to make
  336. // the editor redraw the sprite with the updated texture.
  337. if (texture.is_valid()) {
  338. queue_redraw();
  339. }
  340. }
  341. void GPUParticles2D::set_sub_emitter(const NodePath &p_path) {
  342. if (is_inside_tree()) {
  343. RS::get_singleton()->particles_set_subemitter(particles, RID());
  344. }
  345. sub_emitter = p_path;
  346. if (is_inside_tree() && sub_emitter != NodePath()) {
  347. _attach_sub_emitter();
  348. }
  349. update_configuration_warnings();
  350. }
  351. NodePath GPUParticles2D::get_sub_emitter() const {
  352. return sub_emitter;
  353. }
  354. void GPUParticles2D::set_amount_ratio(float p_ratio) {
  355. amount_ratio = p_ratio;
  356. RenderingServer::get_singleton()->particles_set_amount_ratio(particles, p_ratio);
  357. }
  358. float GPUParticles2D::get_amount_ratio() const {
  359. return amount_ratio;
  360. }
  361. void GPUParticles2D::restart() {
  362. RS::get_singleton()->particles_restart(particles);
  363. RS::get_singleton()->particles_set_emitting(particles, true);
  364. emitting = true;
  365. active = true;
  366. signal_canceled = false;
  367. time = 0;
  368. emission_time = lifetime;
  369. active_time = lifetime * (2 - explosiveness_ratio);
  370. if (one_shot) {
  371. set_process_internal(true);
  372. }
  373. }
  374. void GPUParticles2D::convert_from_particles(Node *p_particles) {
  375. CPUParticles2D *cpu_particles = Object::cast_to<CPUParticles2D>(p_particles);
  376. ERR_FAIL_NULL_MSG(cpu_particles, "Only CPUParticles2D nodes can be converted to GPUParticles2D.");
  377. set_emitting(cpu_particles->is_emitting());
  378. set_amount(cpu_particles->get_amount());
  379. set_lifetime(cpu_particles->get_lifetime());
  380. set_one_shot(cpu_particles->get_one_shot());
  381. set_pre_process_time(cpu_particles->get_pre_process_time());
  382. set_explosiveness_ratio(cpu_particles->get_explosiveness_ratio());
  383. set_randomness_ratio(cpu_particles->get_randomness_ratio());
  384. set_use_local_coordinates(cpu_particles->get_use_local_coordinates());
  385. set_fixed_fps(cpu_particles->get_fixed_fps());
  386. set_fractional_delta(cpu_particles->get_fractional_delta());
  387. set_speed_scale(cpu_particles->get_speed_scale());
  388. set_draw_order(DrawOrder(cpu_particles->get_draw_order()));
  389. set_texture(cpu_particles->get_texture());
  390. Ref<Material> mat = cpu_particles->get_material();
  391. if (mat.is_valid()) {
  392. set_material(mat);
  393. }
  394. Ref<ParticleProcessMaterial> proc_mat = memnew(ParticleProcessMaterial);
  395. set_process_material(proc_mat);
  396. Vector2 dir = cpu_particles->get_direction();
  397. proc_mat->set_direction(Vector3(dir.x, dir.y, 0));
  398. proc_mat->set_spread(cpu_particles->get_spread());
  399. proc_mat->set_color(cpu_particles->get_color());
  400. Ref<Gradient> color_grad = cpu_particles->get_color_ramp();
  401. if (color_grad.is_valid()) {
  402. Ref<GradientTexture1D> tex = memnew(GradientTexture1D);
  403. tex->set_gradient(color_grad);
  404. proc_mat->set_color_ramp(tex);
  405. }
  406. Ref<Gradient> color_init_grad = cpu_particles->get_color_initial_ramp();
  407. if (color_init_grad.is_valid()) {
  408. Ref<GradientTexture1D> tex = memnew(GradientTexture1D);
  409. tex->set_gradient(color_init_grad);
  410. proc_mat->set_color_initial_ramp(tex);
  411. }
  412. proc_mat->set_particle_flag(ParticleProcessMaterial::PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY, cpu_particles->get_particle_flag(CPUParticles2D::PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY));
  413. proc_mat->set_emission_shape(ParticleProcessMaterial::EmissionShape(cpu_particles->get_emission_shape()));
  414. proc_mat->set_emission_sphere_radius(cpu_particles->get_emission_sphere_radius());
  415. Vector2 rect_extents = cpu_particles->get_emission_rect_extents();
  416. proc_mat->set_emission_box_extents(Vector3(rect_extents.x, rect_extents.y, 0));
  417. if (cpu_particles->get_split_scale()) {
  418. Ref<CurveXYZTexture> scale3D = memnew(CurveXYZTexture);
  419. scale3D->set_curve_x(cpu_particles->get_scale_curve_x());
  420. scale3D->set_curve_y(cpu_particles->get_scale_curve_y());
  421. proc_mat->set_param_texture(ParticleProcessMaterial::PARAM_SCALE, scale3D);
  422. }
  423. Vector2 gravity = cpu_particles->get_gravity();
  424. proc_mat->set_gravity(Vector3(gravity.x, gravity.y, 0));
  425. proc_mat->set_lifetime_randomness(cpu_particles->get_lifetime_randomness());
  426. #define CONVERT_PARAM(m_param) \
  427. proc_mat->set_param_min(ParticleProcessMaterial::m_param, cpu_particles->get_param_min(CPUParticles2D::m_param)); \
  428. { \
  429. Ref<Curve> curve = cpu_particles->get_param_curve(CPUParticles2D::m_param); \
  430. if (curve.is_valid()) { \
  431. Ref<CurveTexture> tex = memnew(CurveTexture); \
  432. tex->set_curve(curve); \
  433. proc_mat->set_param_texture(ParticleProcessMaterial::m_param, tex); \
  434. } \
  435. } \
  436. proc_mat->set_param_max(ParticleProcessMaterial::m_param, cpu_particles->get_param_max(CPUParticles2D::m_param));
  437. CONVERT_PARAM(PARAM_INITIAL_LINEAR_VELOCITY);
  438. CONVERT_PARAM(PARAM_ANGULAR_VELOCITY);
  439. CONVERT_PARAM(PARAM_ORBIT_VELOCITY);
  440. CONVERT_PARAM(PARAM_LINEAR_ACCEL);
  441. CONVERT_PARAM(PARAM_RADIAL_ACCEL);
  442. CONVERT_PARAM(PARAM_TANGENTIAL_ACCEL);
  443. CONVERT_PARAM(PARAM_DAMPING);
  444. CONVERT_PARAM(PARAM_ANGLE);
  445. CONVERT_PARAM(PARAM_SCALE);
  446. CONVERT_PARAM(PARAM_HUE_VARIATION);
  447. CONVERT_PARAM(PARAM_ANIM_SPEED);
  448. CONVERT_PARAM(PARAM_ANIM_OFFSET);
  449. #undef CONVERT_PARAM
  450. }
  451. void GPUParticles2D::_notification(int p_what) {
  452. switch (p_what) {
  453. case NOTIFICATION_DRAW: {
  454. RID texture_rid;
  455. Size2 size;
  456. if (texture.is_valid()) {
  457. texture_rid = texture->get_rid();
  458. size = texture->get_size();
  459. } else {
  460. size = Size2(1, 1);
  461. }
  462. if (trail_enabled) {
  463. RS::get_singleton()->mesh_clear(mesh);
  464. PackedVector2Array points;
  465. PackedVector2Array uvs;
  466. PackedInt32Array bone_indices;
  467. PackedFloat32Array bone_weights;
  468. PackedInt32Array indices;
  469. int total_segments = trail_sections * trail_section_subdivisions;
  470. real_t depth = size.height * trail_sections;
  471. for (int j = 0; j <= total_segments; j++) {
  472. real_t v = j;
  473. v /= total_segments;
  474. real_t y = depth * v;
  475. y = (depth * 0.5) - y;
  476. int bone = j / trail_section_subdivisions;
  477. real_t blend = 1.0 - real_t(j % trail_section_subdivisions) / real_t(trail_section_subdivisions);
  478. real_t s = size.width;
  479. points.push_back(Vector2(-s * 0.5, 0));
  480. points.push_back(Vector2(+s * 0.5, 0));
  481. uvs.push_back(Vector2(0, v));
  482. uvs.push_back(Vector2(1, v));
  483. for (int i = 0; i < 2; i++) {
  484. bone_indices.push_back(bone);
  485. bone_indices.push_back(MIN(trail_sections, bone + 1));
  486. bone_indices.push_back(0);
  487. bone_indices.push_back(0);
  488. bone_weights.push_back(blend);
  489. bone_weights.push_back(1.0 - blend);
  490. bone_weights.push_back(0);
  491. bone_weights.push_back(0);
  492. }
  493. if (j > 0) {
  494. int base = j * 2 - 2;
  495. indices.push_back(base + 0);
  496. indices.push_back(base + 1);
  497. indices.push_back(base + 2);
  498. indices.push_back(base + 1);
  499. indices.push_back(base + 3);
  500. indices.push_back(base + 2);
  501. }
  502. }
  503. Array arr;
  504. arr.resize(RS::ARRAY_MAX);
  505. arr[RS::ARRAY_VERTEX] = points;
  506. arr[RS::ARRAY_TEX_UV] = uvs;
  507. arr[RS::ARRAY_BONES] = bone_indices;
  508. arr[RS::ARRAY_WEIGHTS] = bone_weights;
  509. arr[RS::ARRAY_INDEX] = indices;
  510. RS::get_singleton()->mesh_add_surface_from_arrays(mesh, RS::PRIMITIVE_TRIANGLES, arr, Array(), Dictionary(), RS::ARRAY_FLAG_USE_2D_VERTICES);
  511. Vector<Transform3D> xforms;
  512. for (int i = 0; i <= trail_sections; i++) {
  513. Transform3D xform;
  514. /*
  515. xform.origin.y = depth / 2.0 - size.height * real_t(i);
  516. xform.origin.y = -xform.origin.y; //bind is an inverse transform, so negate y */
  517. xforms.push_back(xform);
  518. }
  519. RS::get_singleton()->particles_set_trail_bind_poses(particles, xforms);
  520. } else {
  521. RS::get_singleton()->mesh_clear(mesh);
  522. Vector<Vector2> points = {
  523. Vector2(-size.x / 2.0, -size.y / 2.0),
  524. Vector2(size.x / 2.0, -size.y / 2.0),
  525. Vector2(size.x / 2.0, size.y / 2.0),
  526. Vector2(-size.x / 2.0, size.y / 2.0)
  527. };
  528. Vector<Vector2> uvs;
  529. AtlasTexture *atlas_texture = Object::cast_to<AtlasTexture>(*texture);
  530. if (atlas_texture && atlas_texture->get_atlas().is_valid()) {
  531. Rect2 region_rect = atlas_texture->get_region();
  532. Size2 atlas_size = atlas_texture->get_atlas()->get_size();
  533. uvs.push_back(Vector2(region_rect.position.x / atlas_size.x, region_rect.position.y / atlas_size.y));
  534. uvs.push_back(Vector2((region_rect.position.x + region_rect.size.x) / atlas_size.x, region_rect.position.y / atlas_size.y));
  535. uvs.push_back(Vector2((region_rect.position.x + region_rect.size.x) / atlas_size.x, (region_rect.position.y + region_rect.size.y) / atlas_size.y));
  536. uvs.push_back(Vector2(region_rect.position.x / atlas_size.x, (region_rect.position.y + region_rect.size.y) / atlas_size.y));
  537. } else {
  538. uvs.push_back(Vector2(0, 0));
  539. uvs.push_back(Vector2(1, 0));
  540. uvs.push_back(Vector2(1, 1));
  541. uvs.push_back(Vector2(0, 1));
  542. }
  543. Vector<int> indices = { 0, 1, 2, 0, 2, 3 };
  544. Array arr;
  545. arr.resize(RS::ARRAY_MAX);
  546. arr[RS::ARRAY_VERTEX] = points;
  547. arr[RS::ARRAY_TEX_UV] = uvs;
  548. arr[RS::ARRAY_INDEX] = indices;
  549. RS::get_singleton()->mesh_add_surface_from_arrays(mesh, RS::PRIMITIVE_TRIANGLES, arr, Array(), Dictionary(), RS::ARRAY_FLAG_USE_2D_VERTICES);
  550. RS::get_singleton()->particles_set_trail_bind_poses(particles, Vector<Transform3D>());
  551. }
  552. RS::get_singleton()->canvas_item_add_particles(get_canvas_item(), particles, texture_rid);
  553. #ifdef TOOLS_ENABLED
  554. if (show_visibility_rect) {
  555. draw_rect(visibility_rect, Color(0, 0.7, 0.9, 0.4), false);
  556. }
  557. #endif
  558. } break;
  559. case NOTIFICATION_ENTER_TREE: {
  560. if (sub_emitter != NodePath()) {
  561. _attach_sub_emitter();
  562. }
  563. if (can_process()) {
  564. RS::get_singleton()->particles_set_speed_scale(particles, speed_scale);
  565. } else {
  566. RS::get_singleton()->particles_set_speed_scale(particles, 0);
  567. }
  568. set_process_internal(true);
  569. set_physics_process_internal(true);
  570. previous_position = get_global_position();
  571. } break;
  572. case NOTIFICATION_EXIT_TREE: {
  573. RS::get_singleton()->particles_set_subemitter(particles, RID());
  574. } break;
  575. case NOTIFICATION_SUSPENDED:
  576. case NOTIFICATION_UNSUSPENDED:
  577. case NOTIFICATION_PAUSED:
  578. case NOTIFICATION_UNPAUSED: {
  579. if (is_inside_tree()) {
  580. if (can_process()) {
  581. RS::get_singleton()->particles_set_speed_scale(particles, speed_scale);
  582. } else {
  583. RS::get_singleton()->particles_set_speed_scale(particles, 0);
  584. }
  585. }
  586. } break;
  587. case NOTIFICATION_TRANSFORM_CHANGED: {
  588. _update_particle_emission_transform();
  589. } break;
  590. case NOTIFICATION_INTERNAL_PROCESS: {
  591. if (one_shot) {
  592. time += get_process_delta_time();
  593. if (time > emission_time) {
  594. emitting = false;
  595. if (!active) {
  596. set_process_internal(false);
  597. }
  598. }
  599. if (time > active_time) {
  600. if (active && !signal_canceled) {
  601. emit_signal(SceneStringName(finished));
  602. }
  603. active = false;
  604. if (!emitting) {
  605. set_process_internal(false);
  606. }
  607. }
  608. }
  609. } break;
  610. case NOTIFICATION_INTERNAL_PHYSICS_PROCESS: {
  611. // Update velocity in physics process, so that velocity calculations remain correct
  612. // if the physics tick rate is lower than the rendered framerate (especially without physics interpolation).
  613. const Vector3 velocity = Vector3((get_global_position() - previous_position).x, (get_global_position() - previous_position).y, 0.0) /
  614. get_physics_process_delta_time();
  615. if (velocity != previous_velocity) {
  616. RS::get_singleton()->particles_set_emitter_velocity(particles, velocity);
  617. previous_velocity = velocity;
  618. }
  619. previous_position = get_global_position();
  620. } break;
  621. }
  622. }
  623. void GPUParticles2D::_bind_methods() {
  624. ClassDB::bind_method(D_METHOD("set_emitting", "emitting"), &GPUParticles2D::set_emitting);
  625. ClassDB::bind_method(D_METHOD("set_amount", "amount"), &GPUParticles2D::set_amount);
  626. ClassDB::bind_method(D_METHOD("set_lifetime", "secs"), &GPUParticles2D::set_lifetime);
  627. ClassDB::bind_method(D_METHOD("set_one_shot", "secs"), &GPUParticles2D::set_one_shot);
  628. ClassDB::bind_method(D_METHOD("set_pre_process_time", "secs"), &GPUParticles2D::set_pre_process_time);
  629. ClassDB::bind_method(D_METHOD("set_explosiveness_ratio", "ratio"), &GPUParticles2D::set_explosiveness_ratio);
  630. ClassDB::bind_method(D_METHOD("set_randomness_ratio", "ratio"), &GPUParticles2D::set_randomness_ratio);
  631. ClassDB::bind_method(D_METHOD("set_visibility_rect", "visibility_rect"), &GPUParticles2D::set_visibility_rect);
  632. ClassDB::bind_method(D_METHOD("set_use_local_coordinates", "enable"), &GPUParticles2D::set_use_local_coordinates);
  633. ClassDB::bind_method(D_METHOD("set_fixed_fps", "fps"), &GPUParticles2D::set_fixed_fps);
  634. ClassDB::bind_method(D_METHOD("set_fractional_delta", "enable"), &GPUParticles2D::set_fractional_delta);
  635. ClassDB::bind_method(D_METHOD("set_interpolate", "enable"), &GPUParticles2D::set_interpolate);
  636. ClassDB::bind_method(D_METHOD("set_process_material", "material"), &GPUParticles2D::set_process_material);
  637. ClassDB::bind_method(D_METHOD("set_speed_scale", "scale"), &GPUParticles2D::set_speed_scale);
  638. ClassDB::bind_method(D_METHOD("set_collision_base_size", "size"), &GPUParticles2D::set_collision_base_size);
  639. ClassDB::bind_method(D_METHOD("set_interp_to_end", "interp"), &GPUParticles2D::set_interp_to_end);
  640. ClassDB::bind_method(D_METHOD("is_emitting"), &GPUParticles2D::is_emitting);
  641. ClassDB::bind_method(D_METHOD("get_amount"), &GPUParticles2D::get_amount);
  642. ClassDB::bind_method(D_METHOD("get_lifetime"), &GPUParticles2D::get_lifetime);
  643. ClassDB::bind_method(D_METHOD("get_one_shot"), &GPUParticles2D::get_one_shot);
  644. ClassDB::bind_method(D_METHOD("get_pre_process_time"), &GPUParticles2D::get_pre_process_time);
  645. ClassDB::bind_method(D_METHOD("get_explosiveness_ratio"), &GPUParticles2D::get_explosiveness_ratio);
  646. ClassDB::bind_method(D_METHOD("get_randomness_ratio"), &GPUParticles2D::get_randomness_ratio);
  647. ClassDB::bind_method(D_METHOD("get_visibility_rect"), &GPUParticles2D::get_visibility_rect);
  648. ClassDB::bind_method(D_METHOD("get_use_local_coordinates"), &GPUParticles2D::get_use_local_coordinates);
  649. ClassDB::bind_method(D_METHOD("get_fixed_fps"), &GPUParticles2D::get_fixed_fps);
  650. ClassDB::bind_method(D_METHOD("get_fractional_delta"), &GPUParticles2D::get_fractional_delta);
  651. ClassDB::bind_method(D_METHOD("get_interpolate"), &GPUParticles2D::get_interpolate);
  652. ClassDB::bind_method(D_METHOD("get_process_material"), &GPUParticles2D::get_process_material);
  653. ClassDB::bind_method(D_METHOD("get_speed_scale"), &GPUParticles2D::get_speed_scale);
  654. ClassDB::bind_method(D_METHOD("get_collision_base_size"), &GPUParticles2D::get_collision_base_size);
  655. ClassDB::bind_method(D_METHOD("get_interp_to_end"), &GPUParticles2D::get_interp_to_end);
  656. ClassDB::bind_method(D_METHOD("set_draw_order", "order"), &GPUParticles2D::set_draw_order);
  657. ClassDB::bind_method(D_METHOD("get_draw_order"), &GPUParticles2D::get_draw_order);
  658. ClassDB::bind_method(D_METHOD("set_texture", "texture"), &GPUParticles2D::set_texture);
  659. ClassDB::bind_method(D_METHOD("get_texture"), &GPUParticles2D::get_texture);
  660. ClassDB::bind_method(D_METHOD("capture_rect"), &GPUParticles2D::capture_rect);
  661. ClassDB::bind_method(D_METHOD("restart"), &GPUParticles2D::restart);
  662. ClassDB::bind_method(D_METHOD("set_sub_emitter", "path"), &GPUParticles2D::set_sub_emitter);
  663. ClassDB::bind_method(D_METHOD("get_sub_emitter"), &GPUParticles2D::get_sub_emitter);
  664. ClassDB::bind_method(D_METHOD("emit_particle", "xform", "velocity", "color", "custom", "flags"), &GPUParticles2D::emit_particle);
  665. ClassDB::bind_method(D_METHOD("set_trail_enabled", "enabled"), &GPUParticles2D::set_trail_enabled);
  666. ClassDB::bind_method(D_METHOD("set_trail_lifetime", "secs"), &GPUParticles2D::set_trail_lifetime);
  667. ClassDB::bind_method(D_METHOD("is_trail_enabled"), &GPUParticles2D::is_trail_enabled);
  668. ClassDB::bind_method(D_METHOD("get_trail_lifetime"), &GPUParticles2D::get_trail_lifetime);
  669. ClassDB::bind_method(D_METHOD("set_trail_sections", "sections"), &GPUParticles2D::set_trail_sections);
  670. ClassDB::bind_method(D_METHOD("get_trail_sections"), &GPUParticles2D::get_trail_sections);
  671. ClassDB::bind_method(D_METHOD("set_trail_section_subdivisions", "subdivisions"), &GPUParticles2D::set_trail_section_subdivisions);
  672. ClassDB::bind_method(D_METHOD("get_trail_section_subdivisions"), &GPUParticles2D::get_trail_section_subdivisions);
  673. ClassDB::bind_method(D_METHOD("convert_from_particles", "particles"), &GPUParticles2D::convert_from_particles);
  674. ClassDB::bind_method(D_METHOD("set_amount_ratio", "ratio"), &GPUParticles2D::set_amount_ratio);
  675. ClassDB::bind_method(D_METHOD("get_amount_ratio"), &GPUParticles2D::get_amount_ratio);
  676. ADD_SIGNAL(MethodInfo("finished"));
  677. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "emitting", PROPERTY_HINT_ONESHOT), "set_emitting", "is_emitting");
  678. ADD_PROPERTY_DEFAULT("emitting", true); // Workaround for doctool in headless mode, as dummy rasterizer always returns false.
  679. ADD_PROPERTY(PropertyInfo(Variant::INT, "amount", PROPERTY_HINT_RANGE, "1,1000000,1,exp"), "set_amount", "get_amount"); // FIXME: Evaluate support for `exp` in integer properties, or remove this.
  680. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "amount_ratio", PROPERTY_HINT_RANGE, "0,1,0.0001"), "set_amount_ratio", "get_amount_ratio");
  681. ADD_PROPERTY(PropertyInfo(Variant::NODE_PATH, "sub_emitter", PROPERTY_HINT_NODE_PATH_VALID_TYPES, "GPUParticles2D"), "set_sub_emitter", "get_sub_emitter");
  682. ADD_GROUP("Time", "");
  683. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "lifetime", PROPERTY_HINT_RANGE, "0.01,600.0,0.01,or_greater,exp,suffix:s"), "set_lifetime", "get_lifetime");
  684. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "interp_to_end", PROPERTY_HINT_RANGE, "0.00,1.0,0.001"), "set_interp_to_end", "get_interp_to_end");
  685. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "one_shot"), "set_one_shot", "get_one_shot");
  686. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "preprocess", PROPERTY_HINT_RANGE, "0.00,10.0,0.01,or_greater,exp,suffix:s"), "set_pre_process_time", "get_pre_process_time");
  687. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "speed_scale", PROPERTY_HINT_RANGE, "0,64,0.01"), "set_speed_scale", "get_speed_scale");
  688. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "explosiveness", PROPERTY_HINT_RANGE, "0,1,0.01"), "set_explosiveness_ratio", "get_explosiveness_ratio");
  689. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "randomness", PROPERTY_HINT_RANGE, "0,1,0.01"), "set_randomness_ratio", "get_randomness_ratio");
  690. ADD_PROPERTY(PropertyInfo(Variant::INT, "fixed_fps", PROPERTY_HINT_RANGE, "0,1000,1,suffix:FPS"), "set_fixed_fps", "get_fixed_fps");
  691. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "interpolate"), "set_interpolate", "get_interpolate");
  692. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "fract_delta"), "set_fractional_delta", "get_fractional_delta");
  693. ADD_GROUP("Collision", "collision_");
  694. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "collision_base_size", PROPERTY_HINT_RANGE, "0,128,0.01,or_greater"), "set_collision_base_size", "get_collision_base_size");
  695. ADD_GROUP("Drawing", "");
  696. ADD_PROPERTY(PropertyInfo(Variant::RECT2, "visibility_rect", PROPERTY_HINT_NONE, "suffix:px"), "set_visibility_rect", "get_visibility_rect");
  697. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "local_coords"), "set_use_local_coordinates", "get_use_local_coordinates");
  698. ADD_PROPERTY(PropertyInfo(Variant::INT, "draw_order", PROPERTY_HINT_ENUM, "Index,Lifetime,Reverse Lifetime"), "set_draw_order", "get_draw_order");
  699. ADD_GROUP("Trails", "trail_");
  700. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "trail_enabled"), "set_trail_enabled", "is_trail_enabled");
  701. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "trail_lifetime", PROPERTY_HINT_RANGE, "0.01,10,0.01,or_greater,suffix:s"), "set_trail_lifetime", "get_trail_lifetime");
  702. ADD_PROPERTY(PropertyInfo(Variant::INT, "trail_sections", PROPERTY_HINT_RANGE, "2,128,1"), "set_trail_sections", "get_trail_sections");
  703. ADD_PROPERTY(PropertyInfo(Variant::INT, "trail_section_subdivisions", PROPERTY_HINT_RANGE, "1,1024,1"), "set_trail_section_subdivisions", "get_trail_section_subdivisions");
  704. ADD_GROUP("Process Material", "");
  705. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "texture", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"), "set_texture", "get_texture");
  706. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "process_material", PROPERTY_HINT_RESOURCE_TYPE, "ParticleProcessMaterial,ShaderMaterial"), "set_process_material", "get_process_material");
  707. BIND_ENUM_CONSTANT(DRAW_ORDER_INDEX);
  708. BIND_ENUM_CONSTANT(DRAW_ORDER_LIFETIME);
  709. BIND_ENUM_CONSTANT(DRAW_ORDER_REVERSE_LIFETIME);
  710. BIND_ENUM_CONSTANT(EMIT_FLAG_POSITION);
  711. BIND_ENUM_CONSTANT(EMIT_FLAG_ROTATION_SCALE);
  712. BIND_ENUM_CONSTANT(EMIT_FLAG_VELOCITY);
  713. BIND_ENUM_CONSTANT(EMIT_FLAG_COLOR);
  714. BIND_ENUM_CONSTANT(EMIT_FLAG_CUSTOM);
  715. }
  716. GPUParticles2D::GPUParticles2D() {
  717. particles = RS::get_singleton()->particles_create();
  718. RS::get_singleton()->particles_set_mode(particles, RS::PARTICLES_MODE_2D);
  719. mesh = RS::get_singleton()->mesh_create();
  720. RS::get_singleton()->particles_set_draw_passes(particles, 1);
  721. RS::get_singleton()->particles_set_draw_pass_mesh(particles, 0, mesh);
  722. one_shot = false; // Needed so that set_emitting doesn't access uninitialized values
  723. set_emitting(true);
  724. set_one_shot(false);
  725. set_amount(8);
  726. set_amount_ratio(1.0);
  727. set_lifetime(1);
  728. set_fixed_fps(0);
  729. set_fractional_delta(true);
  730. set_interpolate(true);
  731. set_pre_process_time(0);
  732. set_explosiveness_ratio(0);
  733. set_randomness_ratio(0);
  734. set_visibility_rect(Rect2(Vector2(-100, -100), Vector2(200, 200)));
  735. set_use_local_coordinates(false);
  736. set_draw_order(DRAW_ORDER_LIFETIME);
  737. set_speed_scale(1);
  738. set_fixed_fps(30);
  739. set_collision_base_size(collision_base_size);
  740. }
  741. GPUParticles2D::~GPUParticles2D() {
  742. ERR_FAIL_NULL(RenderingServer::get_singleton());
  743. RS::get_singleton()->free(particles);
  744. RS::get_singleton()->free(mesh);
  745. }