-
Notifications
You must be signed in to change notification settings - Fork 250
/
Node.js
1290 lines (1175 loc) · 38.8 KB
/
Node.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* The MIT License (MIT)
*
* Copyright (c) 2015 Famous Industries Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
/*jshint -W079 */
'use strict';
var SizeSystem = require('./SizeSystem');
var Dispatch = require('./Dispatch');
var TransformSystem = require('./TransformSystem');
var Size = require('./Size');
var Transform = require('./Transform');
/**
* Nodes define hierarchy and geometrical transformations. They can be moved
* (translated), scaled and rotated.
*
* A Node is either mounted or unmounted. Unmounted nodes are detached from the
* scene graph. Unmounted nodes have no parent node, while each mounted node has
* exactly one parent. Nodes have an arbitrary number of children, which can be
* dynamically added using {@link Node#addChild}.
*
* Each Node has an arbitrary number of `components`. Those components can
* send `draw` commands to the renderer or mutate the node itself, in which case
* they define behavior in the most explicit way. Components that send `draw`
* commands are considered `renderables`. From the node's perspective, there is
* no distinction between nodes that send draw commands and nodes that define
* behavior.
*
* Because of the fact that Nodes themself are very unopinioted (they don't
* "render" to anything), they are often being subclassed in order to add e.g.
* components at initialization to them. Because of this flexibility, they might
* as well have been called `Entities`.
*
* @example
* // create three detached (unmounted) nodes
* var parent = new Node();
* var child1 = new Node();
* var child2 = new Node();
*
* // build an unmounted subtree (parent is still detached)
* parent.addChild(child1);
* parent.addChild(child2);
*
* // mount parent by adding it to the context
* var context = Famous.createContext("body");
* context.addChild(parent);
*
* @class Node
* @constructor
*/
function Node () {
this._requestingUpdate = false;
this._inUpdate = false;
this._mounted = false;
this._shown = true;
this._updater = null;
this._opacity = 1;
this._UIEvents = [];
this._updateQueue = [];
this._nextUpdateQueue = [];
this._freedComponentIndicies = [];
this._components = [];
this._freedChildIndicies = [];
this._children = [];
this._fullChildren = [];
this._parent = null;
this._id = null;
this._transformID = null;
this._sizeID = null;
if (!this.constructor.NO_DEFAULT_COMPONENTS) this._init();
}
Node.RELATIVE_SIZE = 0;
Node.ABSOLUTE_SIZE = 1;
Node.RENDER_SIZE = 2;
Node.DEFAULT_SIZE = 0;
Node.NO_DEFAULT_COMPONENTS = false;
/**
* Protected method. Initializes a node with a default Transform and Size component
*
* @method
* @protected
*
* @return {undefined} undefined
*/
Node.prototype._init = function _init () {
this._transformID = this.addComponent(new Transform());
this._sizeID = this.addComponent(new Size());
};
/**
* Protected method. Sets the parent of this node such that it can be looked up.
*
* @method
*
* @param {Node} parent The node to set as the parent of this
*
* @return {undefined} undefined;
*/
Node.prototype._setParent = function _setParent (parent) {
if (this._parent && this._parent.getChildren().indexOf(this) !== -1) {
this._parent.removeChild(this);
}
this._parent = parent;
};
/**
* Protected method. Sets the mount state of the node. Should only be called
* by the dispatch
*
* @method
*
* @param {Boolean} mounted whether or not the Node is mounted.
* @param {String} path The path that the node will be mounted to
*
* @return {undefined} undefined
*/
Node.prototype._setMounted = function _setMounted (mounted, path) {
this._mounted = mounted;
this._id = path ? path : null;
};
/**
* Protected method, sets whether or not the Node is shown. Should only
* be called by the dispatch
*
* @method
*
* @param {Boolean} shown whether or not the node is shown
*
* @return {undefined} undefined
*/
Node.prototype._setShown = function _setShown (shown) {
this._shown = shown;
};
/**
* Protected method. Sets the updater of the node.
*
* @method
*
* @param {FamousEngine} updater the Updater of the node.
*
* @return {undefined} undefined
*/
Node.prototype._setUpdater = function _setUpdater (updater) {
this._updater = updater;
if (this._requestingUpdate) this._updater.requestUpdate(this);
};
/**
* Determine the node's location in the scene graph hierarchy.
* A location of `body/0/1` can be interpreted as the following scene graph
* hierarchy (ignoring siblings of ancestors and additional child nodes):
*
* `Context:body` -> `Node:0` -> `Node:1`, where `Node:1` is the node the
* `getLocation` method has been invoked on.
*
* @method getLocation
*
* @return {String} location (path), e.g. `body/0/1`
*/
Node.prototype.getLocation = function getLocation () {
return this._id;
};
/**
* @alias getId
*
* @return {String} the path of the Node
*/
Node.prototype.getId = Node.prototype.getLocation;
/**
* Dispatches the event using the Dispatch. All descendent nodes will
* receive the dispatched event.
*
* @method emit
*
* @param {String} event Event type.
* @param {Object} payload Event object to be dispatched.
*
* @return {Node} this
*/
Node.prototype.emit = function emit (event, payload) {
Dispatch.dispatch(this.getLocation(), event, payload);
return this;
};
// THIS WILL BE DEPRECATED
Node.prototype.sendDrawCommand = function sendDrawCommand (message) {
this._updater.message(message);
return this;
};
/**
* Recursively serializes the Node, including all previously added components.
*
* @method getValue
*
* @return {Object} Serialized representation of the node, including
* components.
*/
Node.prototype.getValue = function getValue () {
var numberOfChildren = this._children.length;
var numberOfComponents = this._components.length;
var i = 0;
var value = {
location: this.getId(),
spec: {
location: this.getId(),
showState: {
mounted: this.isMounted(),
shown: this.isShown(),
opacity: this.getOpacity() || null
},
offsets: {
mountPoint: [0, 0, 0],
align: [0, 0, 0],
origin: [0, 0, 0]
},
vectors: {
position: [0, 0, 0],
rotation: [0, 0, 0, 1],
scale: [1, 1, 1]
},
size: {
sizeMode: [0, 0, 0],
proportional: [1, 1, 1],
differential: [0, 0, 0],
absolute: [0, 0, 0],
render: [0, 0, 0]
}
},
UIEvents: this._UIEvents,
components: [],
children: []
};
if (value.location) {
var transform = TransformSystem.get(this.getId());
var size = SizeSystem.get(this.getId());
for (i = 0 ; i < 3 ; i++) {
value.spec.offsets.mountPoint[i] = transform.offsets.mountPoint[i];
value.spec.offsets.align[i] = transform.offsets.align[i];
value.spec.offsets.origin[i] = transform.offsets.origin[i];
value.spec.vectors.position[i] = transform.vectors.position[i];
value.spec.vectors.rotation[i] = transform.vectors.rotation[i];
value.spec.vectors.scale[i] = transform.vectors.scale[i];
value.spec.size.sizeMode[i] = size.sizeMode[i];
value.spec.size.proportional[i] = size.proportionalSize[i];
value.spec.size.differential[i] = size.differentialSize[i];
value.spec.size.absolute[i] = size.absoluteSize[i];
value.spec.size.render[i] = size.renderSize[i];
}
value.spec.vectors.rotation[3] = transform.vectors.rotation[3];
}
for (i = 0; i < numberOfChildren ; i++)
if (this._children[i] && this._children[i].getValue)
value.children.push(this._children[i].getValue());
for (i = 0 ; i < numberOfComponents ; i++)
if (this._components[i] && this._components[i].getValue)
value.components.push(this._components[i].getValue());
return value;
};
/**
* Similar to {@link Node#getValue}, but returns the actual "computed" value. E.g.
* a proportional size of 0.5 might resolve into a "computed" size of 200px
* (assuming the parent has a width of 400px).
*
* @method getComputedValue
*
* @return {Object} Serialized representation of the node, including
* children, excluding components.
*/
Node.prototype.getComputedValue = function getComputedValue () {
console.warn('Node.getComputedValue is depricated. Use Node.getValue instead');
var numberOfChildren = this._children.length;
var value = {
location: this.getId(),
computedValues: {
transform: this.isMounted() ? TransformSystem.get(this.getLocation()).getLocalTransform() : null,
size: this.isMounted() ? SizeSystem.get(this.getLocation()).get() : null
},
children: []
};
for (var i = 0 ; i < numberOfChildren ; i++)
if (this._children[i] && this._children[i].getComputedValue)
value.children.push(this._children[i].getComputedValue());
return value;
};
/**
* Retrieves all children of the current node.
*
* @method getChildren
*
* @return {Array.<Node>} An array of children.
*/
Node.prototype.getChildren = function getChildren () {
return this._fullChildren;
};
/**
* Method used internally to retrieve the children of a node. Each index in the
* returned array represents a path fragment.
*
* @method getRawChildren
* @private
*
* @return {Array} An array of children. Might contain `null` elements.
*/
Node.prototype.getRawChildren = function getRawChildren() {
return this._children;
};
/**
* Retrieves the parent of the current node. Unmounted nodes do not have a
* parent node.
*
* @method getParent
*
* @return {Node} Parent node.
*/
Node.prototype.getParent = function getParent () {
return this._parent;
};
/**
* Schedules the {@link Node#update} function of the node to be invoked on the
* next frame (if no update during this frame has been scheduled already).
* If the node is currently being updated (which means one of the requesters
* invoked requestsUpdate while being updated itself), an update will be
* scheduled on the next frame.
*
* @method requestUpdate
*
* @param {Object} requester If the requester has an `onUpdate` method, it
* will be invoked during the next update phase of
* the node.
*
* @return {Node} this
*/
Node.prototype.requestUpdate = function requestUpdate (requester) {
if (this._inUpdate || !this.isMounted())
return this.requestUpdateOnNextTick(requester);
if (this._updateQueue.indexOf(requester) === -1) {
this._updateQueue.push(requester);
if (!this._requestingUpdate) this._requestUpdate();
}
return this;
};
/**
* Schedules an update on the next tick. Similarily to
* {@link Node#requestUpdate}, `requestUpdateOnNextTick` schedules the node's
* `onUpdate` function to be invoked on the frame after the next invocation on
* the node's onUpdate function.
*
* @method requestUpdateOnNextTick
*
* @param {Object} requester If the requester has an `onUpdate` method, it
* will be invoked during the next update phase of
* the node.
*
* @return {Node} this
*/
Node.prototype.requestUpdateOnNextTick = function requestUpdateOnNextTick (requester) {
if (this._nextUpdateQueue.indexOf(requester) === -1)
this._nextUpdateQueue.push(requester);
return this;
};
/**
* Checks if the node is mounted. Unmounted nodes are detached from the scene
* graph.
*
* @method isMounted
*
* @return {Boolean} Boolean indicating whether the node is mounted or not.
*/
Node.prototype.isMounted = function isMounted () {
return this._mounted;
};
/**
* Checks if the node is being rendered. A node is being rendererd when it is
* mounted to a parent node **and** shown.
*
* @method isRendered
*
* @return {Boolean} Boolean indicating whether the node is rendered or not.
*/
Node.prototype.isRendered = function isRendered () {
return this._mounted && this._shown;
};
/**
* Checks if the node is visible ("shown").
*
* @method isShown
*
* @return {Boolean} Boolean indicating whether the node is visible
* ("shown") or not.
*/
Node.prototype.isShown = function isShown () {
return this._shown;
};
/**
* Determines the node's relative opacity.
* The opacity needs to be within [0, 1], where 0 indicates a completely
* transparent, therefore invisible node, whereas an opacity of 1 means the
* node is completely solid.
*
* @method getOpacity
*
* @return {Number} Relative opacity of the node.
*/
Node.prototype.getOpacity = function getOpacity () {
return this._opacity;
};
/**
* Determines the node's previously set mount point.
*
* @method getMountPoint
*
* @return {Float32Array} An array representing the mount point.
*/
Node.prototype.getMountPoint = function getMountPoint () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._transformID).getMountPoint();
else if (this.isMounted())
return TransformSystem.get(this.getLocation()).getMountPoint();
else throw new Error('This node does not have access to a transform component');
};
/**
* Determines the node's previously set align.
*
* @method getAlign
*
* @return {Float32Array} An array representing the align.
*/
Node.prototype.getAlign = function getAlign () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._transformID).getAlign();
else if (this.isMounted())
return TransformSystem.get(this.getLocation()).getAlign();
else throw new Error('This node does not have access to a transform component');
};
/**
* Determines the node's previously set origin.
*
* @method getOrigin
*
* @return {Float32Array} An array representing the origin.
*/
Node.prototype.getOrigin = function getOrigin () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._transformID).getOrigin();
else if (this.isMounted())
return TransformSystem.get(this.getLocation()).getOrigin();
else throw new Error('This node does not have access to a transform component');
};
/**
* Determines the node's previously set position.
*
* @method getPosition
*
* @return {Float32Array} An array representing the position.
*/
Node.prototype.getPosition = function getPosition () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._transformID).getPosition();
else if (this.isMounted())
return TransformSystem.get(this.getLocation()).getPosition();
else throw new Error('This node does not have access to a transform component');
};
/**
* Returns the node's current rotation
*
* @method getRotation
*
* @return {Float32Array} an array of four values, showing the rotation as a quaternion
*/
Node.prototype.getRotation = function getRotation () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._transformID).getRotation();
else if (this.isMounted())
return TransformSystem.get(this.getLocation()).getRotation();
else throw new Error('This node does not have access to a transform component');
};
/**
* Returns the scale of the node
*
* @method
*
* @return {Float32Array} an array showing the current scale vector
*/
Node.prototype.getScale = function getScale () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._transformID).getScale();
else if (this.isMounted())
return TransformSystem.get(this.getLocation()).getScale();
else throw new Error('This node does not have access to a transform component');
};
/**
* Returns the current size mode of the node
*
* @method
*
* @return {Float32Array} an array of numbers showing the current size mode
*/
Node.prototype.getSizeMode = function getSizeMode () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._sizeID).getSizeMode();
else if (this.isMounted())
return SizeSystem.get(this.getLocation()).getSizeMode();
else throw new Error('This node does not have access to a size component');
};
/**
* Returns the current proportional size
*
* @method
*
* @return {Float32Array} a vector 3 showing the current proportional size
*/
Node.prototype.getProportionalSize = function getProportionalSize () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._sizeID).getProportional();
else if (this.isMounted())
return SizeSystem.get(this.getLocation()).getProportional();
else throw new Error('This node does not have access to a size component');
};
/**
* Returns the differential size of the node
*
* @method
*
* @return {Float32Array} a vector 3 showing the current differential size
*/
Node.prototype.getDifferentialSize = function getDifferentialSize () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._sizeID).getDifferential();
else if (this.isMounted())
return SizeSystem.get(this.getLocation()).getDifferential();
else throw new Error('This node does not have access to a size component');
};
/**
* Returns the absolute size of the node
*
* @method
*
* @return {Float32Array} a vector 3 showing the current absolute size of the node
*/
Node.prototype.getAbsoluteSize = function getAbsoluteSize () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._sizeID).getAbsolute();
else if (this.isMounted())
return SizeSystem.get(this.getLocation()).getAbsolute();
else throw new Error('This node does not have access to a size component');
};
/**
* Returns the current Render Size of the node. Note that the render size
* is asynchronous (will always be one frame behind) and needs to be explicitely
* calculated by setting the proper size mode.
*
* @method
*
* @return {Float32Array} a vector 3 showing the current render size
*/
Node.prototype.getRenderSize = function getRenderSize () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._sizeID).getRender();
else if (this.isMounted())
return SizeSystem.get(this.getLocation()).getRender();
else throw new Error('This node does not have access to a size component');
};
/**
* Returns the external size of the node
*
* @method
*
* @return {Float32Array} a vector 3 of the final calculated side of the node
*/
Node.prototype.getSize = function getSize () {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
return this.getComponent(this._sizeID).get();
else if (this.isMounted())
return SizeSystem.get(this.getLocation()).get();
else throw new Error('This node does not have access to a size component');
};
/**
* Returns the current world transform of the node
*
* @method
*
* @return {Float32Array} a 16 value transform
*/
Node.prototype.getTransform = function getTransform () {
return TransformSystem.get(this.getLocation());
};
/**
* Get the list of the UI Events that are currently associated with this node
*
* @method
*
* @return {Array} an array of strings representing the current subscribed UI event of this node
*/
Node.prototype.getUIEvents = function getUIEvents () {
return this._UIEvents;
};
/**
* Adds a new child to this node. If this method is called with no argument it will
* create a new node, however it can also be called with an existing node which it will
* append to the node that this method is being called on. Returns the new or passed in node.
*
* @method
*
* @param {Node | void} child the node to appended or no node to create a new node.
*
* @return {Node} the appended node.
*/
Node.prototype.addChild = function addChild (child) {
var index = child ? this._children.indexOf(child) : -1;
child = child ? child : new Node();
if (index === -1) {
index = this._freedChildIndicies.length ?
this._freedChildIndicies.pop() : this._children.length;
this._children[index] = child;
this._fullChildren.push(child);
}
if (this.isMounted())
child.mount(this.getLocation() + '/' + index);
return child;
};
/**
* Removes a child node from another node. The passed in node must be
* a child of the node that this method is called upon.
*
* @method
*
* @param {Node} child node to be removed
*
* @return {Boolean} whether or not the node was successfully removed
*/
Node.prototype.removeChild = function removeChild (child) {
var index = this._children.indexOf(child);
if (index > - 1) {
this._freedChildIndicies.push(index);
this._children[index] = null;
if (child.isMounted()) child.dismount();
var fullChildrenIndex = this._fullChildren.indexOf(child);
var len = this._fullChildren.length;
var i = 0;
for (i = fullChildrenIndex; i < len-1; i++)
this._fullChildren[i] = this._fullChildren[i + 1];
this._fullChildren.pop();
return true;
}
else {
return false;
}
};
/**
* Each component can only be added once per node.
*
* @method addComponent
*
* @param {Object} component A component to be added.
* @return {Number} index The index at which the component has been
* registered. Indices aren't necessarily
* consecutive.
*/
Node.prototype.addComponent = function addComponent (component) {
var index = this._components.indexOf(component);
if (index === -1) {
index = this._freedComponentIndicies.length ? this._freedComponentIndicies.pop() : this._components.length;
this._components[index] = component;
if (this.isMounted() && component.onMount)
component.onMount(this, index);
if (this.isShown() && component.onShow)
component.onShow();
}
return index;
};
/**
* @method getComponent
*
* @param {Number} index Index at which the component has been registered
* (using `Node#addComponent`).
* @return {*} The component registered at the passed in index (if
* any).
*/
Node.prototype.getComponent = function getComponent (index) {
return this._components[index];
};
/**
* Removes a previously via {@link Node#addComponent} added component.
*
* @method removeComponent
*
* @param {Object} component An component that has previously been added
* using {@link Node#addComponent}.
*
* @return {Node} this
*/
Node.prototype.removeComponent = function removeComponent (component) {
var index = this._components.indexOf(component);
if (index !== -1) {
this._freedComponentIndicies.push(index);
if (this.isShown() && component.onHide)
component.onHide();
if (this.isMounted() && component.onDismount)
component.onDismount();
this._components[index] = null;
}
return component;
};
/**
* Removes a node's subscription to a particular UIEvent. All components
* on the node will have the opportunity to remove all listeners depending
* on this event.
*
* @method
*
* @param {String} eventName the name of the event
*
* @return {undefined} undefined
*/
Node.prototype.removeUIEvent = function removeUIEvent (eventName) {
var UIEvents = this.getUIEvents();
var components = this._components;
var component;
var index = UIEvents.indexOf(eventName);
if (index !== -1) {
UIEvents.splice(index, 1);
for (var i = 0, len = components.length ; i < len ; i++) {
component = components[i];
if (component && component.onRemoveUIEvent) component.onRemoveUIEvent(eventName);
}
}
};
/**
* Subscribes a node to a UI Event. All components on the node
* will have the opportunity to begin listening to that event
* and alerting the scene graph.
*
* @method
*
* @param {String} eventName the name of the event
*
* @return {Node} this
*/
Node.prototype.addUIEvent = function addUIEvent (eventName) {
var UIEvents = this.getUIEvents();
var components = this._components;
var component;
var added = UIEvents.indexOf(eventName) !== -1;
if (!added) {
UIEvents.push(eventName);
for (var i = 0, len = components.length ; i < len ; i++) {
component = components[i];
if (component && component.onAddUIEvent) component.onAddUIEvent(eventName);
}
}
return this;
};
/**
* Private method for the Node to request an update for itself.
*
* @method
* @private
*
* @param {Boolean} force whether or not to force the update
*
* @return {undefined} undefined
*/
Node.prototype._requestUpdate = function _requestUpdate (force) {
if (force || !this._requestingUpdate) {
if (this._updater)
this._updater.requestUpdate(this);
this._requestingUpdate = true;
}
};
/**
* Private method to set an optional value in an array, and
* request an update if this changes the value of the array.
*
* @method
*
* @param {Array} vec the array to insert the value into
* @param {Number} index the index at which to insert the value
* @param {Any} val the value to potentially insert (if not null or undefined)
*
* @return {Boolean} whether or not a new value was inserted.
*/
Node.prototype._vecOptionalSet = function _vecOptionalSet (vec, index, val) {
if (val != null && vec[index] !== val) {
vec[index] = val;
if (!this._requestingUpdate) this._requestUpdate();
return true;
}
return false;
};
/**
* Shows the node, which is to say, calls onShow on all of the
* node's components. Renderable components can then issue the
* draw commands necessary to be shown.
*
* @method
*
* @return {Node} this
*/
Node.prototype.show = function show () {
Dispatch.show(this.getLocation());
this._shown = true;
return this;
};
/**
* Hides the node, which is to say, calls onHide on all of the
* node's components. Renderable components can then issue
* the draw commands necessary to be hidden
*
* @method
*
* @return {Node} this
*/
Node.prototype.hide = function hide () {
Dispatch.hide(this.getLocation());
this._shown = false;
return this;
};
/**
* Sets the align value of the node. Will call onAlignChange
* on all of the Node's components.
*
* @method
*
* @param {Number} x Align value in the x dimension.
* @param {Number} y Align value in the y dimension.
* @param {Number} z Align value in the z dimension.
*
* @return {Node} this
*/
Node.prototype.setAlign = function setAlign (x, y, z) {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
this.getComponent(this._transformID).setAlign(x, y, z);
else if (this.isMounted())
TransformSystem.get(this.getLocation()).setAlign(x, y, z);
else throw new Error('This node does not have access to a transform component');
return this;
};
/**
* Sets the mount point value of the node. Will call onMountPointChange
* on all of the node's components.
*
* @method
*
* @param {Number} x MountPoint value in x dimension
* @param {Number} y MountPoint value in y dimension
* @param {Number} z MountPoint value in z dimension
*
* @return {Node} this
*/
Node.prototype.setMountPoint = function setMountPoint (x, y, z) {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
this.getComponent(this._transformID).setMountPoint(x, y, z);
else if (this.isMounted())
TransformSystem.get(this.getLocation()).setMountPoint(x, y, z);
else throw new Error('This node does not have access to a transform component');
return this;
};
/**
* Sets the origin value of the node. Will call onOriginChange
* on all of the node's components.
*
* @method
*
* @param {Number} x Origin value in x dimension
* @param {Number} y Origin value in y dimension
* @param {Number} z Origin value in z dimension
*
* @return {Node} this
*/
Node.prototype.setOrigin = function setOrigin (x, y, z) {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
this.getComponent(this._transformID).setOrigin(x, y, z);
else if (this.isMounted())
TransformSystem.get(this.getLocation()).setOrigin(x, y, z);
else throw new Error('This node does not have access to a transform component');
return this;
};
/**
* Sets the position of the node. Will call onPositionChange
* on all of the node's components.
*
* @method
*
* @param {Number} x Position in x
* @param {Number} y Position in y
* @param {Number} z Position in z
*
* @return {Node} this
*/
Node.prototype.setPosition = function setPosition (x, y, z) {
if (!this.constructor.NO_DEFAULT_COMPONENTS)
this.getComponent(this._transformID).setPosition(x, y, z);
else if (this.isMounted())
TransformSystem.get(this.getLocation()).setPosition(x, y, z);
else throw new Error('This node does not have access to a transform component');