-
Notifications
You must be signed in to change notification settings - Fork 0
/
display_InteractiveObject.js.html
1224 lines (1104 loc) · 43.3 KB
/
display_InteractiveObject.js.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: display/InteractiveObject.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: display/InteractiveObject.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>//------------------------------------------------------------------------------
// Constructor scope
//------------------------------------------------------------------------------
/**
* Creates a new InteractiveObject.
*
* @constructor
* @extends rune.geom.Rectangle
* @abstract
*
* @param {number} [x=0.0] The x coordinate of the top-left corner of the rectangle.
* @param {number} [y=0.0] The y coordinate of the top-left corner of the rectangle.
* @param {number} [width=0.0] The y coordinate of the top-left corner of the rectangle.
* @param {number} [height=0.0] The height of the rectangle, in pixels.
*
* @class
* @classdesc
*
* The InteractiveObject class is the abstract base class for all display
* objects with which the user can interact, using the mouse, keyboard, or
* other user input device.
*/
rune.display.InteractiveObject = function(x, y, width, height) {
//--------------------------------------------------------------------------
// Public properties
//--------------------------------------------------------------------------
/**
* The mass of the object. This value is used to calculate the impact when
* the object collides with another object with mass.
*
* @type {number}
* @default 1.0
*/
this.mass = 1.0;
/**
* The elasticity of the object. Used to calculate the impact when two
* objects collide with each other. The greater the value, the more bouncy
* the object behaves.
*
* @type {number}
* @default 0.0
*/
this.elasticity = 0.0;
/**
* Used in collision handling. If an object is sticky, other objects
* placed on top of the object may follow its movement. This is useful
* when developing platform games as a player can, for example, ride on
moving platforms or other objects.
*
* @type {boolean}
* @default false
*/
this.sticky = false;
//--------------------------------------------------------------------------
// Protected properties
//--------------------------------------------------------------------------
/**
* Whether the object should be automatically updated by its parent object.
* Inactive objects are still rendered. the default value is true.
*
* @type {boolean}
* @protected
* @ignore
*/
this.m_active = true;
/**
* Describes the type of collision to which the object responds.
*
* @type {number}
* @protected
* @ignore
*/
this.m_allowCollisions = rune.physics.Space.ANY;
/**
* Represents a boundary box used for collision detection.
*
* @type {rune.display.Hitbox}
* @protected
* @ignore
*/
this.m_hitbox = null;
/**
* Whether the object may change position when it collides with another
* object.
*
* @type {boolean}
* @protected
* @ignore
*/
this.m_immovable = false;
/**
* Whether the object should be moved automatically when it is assigned
* velocity. Not all interactive objects need this functionality enabled.
*
* @type {boolean}
* @protected
* @ignore
*/
this.m_movable = false;
/**
* The object's x position from the previous update.
*
* @type {number}
* @protected
* @ignore
*/
this.m_previousX = x || 0.0;
/**
* The object's y position from the previous update.
*
* @type {number}
* @protected
* @ignore
*/
this.m_previousY = y || 0.0;
/**
* The object's current scale in the x and y directions.
*
* @type {rune.geom.Point}
* @protected
* @ignore
*/
this.m_scale = new rune.geom.Point(1.0, 1.0);
/**
* A finite-state machine.
*
* @type {rune.state.States}
* @protected
* @ignore
*/
this.m_states = null;
/**
* Indicates whether the object collides with another object.
*
* @type {number}
* @protected
* @ignore
*/
this.m_touching = rune.physics.Space.NONE;
/**
* Indicates whether the object collided with another object during the
* previous check.
*
* @type {number}
* @protected
* @ignore
*/
this.m_touched = rune.physics.Space.NONE;
/**
* The velocity of the object. This object is used to calculate the
* object's direction of travel and speed. Note that the object is only
* used when the movable property is set to true.
*
* @type {rune.physics.Velocity}
* @protected
* @ignore
*/
this.m_velocity = new rune.physics.Velocity(0, 0);
//--------------------------------------------------------------------------
// Super call
//--------------------------------------------------------------------------
/**
* Extend rune.geom.Rectangle
*/
rune.geom.Rectangle.call(this, x, y, width, height);
//--------------------------------------------------------------------------
// Constructor call
//--------------------------------------------------------------------------
/**
* Invokes secondary class constructor.
*/
this.m_construct();
};
//------------------------------------------------------------------------------
// Inheritance
//------------------------------------------------------------------------------
rune.display.InteractiveObject.prototype = Object.create(rune.geom.Rectangle.prototype);
rune.display.InteractiveObject.prototype.constructor = rune.display.InteractiveObject;
//------------------------------------------------------------------------------
// Override public getter and setter methods
//------------------------------------------------------------------------------
/**
* Indicates the height of the object, in pixels.
*
* @member {number} height
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "height", {
/**
* @this rune.display.InteractiveObject
* @ignore
* @suppress {accessControls}
*/
get : function() {
return this.m_height * this.m_scale.y;
},
/**
* @this rune.display.InteractiveObject
* @ignore
* @suppress {accessControls}
*/
set : function(value) {
value = value / this.m_scale.y;
this.m_height = value;
}
});
/**
* Indicates the width of the object, in pixels.
*
* @member {number} width
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "width", {
/**
* @this rune.display.InteractiveObject
* @ignore
* @suppress {accessControls}
*/
get : function() {
return this.m_width * this.m_scale.x;
},
/**
* @this rune.display.InteractiveObject
* @ignore
* @suppress {accessControls}
*/
set : function(value) {
value = value / this.m_scale.x;
this.m_width = value;
}
});
//------------------------------------------------------------------------------
// Public getter and setter methods (API)
//------------------------------------------------------------------------------
/**
* Whether the object should be automatically updated by its parent object.
* Inactive objects are still rendered. the default value is true.
*
* @member {boolean} active
* @memberof rune.display.InteractiveObject
* @instance
* @default true
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "active", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_active;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
this.m_active = value;
}
});
/**
* Describes the type of collision to which the object responds.
*
* @member {number} allowCollisions
* @memberof rune.display.InteractiveObject
* @instance
* @default rune.physics.Space.ANY
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "allowCollisions", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_allowCollisions;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
this.m_allowCollisions = value;
}
});
/**
* Reference to the application's entry point class, ie. the main class of the
* application. Useful for accessing the application's subsystem.
*
* @member {rune.system.Application} application
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "application", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return rune.system.Application['instance'];
}
});
/**
* Reference to the application's subsystem for connected gamepad devices.
*
* @member {rune.input.Gamepads} gamepads
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "gamepads", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return rune.system.Application['instance']['inputs']['gamepads'];
}
});
/**
* Represents a boundary box used for collision detection. Use the object's
* set() method to specify position and size. By default, it is positioned at
* 0, 0 and has the same size as the interactive object.
*
* @member {rune.display.Hitbox} hitbox
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "hitbox", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_hitbox;
}
});
/**
* Whether the object may change position when it collides with another
* object.
*
* @member {boolean} immovable
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "immovable", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_immovable;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
this.m_immovable = value;
}
});
/**
* Reference to the keyboard manager. Use this reference to read the state of
* any keyboard key.
*
* @member {rune.input.Keyboard} keyboard
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "keyboard", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return rune.system.Application['instance']['inputs']['keyboard'];
}
});
/**
* Whether the object may change position when it collides with another
* object.
*
* @member {boolean} immovable
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "movable", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_movable;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
this.m_movable = value;
}
});
/**
* Indicates the horizontal scale (percentage) of the object as applied from
* the upper left corner. 1.0 is 100% scale.
*
* @member {number} scaleX
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "scaleX", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_scale.x;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
value = rune.util.Math.clamp(value, 0, Infinity);
this.m_scale.x = value;
}
});
/**
* Indicates the vertical scale (percentage) of an object as applied from the
* upper left corner. 1.0 is 100% scale.
*
* @member {number} scaleY
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "scaleY", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_scale.y;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
value = rune.util.Math.clamp(value, 0, Infinity);
this.m_scale.y = value;
}
});
/**
* A finite-state machine. Use this reference to apply isolated behavioral
* states to the object.
*
* @member {rune.state.States} states
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "states", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_states;
}
});
/**
* Whether the object touched another object in the previous update. See
* [touching]{@link rune.display.InteractiveObject#touching} for more
* information.
*
* @see rune.physics.Space
*
* @member {number} touched
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "touched", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_touched;
}
});
/**
* Whether the object touches another object and in such cases in which
* directions. The value is represented by a bit field and thus several
* directions can be true at the same time.
*
* @see rune.physics.Space
*
* @member {number} touching
* @memberof rune.display.InteractiveObject
* @instance
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "touching", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_touching;
},
/**
* @this rune.display.InteractiveObject
* @ignore
*/
set : function(value) {
this.m_touching = value;
}
});
/**
* The velocity of the object. This object is used to calculate the object's
* direction of travel, as well as its speed. Note that the object is only
* used when the movable property is set to true.
*
* @member {rune.physics.Velocity} velocity
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "velocity", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_velocity;
}
});
//------------------------------------------------------------------------------
// Public getter and setter methods (ENGINE)
//------------------------------------------------------------------------------
/**
* The object's x position from the previous update. This value is used to
* calculate motion in the event of a collision.
*
* @member {number} previousX
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
* @ignore
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "previousX", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_previousX;
}
});
/**
* The object's y position from the previous update. This value is used to
* calculate motion in the event of a collision.
*
* @member {number} previousY
* @memberof rune.display.InteractiveObject
* @instance
* @readonly
* @ignore
*/
Object.defineProperty(rune.display.InteractiveObject.prototype, "previousY", {
/**
* @this rune.display.InteractiveObject
* @ignore
*/
get : function() {
return this.m_previousY;
}
});
//------------------------------------------------------------------------------
// Public prototype methods (API)
//------------------------------------------------------------------------------
/**
* Evaluates whether the object's hitbox overlaps or intersects with the
* parameter object's hitbox.
*
* @param {rune.display.Stage|rune.display.InteractiveObject|rune.display.DisplayGroup|rune.tilemap.TilemapLayer|rune.geom.Point|Array} obj The object to be evaluated.
* @param {Function} [callback] Executed for each detected collision.
* @param {Object} [scope] Scope of execution for the callback method.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.hitTest = function(obj, callback, scope) {
if (obj instanceof rune.display.Stage) return this.hitTestChildrenOf(obj, callback, scope);
else if (obj instanceof rune.display.InteractiveObject) return this.hitTestObject(obj, callback, scope);
else if (obj instanceof rune.display.DisplayGroup) return this.hitTestGroup(obj, callback, scope);
else if (obj instanceof rune.tilemap.TilemapLayer) return this.hitTestTilemapLayer(obj, callback, scope);
else if (obj instanceof rune.geom.Point) return this.hitTestPoint(obj, callback, scope);
else if (obj instanceof Array) return this.hitTestContentOf(obj, callback, scope);
else return false;
};
/**
* Evaluates the bounding box of the interactive object to see if it overlaps
* or intersects the bounding box of any of the container object's children.
* The method returns true if this happens to any of the children. The callback
* method is activated for each child that is overlapped.
*
* @param {rune.display.DisplayObjectContainer} parent Container object whose children are to be checked.
* @param {Function} [callback] Executed for each detected collision.
* @param {Object} [scope] Scope of execution for the callback method.
*
* @throws {Error} If the specified argument is not of type DisplayObjectContainer.
*
* @returns {boolean} If any of the container object's children are overlapped by this object, true is returned, otherwise false.
*/
rune.display.InteractiveObject.prototype.hitTestChildrenOf = function(parent, callback, scope) {
if (parent instanceof rune.display.DisplayObjectContainer) {
var children = parent.getChildren();
var output = false;
var i = children.length;
while (i--) {
if (this != children[i]) {
if (this.hitTestObject(children[i], callback, scope)) {
output = true;
}
}
}
} else throw new Error();
return output;
};
/**
* Evaluates whether the object's hitbox overlaps or intersects the
* hitbox of any other object in the specified list. The list can
* contain a mixture of data types, provided that each data type is
* supported by the hitTest method.
*
* @param {Array} array Container object whose children are to be checked.
* @param {Function} [callback] Executed for each detected collision.
* @param {Object} [scope] Scope of execution for the callback method.
*
* @throws {Error} If the specified argument is not of type DisplayObjectContainer.
*
* @returns {boolean} If any of the container object's children are overlapped by this object, true is returned, otherwise false.
*/
rune.display.InteractiveObject.prototype.hitTestContentOf = function(array, callback, scope) {
var result = false;
for (var i = 0; i < array.length; i++) {
if (this.hitTest(array[i], callback, scope)) {
result = true;
}
}
return result;
};
/**
* Evaluates the bounding box of the interactive object to see if it overlaps
* or intersects with the bounding box of the obj interactive object.
*
* @param {rune.display.InteractiveObject} obj The interactive object to test against.
* @param {Function} [callback] Executed in case of collision.
* @param {Object} [scope] Scope of execution for callback method.
*
* @returns {boolean} true if the bounding boxes of the interactive objects intersect; false if not.
*/
rune.display.InteractiveObject.prototype.hitTestObject = function(obj, callback, scope) {
if (obj != null && obj['hitbox'] != null && this['hitbox'] != null) {
if (rune.geom.Rectangle.intersects(
this['hitbox']['x'],
this['hitbox']['y'],
this['hitbox']['width'],
this['hitbox']['height'],
obj['hitbox']['x'],
obj['hitbox']['y'],
obj['hitbox']['width'],
obj['hitbox']['height']
)) {
if (typeof callback === "function") {
callback.call(scope || this, this, obj);
}
return true;
}
}
return false;
};
/**
* Evaluates whether the object's hitbox overlaps or intersects the hitbox of
* any member of a group. The evaluation is carried out against all members of
* the group. The method returns true if there was an overlap, false otherwise.
*
* @param {rune.display.DisplayGroup} group Group to evaluate.
* @param {Function} [callback] Executed automatically in case of overlap.
* @param {Object} [scope] Scope within the callback method must be executed.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.hitTestGroup = function(group, callback, scope) {
var result = false;
group.forEachMember(function(member) {
if (this.hitTestObject(member, callback, scope)) {
result = true;
}
}, this);
return result;
};
/**
* Evaluates whether the object's hitbox overlaps or intersects a solid tile
* within a tilemap layer.
*
* @param {rune.tilemap.TilemapLayer} layer Layer to evaluate.
* @param {Function} [callback] Executed automatically in case of overlap.
* @param {Object} [scope] Scope within the callback method must be executed.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.hitTestTilemapLayer = function(layer, callback, scope) {
return layer.hitTest(this, callback, scope);
};
/**
* Evaluates and resolves collision between the object's hitbox and the given
* argument object.
*
* @param {rune.display.Stage|rune.display.InteractiveObject|rune.display.DisplayGroup|rune.tilemap.TilemapLayer|Array} obj The object to be evaluated.
* @param {Function} [callback] Executed automatically in case of overlap.
* @param {Object} [scope] Scope within the callback method must be executed.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.hitTestAndSeparate = function(obj, callback, scope) {
if (obj instanceof rune.display.Stage) return this.hitTestAndSeparateChildrenOf(obj, callback, scope);
else if (obj instanceof rune.display.InteractiveObject) return this.hitTestAndSeparateObject(obj, callback, scope);
else if (obj instanceof rune.display.DisplayGroup) return this.hitTestAndSeparateGroup(obj, callback, scope);
else if (obj instanceof rune.tilemap.TilemapLayer) return this.hitTestAndSeparateTilemapLayer(obj, callback, scope);
else if (obj instanceof Array) return this.hitTestAndSeparateContentOf(obj, callback, scope);
else return false;
};
/**
* Evaluates and resolves collision between this object's hitbox and the
* hitbox of all children of the specified argument object. Note that this
* method does not include the actual argument object, only its children.
*
* @param {rune.display.DisplayObjectContainer} parent The container object to be evaluated.
* @param {Function} [callback] Executed automatically in case of overlap.
* @param {Object} [scope] Scope within the callback method must be executed.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.hitTestAndSeparateChildrenOf = function(parent, callback, scope) {
var result = false;
parent.forEachChild(function(child) {
if (this.hitTestAndSeparateObject(child, callback, scope)) {
result = true;
}
}, this);
return result;
};
/**
* Evaluates and resolves hitbox-based collision between the object
* and other objects in a list structure (array).
*
* @param {Array} array The array object to be evaluated.
* @param {Function} [callback] Executed automatically in case of overlap.
* @param {Object} [scope] Scope within the callback method must be executed.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.hitTestAndSeparateContentOf = function(array, callback, scope) {
var result = false;
for (var i = 0; i < array.length; i++) {
if (this.hitTestAndSeparate(array[i], callback, scope)) {
result = true;
}
}
return result;
};
/**
* Evaluates whether the object's bounding box overlaps a bounding box of
* another object and in the event of a collision, the objects are separated
* in order to resolve the collision.
*
* @param {rune.display.InteractiveObject} obj The interactive object to test against.
* @param {Function} [callback=null] Executed in case of collision.
* @param {Object} [scope=this] Scope of execution for callback method.
*
* @returns {boolean} True if there was a collision, otherwise false.
*/
rune.display.InteractiveObject.prototype.hitTestAndSeparateObject = function(obj, callback, scope) {
if (this.hitTestObject(obj)) {
if (rune.physics.Space.separate(this, obj)) {
if (typeof callback === "function") {
callback.call(scope || this, this, obj);
}
}
return true;
}
return false;
};
/**
* Evaluates whether this object's hitbox overlaps or intersects any hitbox of
* the members of the specified group object.
*
* @param {rune.display.DisplayGroup} group Group to evaluate.
* @param {Function} [callback=null] Executed in case of collision.
* @param {Object} [scope=this] Scope of execution for callback method.
*
* @returns {boolean} True if there was a collision, otherwise false.
*/
rune.display.InteractiveObject.prototype.hitTestAndSeparateGroup = function(group, callback, scope) {
var result = false;
group.forEachMember(function(member) {
if (this.hitTestAndSeparateObject(member, callback, scope)) {
result = true;
}
}, this);
return result;
};
/**
* Evaluates, and resolves, collision between this object's hitbox and any
* solid tile within the specified tilemap layer.
*
* @param {rune.tilemap.TilemapLayer} layer Layer to evaluate.
* @param {Function} [callback=null] Executed in case of collision.
* @param {Object} [scope=this] Scope of execution for callback method.
*
* @returns {boolean} True if there was a collision, otherwise false.
*/
rune.display.InteractiveObject.prototype.hitTestAndSeparateTilemapLayer = function(layer, callback, scope) {
return layer.hitTestAndSeparate(this, callback, scope);
};
/**
* Evaluates the bounding box of the interactive object to see if it overlaps
* or intersects with a point object.
*
* @param {rune.geom.Point} point The point object to test against.
* @param {Function} [callback] Executed in case of collision.
* @param {Object} [scope] Scope of execution for callback method.
*
* @returns {boolean} true if the display object overlaps or intersects with the specified point; false otherwise.
*/
rune.display.InteractiveObject.prototype.hitTestPoint = function(point, callback, scope) {
if (rune.geom.Rectangle.containsPoint(
this['hitbox']['x'],
this['hitbox']['y'],
this['hitbox']['width'],
this['hitbox']['height'],
point['x'] || 0.0,
point['y'] || 0.0
)) {
if (typeof callback === "function") {
callback.call(scope || this, this, point);
}
return true;
}
return false;
};
/**
* Test whether the object touches another object in one or more directions.
* The test does not tell what the object touches, only whether it does so
* (true) or not (false).
*
* @param {number} direction Bit field with directions to check.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.isTouching = function(direction) {
return (this.m_touching & direction) > rune.physics.Space.NONE;
};
/**
* Tests if the object touched other objects during the previous update.
*
* @param {number} direction Bit field with directions to check.
*
* @returns {boolean}
*/
rune.display.InteractiveObject.prototype.justTouched = function(direction) {
return ((this.m_touching & direction) > rune.physics.Space.NONE) &&
((this.m_touched & direction) <= rune.physics.Space.NONE);
};
/**
* Moves an object to the specified position (x and y coordinates). This method
* can be used when an object needs to be moved without physical limitations.
*
* @param {number} x X coordinate to move to.
* @param {number} y Y coordinate to move to.
*
* @returns {undefined}
*/
rune.display.InteractiveObject.prototype.moveTo = function(x, y) {
this.m_x = x;