]> git.r.bdr.sh - rbdr/sumo/blame - lib/systems/render.js
Update dependencies
[rbdr/sumo] / lib / systems / render.js
CommitLineData
0616b3f0
RBR
1import { System } from '@serpentity/serpentity';
2
3import RenderableNode from '../nodes/renderable';
4
5const internals = {
6 kNoPixiError: 'No pixi application passed to render system. Make sure you set the `application` key in the config object when initializing.'
7};
8
9/**
493ec31c 10 * Renders renderable objects using pixi
0616b3f0
RBR
11 *
12 * @extends {external:Serpentity.System}
13 * @class RenderSystem
14 * @param {object} config a configuration object to extend.
15 */
16export default class RenderSystem extends System {
17
18 constructor(config = {}) {
19
20 super();
21
22 /**
23 * The node collection of renderable entities
24 *
25 * @property {external:Serpentity.NodeCollection} renderables
26 * @instance
27 * @memberof RenderSystem
28 */
29 this.renderables = null;
30
31 /**
32 * The pixi engine we will use to render
33 *
7ade6f8d 34 * @property {external:PixiJs.Application} application
0616b3f0
RBR
35 * @instance
36 * @memberof RenderSystem
37 */
7ade6f8d 38 this.application = config.application;
0616b3f0 39
7ade6f8d 40 if (!this.application) {
0616b3f0
RBR
41 throw new Error(internals.kNoPixiError);
42 }
43 }
44
45 /**
46 * Initializes system when added. Requests renderable nodes and
47 * attaches to event listeners to add / remove them to pixi stage
48 *
49 * @function added
50 * @memberof RenderSystem
51 * @instance
52 * @param {external:Serpentity.Engine} engine the serpentity engine to
53 * which we are getting added
54 */
55 added(engine) {
56
57 this.renderables = engine.getNodes(RenderableNode);
aaa1f8f6 58 this.renderables.addEventListener('nodeAdded', (event) => {
0616b3f0 59
7ade6f8d 60 this.application.stage.addChild(event.node.container.container);
0616b3f0 61 });
aaa1f8f6 62 this.renderables.addEventListener('nodeRemoved', (event) => {
0616b3f0 63
7ade6f8d 64 this.application.stage.removeChild(event.node.container.container);
0616b3f0
RBR
65 });
66 }
67
68 /**
69 * Clears system resources when removed.
70 *
71 * @function removed
72 * @instance
73 * @memberof RenderSystem
74 */
75 removed() {
76
77 this.renderables.removeAllListeners('nodeAdded');
78 this.renderables.removeAllListeners('nodeRemoved');
79 this.renderables = null;
80 }
81
82 /**
493ec31c 83 * Runs on every update of the loop. Does nothing.
0616b3f0
RBR
84 *
85 * @function update
86 * @instance
87 * @param {Number} currentFrameDuration the duration of the current
88 * frame
89 * @memberof RenderSystem
90 */
6768cd46
RBR
91 update(currentFrameDuration) {
92
93 this.application.render();
94 }
7741a3cc 95}