371705950

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/creativelifeform/three-nebula/commit/<a class=hub.com/creativelifeform/three-nebula/commit/<a class="double-link" href="https://git"><a class=hub.com/creativelifeform/three-nebula/commit/<a class="double-link" href="https://git"><a class=hub.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd5d9cd01f">34d964016<a href="https://github.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd5d9cd01f">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/creativelifeform/three-nebula/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/creativelifeform/three-nebula/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd5d9cd01f&quot;&gt;34d964016&lt;/a&gt;&lt;a href=&quot;https://github.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd5d9cd01f&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd&lt;/a&gt;5d9cd01f&quot;&gt;&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/creativelifeform/three-nebula/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/creativelifeform/three-nebula/commit/<a class="double-link" href="https://github.com/creativelifeform/three-nebula/commit/d6c8c72a6b57d39ef2464f3d48d6da9a4dd90367">d6c8c72a6</a><a href="https://github.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd5d9cd01f">&amp;quot;&amp;gt;d6c8c72a6&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;d6c8c72a6&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/creativelifeform/three-nebula/commit/34d96401684d4e4d94085f82e6f3efdd5d9cd&lt;/a&gt;01f&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/creativelifeform/three-nebula/commit/<a class="double-link" href="https://github.com/creativelifeform/three-nebula/commit/f4fcdee40">f4fcdee40">f4fcdee40</a>

Pull Request Pull Request #132: Feature/texture atlas disposal

Run Details

441 of 756 branches covered (58.33%)

Branch coverage included in aggregate %.

7 of 7 new or added lines in 1 file covered. (100.0%)

1467 of 1881 relevant lines covered (77.99%)

123.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.1

/src/core/System.js

import EventDispatcher, {
  EMITTER_ADDED,
  EMITTER_REMOVED,
  SYSTEM_UPDATE,
  SYSTEM_UPDATE_AFTER,
} from '../events';

import { DEFAULT_SYSTEM_DELTA } from './constants';
import Emitter from '../emitter/Emitter';
import { INTEGRATION_TYPE_EULER } from '../math/constants';
import { POOL_MAX } from '../constants';
import Pool from './Pool';
import fromJSON from './fromJSON';
import fromJSONAsync from './fromJSONAsync';
import { CORE_TYPE_SYSTEM as type } from './types';

/**
 * The core of the three-system particle engine.
 * A System instance can contain multiple emitters, each with their own initializers
 * and behaviours.
 *
 */
export default class System {
  /**
   * Constructs a System instance.
   *
   * @param {object} THREE - ThreeJs
   * @param {number} [preParticles=POOL_MAX] - The number of particles to start with
   * @param {string} [integrationType=INTEGRATION_TYPE_EULER] - The integration type to use
   * @return void
   */
  constructor(
    preParticles = POOL_MAX,
    integrationType = INTEGRATION_TYPE_EULER
  ) {
    /**
     * @desc The class type.
     * @type {string}
     */
    this.type = type;

    /**
     * @desc Determines if the system can update or not. Set to false when destroying
     * to ensure that external calls to update do not throw errors.
     * @type {boolean}
     */
    this.canUpdate = true;

    /**
     * @desc The number of particles to start with.
     * @type {number}
     */
    this.preParticles = preParticles;

    /**
     * @desc The integration algorithm type to use.
     * @param {string}
     */
    this.integrationType = integrationType;

    /**
     * @desc The emitters in the particle system.
     * @type {array<Emitter>}
     */
    this.emitters = [];

    /**
     * @desc The renderers for the system.
     * @type {array<Renderer>}
     */
    this.renderers = [];

    /**
     * @desc A pool used to manage the internal system cache of objects
     * @type {Pool}
     */
    this.pool = new Pool();

    /**
     * @desc Internal event dispatcher
     * @type {EventDispatcher}
     */
    this.eventDispatcher = new EventDispatcher();
  }

  /**
   * Creates a System instance from a JSON object.
   *
   * @param {object} json - The JSON to create the System instance from
   * @param {object} THREE - The Web GL Api to use eg., THREE
   * @return {System}
   *
   * @deprecated use fromJSONAsync instead
   */
  static fromJSON(json, THREE) {
    return fromJSON(json, THREE, System, Emitter);
  }

  /**
   * Loads a System instance from JSON asynchronously. Ensures all textures are
   * fully loaded before resolving with the instantiated System instance.
   *
   * @param {object} json - The JSON to create the System instance from
   * @param {object} THREE - The Web GL Api to use eg., THREE
   * @param {?object} options - Optional config options
   * @return {Promise<System>}
   */
  static fromJSONAsync(json, THREE, options) {
    return fromJSONAsync(json, THREE, System, Emitter, options);
  }

  /**
   * Proxy method for the internal event dispatcher's dispatchEvent method.
   *
   * @param {string} event - The event to dispatch
   * @param {object<System|Emitter|Particle>} [target=this] - The event target
   */
  dispatch(event, target = this) {
    this.eventDispatcher.dispatchEvent(event, target);
  }

  /**
   * Adds a renderer to the System instance and initializes it.
   *
   * @param {Renderer} renderer - The renderer to add
   * @return {System}
   */
  addRenderer(renderer) {
    this.renderers.push(renderer);
    renderer.init(this);

    return this;
  }

  /**
   * Removes a renderer from the System instance.
   *
   * @param {Renderer} renderer
   * @return {System}
   */
  removeRenderer(renderer) {
    this.renderers.splice(this.renderers.indexOf(renderer), 1);
    renderer.remove(this);

    return this;
  }

  /**
   * Adds an emitter to the System instance.
   * Dispatches the EMITTER_ADDED event.
   *
   * @param {Emitter} emitter - The emitter to add
   * @return {System}
   */
  addEmitter(emitter) {
    const index = this.emitters.length;

    emitter.parent = this;
    emitter.index = index;

    this.emitters.push(emitter);
    this.dispatch(EMITTER_ADDED, emitter);

    return this;
  }

  /**
   * Removes an emitter from the System instance.
   * Dispatches the EMITTER_REMOVED event.
   *
   * @param {Emitter} emitter - The emitter to remove
   * @return {System}
   */
  removeEmitter(emitter) {
    if (emitter.parent !== this) {
      return this;
    }

    emitter.parent = null;
    emitter.index = undefined;

    this.emitters.splice(this.emitters.indexOf(emitter), 1);
    this.dispatch(EMITTER_REMOVED, emitter);

    return this;
  }

  /**
   * Wires up life cycle methods and causes a system's emitters to emit particles.
   * Expects emitters to have their totalEmitTimes and life set already.
   * Inifnite systems will resolve immediately.
   *
   * @param {object} hooks - Functions to hook into the life cycle API
   * @param {function} hooks.onStart - Called when the system starts to emit particles
   * @param {function} hooks.onUpdate - Called each time the system updates
   * @param {function} hooks.onEnd - Called when the system's emitters have all died
   * @return {Promise}
   */
  emit({ onStart, onUpdate, onEnd }) {
    if (onStart) {
      onStart();
    }

    if (onUpdate) {
      this.eventDispatcher.addEventListener(SYSTEM_UPDATE, onUpdate);
    }

    const emitters = this.emitters.map(emitter => {
      const { life } = emitter;

      if (life === Infinity) {
        if (onEnd) {
          onEnd();
        }

        emitter.experimental_emit();

        return Promise.resolve();
      }

      return new Promise(resolve => {
        emitter.addOnEmitterDeadEventListener(() => {
          if (onEnd) {
            onEnd();
          }

          resolve();
        });

        emitter.experimental_emit();
      });
    });

    try {
      return Promise.all(emitters);
    } catch (e) {
      console.warn(e);
    }
  }

  /**
   * Updates the particle system based on the delta passed.
   *
   * @example
   * animate = () => {
   *   threeRenderer.render(threeScene, threeCamera);
   *   system.update();
   *   requestAnimationFrame(animate);
   * }
   * animate();
   *
   * @param {number} delta - Delta time
   * @return {Promise}
   */
  update(delta = DEFAULT_SYSTEM_DELTA) {
    const d = delta || DEFAULT_SYSTEM_DELTA;

    if (this.canUpdate) {
      if (d > 0) {
        let i = this.emitters.length;

        while (i--) {
          const emitter = this.emitters[i];

          emitter.update(d);
          emitter.isEmitting && this.dispatch(SYSTEM_UPDATE);
        }
      }

      this.dispatch(SYSTEM_UPDATE_AFTER);
    }

    return Promise.resolve();
  }

  /**
   * Gets a count of the total number of particles in the system.
   *
   * @return {integer}
   */
  getCount() {
    const length = this.emitters.length;
    let total = 0;
    let i;

    for (i = 0; i < length; i++) {
      total += this.emitters[i].particles.length;
    }

    return total;
  }

  /**
   * Destroys all emitters, renderers and the Nebula pool.
   * Ensures that this.update will not perform any operations while the system
   * is being destroyed.
   *
   * @return void
   */
  destroy() {
    const length = this.emitters.length;

    this.canUpdate = false;

    for (let e = 0; e < length; e++) {
      this.emitters[e] && this.emitters[e].destroy();
      delete this.emitters[e];
    }

    for (let r = 0; r < length; r++) {
      if (this.renderers[r] && this.renderers[r].destroy) {
        this.renderers[r].destroy();
        delete this.renderers[r];
      }
    }

    this.emitters.length = 0;
    this.pool.destroy();
    this.canUpdate = true;
  }
}

1	import EventDispatcher, {	1✔
2	EMITTER_ADDED,
3	EMITTER_REMOVED,
4	SYSTEM_UPDATE,
5	SYSTEM_UPDATE_AFTER,
6	} from '../events';
7
8	import { DEFAULT_SYSTEM_DELTA } from './constants';	1✔
9	import Emitter from '../emitter/Emitter';	1✔
10	import { INTEGRATION_TYPE_EULER } from '../math/constants';	1✔
11	import { POOL_MAX } from '../constants';	1✔
12	import Pool from './Pool';	1✔
13	import fromJSON from './fromJSON';	1✔
14	import fromJSONAsync from './fromJSONAsync';	1✔
15	import { CORE_TYPE_SYSTEM as type } from './types';	1✔
16
17	/**
18	* The core of the three-system particle engine.
19	* A System instance can contain multiple emitters, each with their own initializers
20	* and behaviours.
21	*
22	*/
23	export default class System {
24	/**
25	* Constructs a System instance.
26	*
27	* @param {object} THREE - ThreeJs
28	* @param {number} [preParticles=POOL_MAX] - The number of particles to start with
29	* @param {string} [integrationType=INTEGRATION_TYPE_EULER] - The integration type to use
30	* @return void
31	*/
32	constructor(
33	preParticles = POOL_MAX,	29✔
34	integrationType = INTEGRATION_TYPE_EULER	28✔
35	) {
36	/**
37	* @desc The class type.
38	* @type {string}
39	*/
40	this.type = type;	44✔
41
42	/**
43	* @desc Determines if the system can update or not. Set to false when destroying
44	* to ensure that external calls to update do not throw errors.
45	* @type {boolean}
46	*/
47	this.canUpdate = true;	44✔
48
49	/**
50	* @desc The number of particles to start with.
51	* @type {number}
52	*/
53	this.preParticles = preParticles;	44✔
54
55	/**
56	* @desc The integration algorithm type to use.
57	* @param {string}
58	*/
59	this.integrationType = integrationType;	44✔
60
61	/**
62	* @desc The emitters in the particle system.
63	* @type {array<Emitter>}
64	*/
65	this.emitters = [];	44✔
66
67	/**
68	* @desc The renderers for the system.
69	* @type {array<Renderer>}
70	*/
71	this.renderers = [];	44✔
72
73	/**
74	* @desc A pool used to manage the internal system cache of objects
75	* @type {Pool}
76	*/
77	this.pool = new Pool();	44✔
78
79	/**
80	* @desc Internal event dispatcher
81	* @type {EventDispatcher}
82	*/
83	this.eventDispatcher = new EventDispatcher();	44✔
84	}
85
86	/**
87	* Creates a System instance from a JSON object.
88	*
89	* @param {object} json - The JSON to create the System instance from
90	* @param {object} THREE - The Web GL Api to use eg., THREE
91	* @return {System}
92	*
93	* @deprecated use fromJSONAsync instead
94	*/
95	static fromJSON(json, THREE) {
96	return fromJSON(json, THREE, System, Emitter);	9✔
97	}
98
99	/**
100	* Loads a System instance from JSON asynchronously. Ensures all textures are
101	* fully loaded before resolving with the instantiated System instance.
102	*
103	* @param {object} json - The JSON to create the System instance from
104	* @param {object} THREE - The Web GL Api to use eg., THREE
105	* @param {?object} options - Optional config options
106	* @return {Promise<System>}
107	*/
108	static fromJSONAsync(json, THREE, options) {
109	return fromJSONAsync(json, THREE, System, Emitter, options);	7✔
110	}
111
112	/**
113	* Proxy method for the internal event dispatcher's dispatchEvent method.
114	*
115	* @param {string} event - The event to dispatch
116	* @param {object<System\|Emitter\|Particle>} [target=this] - The event target
117	*/
118	dispatch(event, target = this) {	6✔
119	this.eventDispatcher.dispatchEvent(event, target);	2,120✔
120	}
121
122	/**
123	* Adds a renderer to the System instance and initializes it.
124	*
125	* @param {Renderer} renderer - The renderer to add
126	* @return {System}
127	*/
128	addRenderer(renderer) {
129	this.renderers.push(renderer);	4✔
130	renderer.init(this);	4✔
131
132	return this;	4✔
133	}
134
135	/**
136	* Removes a renderer from the System instance.
137	*
138	* @param {Renderer} renderer
139	* @return {System}
140	*/
141	removeRenderer(renderer) {
142	this.renderers.splice(this.renderers.indexOf(renderer), 1);	1✔
143	renderer.remove(this);	1✔
144
145	return this;	1✔
146	}
147
148	/**
149	* Adds an emitter to the System instance.
150	* Dispatches the EMITTER_ADDED event.
151	*
152	* @param {Emitter} emitter - The emitter to add
153	* @return {System}
154	*/
155	addEmitter(emitter) {
156	const index = this.emitters.length;	41✔
157
158	emitter.parent = this;	41✔
159	emitter.index = index;	41✔
160
161	this.emitters.push(emitter);	41✔
162	this.dispatch(EMITTER_ADDED, emitter);	41✔
163
164	return this;	41✔
165	}
166
167	/**
168	* Removes an emitter from the System instance.
169	* Dispatches the EMITTER_REMOVED event.
170	*
171	* @param {Emitter} emitter - The emitter to remove
172	* @return {System}
173	*/
174	removeEmitter(emitter) {
175	if (emitter.parent !== this) {	5✔
176	return this;	1✔
177	}
178
179	emitter.parent = null;	4✔
180	emitter.index = undefined;	4✔
181
182	this.emitters.splice(this.emitters.indexOf(emitter), 1);	4✔
183	this.dispatch(EMITTER_REMOVED, emitter);	4✔
184
185	return this;	4✔
186	}
187
188	/**
189	* Wires up life cycle methods and causes a system's emitters to emit particles.
190	* Expects emitters to have their totalEmitTimes and life set already.
191	* Inifnite systems will resolve immediately.
192	*
193	* @param {object} hooks - Functions to hook into the life cycle API
194	* @param {function} hooks.onStart - Called when the system starts to emit particles
195	* @param {function} hooks.onUpdate - Called each time the system updates
196	* @param {function} hooks.onEnd - Called when the system's emitters have all died
197	* @return {Promise}
198	*/
199	emit({ onStart, onUpdate, onEnd }) {
200	if (onStart) {	4✔
201	onStart();	1✔
202	}
203
204	if (onUpdate) {	4✔
205	this.eventDispatcher.addEventListener(SYSTEM_UPDATE, onUpdate);	1✔
206	}
207
208	const emitters = this.emitters.map(emitter => {	4✔
209	const { life } = emitter;	3✔
210
211	if (life === Infinity) {	3✔
212	if (onEnd) {	1!
213	onEnd();	1✔
214	}
215
216	emitter.experimental_emit();	1✔
217
218	return Promise.resolve();	1✔
219	}
220
221	return new Promise(resolve => {	2✔
222	emitter.addOnEmitterDeadEventListener(() => {	2✔
223	if (onEnd) {	2!
224	onEnd();	2✔
225	}
226
227	resolve();	2✔
228	});
229
230	emitter.experimental_emit();	2✔
231	});
232	});
233
234	try {	4✔
235	return Promise.all(emitters);	4✔
236	} catch (e) {
237	console.warn(e);	×
238	}
239	}
240
241	/**
242	* Updates the particle system based on the delta passed.
243	*
244	* @example
245	* animate = () => {
246	* threeRenderer.render(threeScene, threeCamera);
247	* system.update();
248	* requestAnimationFrame(animate);
249	* }
250	* animate();
251	*
252	* @param {number} delta - Delta time
253	* @return {Promise}
254	*/
255	update(delta = DEFAULT_SYSTEM_DELTA) {	4✔
256	const d = delta \|\| DEFAULT_SYSTEM_DELTA;	4!
257
258	if (this.canUpdate) {	4✔
259	if (d > 0) {	3!
260	let i = this.emitters.length;	3✔
261
262	while (i--) {	3✔
263	const emitter = this.emitters[i];	3✔
264
265	emitter.update(d);	3✔
266	emitter.isEmitting && this.dispatch(SYSTEM_UPDATE);	3✔
267	}
268	}
269
270	this.dispatch(SYSTEM_UPDATE_AFTER);	3✔
271	}
272
273	return Promise.resolve();	4✔
274	}
275
276	/**
277	* Gets a count of the total number of particles in the system.
278	*
279	* @return {integer}
280	*/
281	getCount() {
282	const length = this.emitters.length;	1✔
283	let total = 0;	1✔
284	let i;
285
286	for (i = 0; i < length; i++) {	1✔
287	total += this.emitters[i].particles.length;	1✔
288	}
289
290	return total;	1✔
291	}
292
293	/**
294	* Destroys all emitters, renderers and the Nebula pool.
295	* Ensures that this.update will not perform any operations while the system
296	* is being destroyed.
297	*
298	* @return void
299	*/
300	destroy() {
301	const length = this.emitters.length;	1✔
302
303	this.canUpdate = false;	1✔
304
305	for (let e = 0; e < length; e++) {	1✔
306	this.emitters[e] && this.emitters[e].destroy();	1✔
307	delete this.emitters[e];	1✔
308	}
309
310	for (let r = 0; r < length; r++) {	1✔
311	if (this.renderers[r] && this.renderers[r].destroy) {	1!
312	this.renderers[r].destroy();	×
313	delete this.renderers[r];	×
314	}
315	}
316
317	this.emitters.length = 0;	1✔
318	this.pool.destroy();	1✔
319	this.canUpdate = true;	1✔
320	}
321	}

creativelifeform / three-nebula / 371705950

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous