Source: extern/particles.js

  1. import register from "../util/register.js";
  3. import m_particles_fact from "../intern/particles.js";
  4. import m_print_fact from "../intern/print.js";
  6. /**
  7.  * {@link https://www.blend4web.com/doc/en/particles.html|Particle system} API. Please note that particle emission itself is controlled by the {@link module:animation} module.
  8.  * @module particles
  9.  */
  10. function Particles(ns, exports) {
  12. var m_particles = m_particles_fact(ns);
  13. var m_print     = m_print_fact(ns);
  15. /**
  16.  * Set particle size.
  17.  * @method module:particles.set_size
  18.  * @param {Object3D} obj Emitter object.
  19.  * @param {string} psys_name Particle system name.
  20.  * @param {number} size Particle size.
  21.  * @example var m_particles = require("particles");
  22.  * var m_scenes = require("scenes");
  23.  *
  24.  * var cube = m_scenes.get_object_by_name("Cube");
  25.  * m_particles.set_size(cube, "MyParticleSystem", 2.4);
  26.  */
  27. exports.set_size = function(obj, psys_name, size) {
  28.     if (!m_particles.obj_has_psys(obj, psys_name)) {
  29.         m_print.error("set_size(): Object \"" + obj.name + "\" has not a particle system named \"" 
  30.                 + psys_name + "\"");
  31.         return;
  32.     }
  33.     m_particles.set_size(obj, psys_name, size);
  34. }
  37. /**
  38.  * Set particle normal factor.
  39.  * @method module:particles.set_normal_factor
  40.  * @param {Object3D} obj Emitter object.
  41.  * @param {string} psys_name Particle system name.
  42.  * @param {number} nfactor Particle normal factor.
  43.  * @example var m_particles = require("particles");
  44.  * var m_scenes = require("scenes");
  45.  *
  46.  * var cube = m_scenes.get_object_by_name("Cube");
  47.  * m_particles.set_normal_factor(cube, "MyParticleSystem", 15);
  48.  */
  49. exports.set_normal_factor = function(obj, psys_name, nfactor) {
  50.     if (!m_particles.obj_has_psys(obj, psys_name)) {
  51.         m_print.error("set_normal_factor(): Object \"" + obj.name + "\" has not a particle system named \"" 
  52.                 + psys_name + "\"");
  53.         return;
  54.     }
  55.     m_particles.set_normal_factor(obj, psys_name, nfactor);
  56. }
  58. /**
  59.  * Set particle number factor.
  60.  * @method module:particles.set_factor
  61.  * @param {Object3D} obj Emitter object.
  62.  * @param {string} psys_name Particle system name.
  63.  * @param {number} factor Particle number factor. A coefficient defining the 
  64.  * number of particles to be emitted. 1 - all particles, 0 - none.
  65.  * @example var m_particles = require("particles");
  66.  * var m_scenes = require("scenes");
  67.  *
  68.  * var cube = m_scenes.get_object_by_name("Cube");
  69.  * m_particles.set_factor(cube, "MyParticleSystem", 0.3);
  70.  */
  71. exports.set_factor = function(obj, psys_name, factor) {
  72.     if (!m_particles.obj_has_psys(obj, psys_name)) {
  73.         m_print.error("set_factor(): Object \"" + obj.name + "\" has not a particle system named \"" 
  74.                 + psys_name + "\"");
  75.         return;
  76.     }
  77.     factor = Math.min(factor, 1);
  78.     factor = Math.max(factor, 0);
  80.     m_particles.set_factor(obj, psys_name, factor);
  81. }
  83. }
  85. var particles_factory = register("particles", Particles);
  87. export default particles_factory;