This repository was archived by the owner on Mar 18, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdebugPanel.js
More file actions
554 lines (443 loc) · 19.2 KB
/
debugPanel.js
File metadata and controls
554 lines (443 loc) · 19.2 KB
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
import {
video,
Renderable,
utils,
BitmapText,
Rect,
event,
plugin,
Entity,
Container,
Camera2d,
ImageLayer,
Text,
game,
input,
timer,
Math,
pool,
collision
} from "melonjs";
import Counters from "./counters";
import fontImageSource from "./font/PressStart2P.png";
import fontDataSource from "./font/PressStart2P.fnt";
const DEBUG_HEIGHT = 50;
export class DebugPanel extends Renderable {
constructor(debugToggle) {
// call the super constructor
super(0, 0, video.renderer.width, DEBUG_HEIGHT );
// enable collision and event detection
this.isKinematic = false;
// to hold the debug CheckBox
// zone and status
this.checkbox = {};
// Useful counters
this.counters = new Counters([
"shapes",
"sprites",
"velocity",
"bounds",
"children"
]);
// for z ordering
// make it ridiculously high
this.pos.z = Infinity;
// visibility flag
this.visible = false;
// frame update time in ms
this.frameUpdateTime = 0;
// frame draw time in ms
this.frameDrawTime = 0;
// set the object GUID value
this.GUID = "debug-" + utils.createGUID();
// set the object entity name
this.name = "debugPanel";
// the debug panel version
this.version = "__VERSION__";
// persistent
this.isPersistent = true;
// a floating object
this.floating = true;
// renderable
this.isRenderable = true;
// always update, even when not visible
this.alwaysUpdate = true;
// WebGL/Canvas compatibility
this.canvas = video.createCanvas(this.width, this.height, true);
// create a default font, with fixed char width
this.font_size = 10;
this.mod = 2;
if (this.width < 500) {
this.font_size = 7;
this.mod = this.mod * (this.font_size / 10);
}
// create the bitmapfont
var fontImage = new Image();
fontImage.src = fontImageSource;
this.font = new BitmapText(0, 0, {
fontData: fontDataSource,
font: fontImage
});
this.font.name = "debugPanelFont";
// clickable areas
var hash = utils.getUriFragment();
var size = 10 * this.mod;
this.checkbox.renderHitBox = new Rect(250, 2, size, size);
this.checkbox.renderHitBox.selected = hash.hitbox || false;
this.checkbox.renderVelocity = new Rect(250, 17, size, size);
this.checkbox.renderVelocity.selected = hash.velocity || false;
this.checkbox.renderQuadTree = new Rect(410, 2, size, size);
this.checkbox.renderVelocity.selected = hash.quadtree || false;
// add some keyboard shortcuts
this.debugToggle = debugToggle;
// some internal string/length
this.help_str = "["+String.fromCharCode(32 + this.debugToggle)+"]show/hide";
this.help_str_len = this.font.measureText(this.help_str).width;
this.fps_str_len = this.font.measureText("00/00 fps").width;
this.memoryPositionX = 325 * this.mod;
// resize the panel if the browser is resized
event.on(event.CANVAS_ONRESIZE, (w) => {
this.resize(w, DEBUG_HEIGHT);
});
// few variables to keep track of time
this.frameUpdateStartTime = 0;
this.frameDrawStartTime = 0;
this.frameUpdateTime = 0;
this.frameDrawTime = 0;
event.on(event.GAME_BEFORE_UPDATE, (time) => {
this.frameUpdateStartTime = time;
});
event.on(event.GAME_AFTER_UPDATE, (time) => {
this.frameUpdateTime = time - this.frameUpdateStartTime;
});
event.on(event.GAME_BEFORE_DRAW, (time) => {
this.frameDrawStartTime = time;
this.counters.reset();
});
event.on(event.GAME_AFTER_DRAW, (time) => {
this.frameDrawTime = time - this.frameDrawStartTime;
});
this.anchorPoint.set(0, 0);
//patch patch patch !
this.patchSystemFn();
}
/**
* patch system fn to draw debug information
*/
patchSystemFn() {
var _this = this;
// patch renderable.js
plugin.patch(Renderable, "postDraw", function (renderer) {
// call the original Renderable.postDraw function
this._patched.apply(this, arguments);
// increment the sprites counter
if (typeof this.image !== "undefined") {
_this.counters.inc("sprites");
}
// increment the bound counter
_this.counters.inc("bounds");
// increment the children counter
if (this instanceof Container) {
_this.counters.inc("children");
}
// don't do anything else if the panel is hidden
if (_this.visible) {
// omit following object as they are patched later through different methods
// XXX TODO: make this patched method more generic at Renderable level
if (!(this instanceof Entity) && !(this.ancestor instanceof Entity) && !(this instanceof Text) &&
!(this instanceof BitmapText) && !(this instanceof Camera2d)
&& !(this instanceof ImageLayer)) {
// draw the renderable bounding box
if (_this.checkbox.renderHitBox.selected && this.getBounds().isFinite()) {
if (typeof this.ancestor !== "undefined") {
renderer.save();
if (!this.floating) {
var absolutePosition = this.ancestor.getAbsolutePosition();
renderer.translate(
-absolutePosition.x,
-absolutePosition.y
);
}
}
var bounds = this.getBounds();
renderer.setColor("green");
renderer.stroke(bounds);
// the sprite mask if defined
if (typeof this.mask !== "undefined") {
renderer.setColor("orange");
renderer.stroke(this.mask);
}
if (typeof this.body !== "undefined") {
renderer.translate(bounds.x, bounds.y);
renderer.setColor("orange");
renderer.stroke(this.body.getBounds());
// draw all defined shapes
renderer.setColor("red");
for (var i = this.body.shapes.length, shape; i--, (shape = this.body.shapes[i]);) {
renderer.stroke(shape);
_this.counters.inc("shapes");
}
renderer.translate(-bounds.x, -bounds.y);
}
if (typeof this.ancestor !== "undefined") {
renderer.restore();
}
}
}
}
});
plugin.patch(BitmapText, "draw", function (renderer) {
// call the original Sprite.draw function
this._patched.apply(this, arguments);
// draw the font rectangle
if (_this.visible && _this.checkbox.renderHitBox.selected && this.name !== "debugPanelFont") {
var bounds = this.getBounds();
if (typeof this.ancestor !== "undefined") {
var ax = this.anchorPoint.x * bounds.width,
ay = this.anchorPoint.y * bounds.height;
// translate back as the bounds position
// is already adjusted to the anchor Point
renderer.save();
renderer.translate(ax, ay);
}
renderer.setColor("green");
renderer.stroke(bounds);
if (typeof this.ancestor !== "undefined") {
renderer.restore();
}
}
});
// patch text.js
plugin.patch(Text, "draw", function (renderer) {
// call the original Text.draw function
this._patched.apply(this, arguments);
if (_this.visible && _this.checkbox.renderHitBox.selected) {
var bounds = this.getBounds();
if (typeof this.ancestor !== "undefined") {
renderer.save();
// if this object of this renderable parent is not the root container
if (!this.root && !this.ancestor.root && this.ancestor.isFloating) {
var absolutePosition = this.ancestor.getAbsolutePosition();
renderer.translate(
-absolutePosition.x,
-absolutePosition.y
);
}
}
renderer.setColor("green");
renderer.stroke(bounds);
if (typeof this.ancestor !== "undefined") {
renderer.restore();
}
}
});
// patch entities.js
plugin.patch(Entity, "postDraw", function (renderer) {
// don't do anything else if the panel is hidden
if (_this.visible) {
// check if debug mode is enabled
if (_this.checkbox.renderHitBox.selected) {
renderer.save();
if (typeof this.ancestor !== "undefined") {
// if this object of this renderable parent is not the root container
if (!this.floating) {
var absolutePosition = this.ancestor.getAbsolutePosition();
renderer.translate(
-absolutePosition.x,
-absolutePosition.y
);
}
}
if (this.renderable instanceof Renderable) {
var rbounds = this.renderable.getBounds();
var rx = -rbounds.x - this.anchorPoint.x * rbounds.width,
ry = -rbounds.y - this.anchorPoint.y * rbounds.height;
renderer.setColor("green");
renderer.translate(rx, ry);
renderer.stroke(rbounds);
renderer.translate(-rx, -ry);
}
renderer.translate(
this.body.getBounds().x,
this.body.getBounds().y
);
renderer.translate(
-this.anchorPoint.x * this.body.getBounds().width,
-this.anchorPoint.y * this.body.getBounds().height
);
// draw the bounding rect shape
renderer.setColor("orange");
renderer.stroke(this.body.getBounds());
// draw all defined shapes
renderer.setColor("red");
for (var i = this.body.shapes.length, shape; i--, (shape = this.body.shapes[i]);) {
renderer.stroke(shape);
_this.counters.inc("shapes");
}
renderer.restore();
}
if (_this.checkbox.renderVelocity.selected && (this.body.vel.x || this.body.vel.y)) {
var bounds = this.body.getBounds();
var hWidth = bounds.width / 2;
var hHeight = bounds.height / 2;
renderer.save();
renderer.setLineWidth(1);
renderer.setColor("blue");
renderer.translate(0, -hHeight);
renderer.strokeLine(0, 0, ~~(this.body.vel.x * hWidth), ~~(this.body.vel.y * hHeight));
_this.counters.inc("velocity");
renderer.restore();
}
}
// call the original Entity.postDraw function
this._patched.apply(this, arguments);
});
}
/**
* show the debug panel
*/
show() {
if (!this.visible) {
// add the debug panel to the game world
game.world.addChild(this, Infinity);
// register a mouse event for the checkboxes
input.registerPointerEvent("pointerdown", this, this.onClick.bind(this));
// mark it as visible
this.visible = true;
// force repaint
game.repaint();
}
}
/**
* hide the debug panel
*/
hide() {
if (this.visible) {
// release the mouse event for the checkboxes
input.releasePointerEvent("pointerdown", this);
// remove the debug panel from the game world
game.world.removeChild(this, true);
// mark it as invisible
this.visible = false;
// force repaint
game.repaint();
}
}
update() {
// update the FPS counter
timer.countFPS();
return this.visible;
}
onClick(e) {
// check the clickable areas
if (this.checkbox.renderHitBox.contains(e.gameX, e.gameY)) {
this.checkbox.renderHitBox.selected = !this.checkbox.renderHitBox.selected;
} else if (this.checkbox.renderVelocity.contains(e.gameX, e.gameY)) {
// does nothing for now, since velocity is
// rendered together with hitboxes (is a global debug flag required?)
this.checkbox.renderVelocity.selected = !this.checkbox.renderVelocity.selected;
} else if (this.checkbox.renderQuadTree.contains(e.gameX, e.gameY)) {
this.checkbox.renderQuadTree.selected = !this.checkbox.renderQuadTree.selected;
}
// force repaint
game.repaint();
}
drawQuadTreeNode(renderer, node) {
var bounds = node.bounds;
// draw the current bounds
if (node.nodes.length === 0) {
// cap the alpha value to 0.4 maximum
var _alpha = (node.objects.length * 0.4) / collision.maxChildren;
if (_alpha > 0.0) {
renderer.save();
renderer.setColor("rgba(255,0,0," + _alpha + ")");
renderer.fillRect(bounds.left, bounds.top, bounds.width, bounds.height);
renderer.restore();
}
} else {
//has subnodes? drawQuadtree them!
for (var i = 0; i < node.nodes.length; i++) {
this.drawQuadTreeNode(renderer, node.nodes[i]);
}
}
}
drawQuadTree(renderer) {
var x = game.viewport.pos.x;
var y = game.viewport.pos.y;
renderer.translate(-x, -y);
this.drawQuadTreeNode(renderer, game.world.broadphase);
renderer.translate(x, y);
}
/** @private */
drawMemoryGraph(renderer, endX) {
if (window && window.performance && window.performance.memory) {
var usedHeap = Math.round(window.performance.memory.usedJSHeapSize / 1048576, 2);
var totalHeap = Math.round(window.performance.memory.totalJSHeapSize / 1048576, 2);
var maxLen = ~~(endX - this.memoryPositionX - 5);
var len = maxLen * (usedHeap / totalHeap);
renderer.setColor("#0065AD");
renderer.fillRect(this.memoryPositionX, 0, maxLen, 20);
renderer.setColor("#3AA4F0");
renderer.fillRect(this.memoryPositionX + 1, 1, len - 1, 17);
this.font.draw(renderer, "Heap : " + usedHeap + "/" + totalHeap + " MB", this.memoryPositionX + 5, 2 * this.mod);
} else {
// Heap Memory information not available
this.font.draw(renderer, "Heap : ??/?? MB", this.memoryPositionX, 2 * this.mod);
}
this.font.draw(renderer, "Pool : " + pool.getInstanceCount(), this.memoryPositionX, 10 * this.mod);
}
draw(renderer) {
renderer.save();
// draw the QuadTree (before the panel)
if (this.checkbox.renderQuadTree.selected === true) {
this.drawQuadTree(renderer);
}
// draw the panel
renderer.setGlobalAlpha(0.5);
renderer.setColor("black");
renderer.fillRect(
this.left, this.top,
this.width, this.height
);
renderer.setGlobalAlpha(1.0);
renderer.setColor("white");
this.font.textAlign = "left";
this.font.draw(renderer, "#objects : " + game.world.children.length, 5 * this.mod, 2 * this.mod);
this.font.draw(renderer, "#draws : " + game.world.drawCount, 5 * this.mod, 10 * this.mod);
// debug checkboxes
this.font.draw(renderer, "?hitbox [" + (this.checkbox.renderHitBox.selected ? "x" : " ") + "]", 75 * this.mod, 2 * this.mod);
this.font.draw(renderer, "?velocity [" + (this.checkbox.renderVelocity.selected ? "x" : " ") + "]", 75 * this.mod, 10 * this.mod);
this.font.draw(renderer, "?QuadTree [" + (this.checkbox.renderQuadTree.selected ? "x" : " ") + "]", 150 * this.mod, 2 * this.mod);
// draw the update duration
this.font.draw(renderer, "Update : " + this.frameUpdateTime.toFixed(2) + " ms", 225 * this.mod, 2 * this.mod);
// draw the draw duration
this.font.draw(renderer, "Draw : " + this.frameDrawTime.toFixed(2) + " ms", 225 * this.mod, 10 * this.mod);
// Draw color code hints (not supported with bitmapfont)
//this.font.fillStyle.copy("red");
this.font.draw(renderer, "Shapes : " + this.counters.get("shapes"), 5 * this.mod, 17 * this.mod);
//this.font.fillStyle.copy("green");
this.font.draw(renderer, "Sprites : " + this.counters.get("sprites"), 75 * this.mod, 17 * this.mod);
//this.font.fillStyle.copy("blue");
this.font.draw(renderer, "Velocity : " + this.counters.get("velocity"), 150 * this.mod, 17 * this.mod);
//this.font.fillStyle.copy("orange");
this.font.draw(renderer, "Bounds : " + this.counters.get("bounds"), 225 * this.mod, 17 * this.mod);
//this.font.fillStyle.copy("purple");
this.font.draw(renderer, "Children : " + this.counters.get("children"), 325 * this.mod, 17 * this.mod);
// Reset font style
//this.font.setFont("courier", this.font_size, "white");
// draw the memory heap usage
var endX = this.width - 5;
this.drawMemoryGraph(renderer, endX - this.help_str_len);
this.font.textAlign = "right";
// some help string
this.font.draw(renderer, this.help_str, endX, 17 * this.mod);
//fps counter
var fps_str = timer.fps + "/" + timer.maxfps + " fps";
this.font.draw(renderer, fps_str, endX, 2 * this.mod);
renderer.restore();
}
onDestroyEvent() {
// hide the panel
this.hide();
}
}