-
-
Notifications
You must be signed in to change notification settings - Fork 215
Expand file tree
/
Copy pathplugins_uiSystem.js.html
More file actions
1377 lines (1235 loc) · 74 KB
/
plugins_uiSystem.js.html
File metadata and controls
1377 lines (1235 loc) · 74 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
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" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="./static/favicon.png"><meta name="description" content="LittleJS is a lightweight HTML5 game engine with fast WebGL rendering, physics, particles, sound, and more!"><meta name="keywords" content="javascript, game engine, html5, webgl, 2d, game development, indie games"><meta name="author" content="Frank Force"><meta property="og:title" content="LittleJS - The Tiny JavaScript Game Engine"><meta property="og:description" content="Lightweight HTML5 game engine with WebGL rendering, physics, and sound"><meta property="og:type" content="website"><title>Source: plugins/uiSystem.js</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://killedbyapixel.github.io/LittleJS/docs/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">LittleJS - The Tiny JavaScript Game Engine That Can!</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Audio.Sound.html">Sound</a></div><div class="sidebar-section-children"><a href="Audio.SoundInstance.html">SoundInstance</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dDistanceJoint.html">Box2dDistanceJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dFrictionJoint.html">Box2dFrictionJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dGearJoint.html">Box2dGearJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dJoint.html">Box2dJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dKinematicObject.html">Box2dKinematicObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dMotorJoint.html">Box2dMotorJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dObject.html">Box2dObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPinJoint.html">Box2dPinJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPlugin.html">Box2dPlugin</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPrismaticJoint.html">Box2dPrismaticJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPulleyJoint.html">Box2dPulleyJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dRevoluteJoint.html">Box2dRevoluteJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dRopeJoint.html">Box2dRopeJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dStaticObject.html">Box2dStaticObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dTargetJoint.html">Box2dTargetJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dTileLayer.html">Box2dTileLayer</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dWeldJoint.html">Box2dWeldJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dWheelJoint.html">Box2dWheelJoint</a></div><div class="sidebar-section-children"><a href="Box2dRaycastResult.html">Box2dRaycastResult</a></div><div class="sidebar-section-children"><a href="Draw.FontImage.html">FontImage</a></div><div class="sidebar-section-children"><a href="Draw.TextureInfo.html">TextureInfo</a></div><div class="sidebar-section-children"><a href="Draw.TileInfo.html">TileInfo</a></div><div class="sidebar-section-children"><a href="Engine.Color.html">Color</a></div><div class="sidebar-section-children"><a href="Engine.EngineObject.html">EngineObject</a></div><div class="sidebar-section-children"><a href="Engine.RandomGenerator.html">RandomGenerator</a></div><div class="sidebar-section-children"><a href="Engine.Timer.html">Timer</a></div><div class="sidebar-section-children"><a href="Engine.Vector2.html">Vector2</a></div><div class="sidebar-section-children"><a href="Medals.Medal.html">Medal</a></div><div class="sidebar-section-children"><a href="Newgrounds.NewgroundsMedal.html">NewgroundsMedal</a></div><div class="sidebar-section-children"><a href="Newgrounds.NewgroundsPlugin.html">NewgroundsPlugin</a></div><div class="sidebar-section-children"><a href="Particles.Particle.html">Particle</a></div><div class="sidebar-section-children"><a href="Particles.ParticleEmitter.html">ParticleEmitter</a></div><div class="sidebar-section-children"><a href="PostProcess.PostProcessPlugin.html">PostProcessPlugin</a></div><div class="sidebar-section-children"><a href="TileLayers.CanvasLayer.html">CanvasLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileCollisionLayer.html">TileCollisionLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileLayer.html">TileLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileLayerData.html">TileLayerData</a></div><div class="sidebar-section-children"><a href="UISystem.UIButton.html">UIButton</a></div><div class="sidebar-section-children"><a href="UISystem.UICheckbox.html">UICheckbox</a></div><div class="sidebar-section-children"><a href="UISystem.UIObject.html">UIObject</a></div><div class="sidebar-section-children"><a href="UISystem.UIScrollbar.html">UIScrollbar</a></div><div class="sidebar-section-children"><a href="UISystem.UISystemPlugin.html">UISystemPlugin</a></div><div class="sidebar-section-children"><a href="UISystem.UIText.html">UIText</a></div><div class="sidebar-section-children"><a href="UISystem.UITile.html">UITile</a></div><div class="sidebar-section-children"><a href="UISystem.UIVideo.html">UIVideo</a></div><div class="sidebar-section-children"><a href="ZzFXM.ZzFXMusic.html">ZzFXMusic</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Audio.html">Audio</a></div><div class="sidebar-section-children"><a href="Box2D.html">Box2D</a></div><div class="sidebar-section-children"><a href="Debug.html">Debug</a></div><div class="sidebar-section-children"><a href="Draw.html">Draw</a></div><div class="sidebar-section-children"><a href="DrawUtilities.html">DrawUtilities</a></div><div class="sidebar-section-children"><a href="Engine.html">Engine</a></div><div class="sidebar-section-children"><a href="Input.html">Input</a></div><div class="sidebar-section-children"><a href="Math.html">Math</a></div><div class="sidebar-section-children"><a href="Medals.html">Medals</a></div><div class="sidebar-section-children"><a href="Newgrounds.html">Newgrounds</a></div><div class="sidebar-section-children"><a href="Particles.html">Particles</a></div><div class="sidebar-section-children"><a href="PostProcess.html">PostProcess</a></div><div class="sidebar-section-children"><a href="Random.html">Random</a></div><div class="sidebar-section-children"><a href="Settings.html">Settings</a></div><div class="sidebar-section-children"><a href="TileLayers.html">TileLayers</a></div><div class="sidebar-section-children"><a href="UISystem.html">UISystem</a></div><div class="sidebar-section-children"><a href="Utilities.html">Utilities</a></div><div class="sidebar-section-children"><a href="WebGL.html">WebGL</a></div><div class="sidebar-section-children"><a href="ZzFXM.html">ZzFXM</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/KilledByAPixel/LittleJS" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://killedbyapixel.github.io/LittleJS/examples/" target="_blank">Examples</a></div><div class="navbar-item"><a id="" href="https://github.com/KilledByAPixel/LittleJS/blob/main/FAQ.md" target="_blank">FAQ</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">plugins_uiSystem.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
* LittleJS User Interface Plugin
* - call new UISystemPlugin() to setup the UI system
* - Gamepad and keyboard navigation support
* - Nested Menus
* - Text
* - Buttons
* - Checkboxes
* - Images
* - Scrollbars
* - Video
* @namespace UISystem
*/
'use strict';
///////////////////////////////////////////////////////////////////////////////
/** Global UI system plugin object
* @type {UISystemPlugin}
* @memberof UISystem */
let uiSystem;
/** Enable UI system debug drawing
* 0=off, 1=normal, 2=show invisible
* @type {number}
* @default
* @memberof UISystem */
let uiDebug = 0;
/** Enable UI system debug drawing
* 0=off, 1=normal, 2=show invisible
* @param {number|boolean} debugMode
* @memberof UISystem */
function uiSetDebug(debugMode)
{ uiDebug = typeof debugMode === 'boolean' ? (debugMode ? 1 : 0) : debugMode; }
///////////////////////////////////////////////////////////////////////////////
/**
* UI System Global Object
* @memberof UISystem
*/
class UISystemPlugin
{
/** Create the global UI system object
* @param {CanvasRenderingContext2D} [context]
* @example
* // create the ui plugin object
* new UISystemPlugin;
*/
constructor(context=mainContext)
{
ASSERT(!uiSystem, 'UI system already initialized');
uiSystem = this;
// default settings
/** @property {boolean} - Activate when mouse is pressed down instead of clicked */
this.activateOnPress = false;
/** @property {Color} - Default fill color for UI elements */
this.defaultColor = WHITE;
/** @property {Color} - Default outline color for UI elements */
this.defaultLineColor = BLACK;
/** @property {Color} - Default text color for UI elements */
this.defaultTextColor = BLACK;
/** @property {Color} - Default button color for UI elements */
this.defaultButtonColor = hsl(0,0,.7);
/** @property {Color} - Default hover color for UI elements */
this.defaultHoverColor = hsl(0,0,.9);
/** @property {Color} - Default color for disabled UI elements */
this.defaultDisabledColor = hsl(0,0,.3);
/** @property {Color} - Uses a gradient fill combined with color */
this.defaultGradientColor = undefined;
/** @property {number} - Default line width for UI elements */
this.defaultLineWidth = 4;
/** @property {number} - Default rounded rect corner radius for UI elements */
this.defaultCornerRadius = 0;
/** @property {number} - Default scale to use for fitting text to object */
this.defaultTextFitScale = .8;
/** @property {string} - Default font for UI elements */
this.defaultFont = fontDefault;
/** @property {Sound} - Default sound when interactive UI element is pressed */
this.defaultSoundPress = undefined;
/** @property {Sound} - Default sound when interactive UI element is released */
this.defaultSoundRelease = undefined;
/** @property {Sound} - Default sound when interactive UI element is clicked */
this.defaultSoundClick = undefined;
/** @property {Color} - Color for shadow */
this.defaultShadowColor = CLEAR_BLACK;
/** @property {number} - Size of shadow blur */
this.defaultShadowBlur = 5;
/** @property {Vector2} - Offset of shadow blur */
this.defaultShadowOffset = vec2(5);
/** @property {number} - If set ui coords will be renormalized to this canvas height */
this.nativeHeight = 0;
// navigation properties
/** @property {UIObject} - Object currently selected by navigation (gamepad or keyboard) */
this.navigationObject = undefined;
/** @property {Timer} - Cool down timer for navigation inputs */
this.navigationTimer = new Timer(undefined, true);
/** @property {number} - Time between navigation inputs in seconds */
this.navigationDelay = .2;
/** @property {boolean} - should the navigation be horizontal, vertical, or both? */
this.navigationDirection = 1;
/** @property {boolean} - True if user last used navigation instead of mouse */
this.navigationMode = false;
// system state
/** @property {Array<UIObject>} - List of all UI elements */
this.uiObjects = [];
/** @property {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} - Context to render UI elements to */
this.uiContext = context;
/** @property {UIObject} - Object user is currently interacting with */
this.activeObject = undefined;
/** @property {UIObject} - Top most object user is over */
this.hoverObject = undefined;
/** @property {UIObject} - Hover object at start of update */
this.lastHoverObject = undefined;
/** @property {UIObject} - Current confirm menu being shown */
this.confirmDialog = undefined;
engineAddPlugin(uiUpdate, uiRender);
// set object position in parent space
function updateTransforms(o)
{
if (!o.parent) return;
o.pos.x = o.localPos.x + o.parent.pos.x;
o.pos.y = o.localPos.y + o.parent.pos.y;
}
// setup recursive update and render
// update in reverse order to detect mouse enter/leave
function uiUpdate()
{
if (uiSystem.activeObject && !uiSystem.activeObject.visible)
uiSystem.activeObject = undefined;
// reset hover object at start of update
uiSystem.lastHoverObject = uiSystem.hoverObject;
uiSystem.hoverObject = undefined;
if (mouseWasPressed(0))
{
uiSystem.navigationMode = false;
uiSystem.navigationObject = undefined;
}
// navigation with gamepad/keyboard
const navigableObjects = uiSystem.getNavigableObjects();
if (!navigableObjects.length)
uiSystem.navigationObject = undefined;
else
{
// unselect object if it is no longer navigable
if (!navigableObjects.includes(uiSystem.navigationObject))
uiSystem.navigationObject = undefined;
if (!isTouchDevice)
if (uiSystem.navigationMode && !uiSystem.navigationObject)
{
// select first auto focus object
uiSystem.navigationObject = navigableObjects.find(o=>o.navigationAutoSelect);
}
// navigate with dpad or left stick
if (!uiSystem.navigationTimer.active())
{
// navigate through list with gamepad or keyboard
const direction = sign(uiSystem.getNavigationDirection());
if (direction)
{
let newNavigationObject;
if (!uiSystem.navigationObject)
{
// use auto select object
newNavigationObject = navigableObjects.find(o=>o.navigationAutoSelect);
if (!newNavigationObject)
{
// try first or last object
const newIndex = direction > 0 ? 0 : navigableObjects.length-1;
newNavigationObject = navigableObjects[newIndex];
}
}
else
{
const currentIndex = navigableObjects.indexOf(uiSystem.navigationObject);
const newIndex = mod(currentIndex + direction, navigableObjects.length);
newNavigationObject = navigableObjects[newIndex];
}
if (uiSystem.navigationObject !== newNavigationObject)
{
uiSystem.navigationMode = true;
uiSystem.hoverObject = undefined;
uiSystem.navigationObject = newNavigationObject;
uiSystem.navigationTimer.set(uiSystem.navigationDelay);
newNavigationObject.soundPress &&
newNavigationObject.soundPress.play();
}
}
}
// activate the navigation object when pressed
if (uiSystem.navigationObject)
if (uiSystem.getNavigationWasPressed())
uiSystem.navigationObject.navigatePressed();
}
// update in reverse order so topmost objects get priority
for (let i = uiSystem.uiObjects.length; i--;)
{
const o = uiSystem.uiObjects[i];
o.parent || updateObject(o);
}
// remove destroyed objects
uiSystem.uiObjects = uiSystem.uiObjects.filter(o=>!o.destroyed);
function updateObject(o)
{
if (!o.visible) return;
// update in reverse order to detect mouse enter/leave
updateTransforms(o);
for (let i=o.children.length; i--;)
updateObject(o.children[i]);
o.update();
}
}
function uiRender()
{
const context = uiSystem.uiContext;
context.save();
if (uiSystem.nativeHeight)
{
// convert to native height
const s = mainCanvasSize.y / uiSystem.nativeHeight;
context.translate(-s*mainCanvasSize.x/2,0);
context.scale(s,s);
context.translate(mainCanvasSize.x/2/s,0);
}
function renderObject(o)
{
if (!o.visible) return;
// render object and children
updateTransforms(o);
o.render();
for (const c of o.children)
renderObject(c);
}
uiSystem.uiObjects.forEach(o=> o.parent || renderObject(o));
if (uiDebug > 0)
{
// debug render all objects
function renderDebug(o, visible=true)
{
visible &&= !!o.visible;
updateTransforms(o);
o.renderDebug(visible);
for (const c of o.children)
renderDebug(c, visible);
}
uiSystem.uiObjects.forEach(o=> o.parent || renderDebug(o));
}
context.restore();
}
}
/** Draw a rectangle to the UI context
* @param {Vector2} pos
* @param {Vector2} size
* @param {Color} [color]
* @param {number} [lineWidth]
* @param {Color} [lineColor]
* @param {number} [cornerRadius]
* @param {Color} [gradientColor]
* @param {Color} [shadowColor]
* @param {number} [shadowBlur]
* @param {Color} [shadowOffset] */
drawRect(pos, size, color=WHITE, lineWidth=0, lineColor=BLACK, cornerRadius=0, gradientColor, shadowColor=BLACK, shadowBlur=0, shadowOffset=vec2())
{
ASSERT(isVector2(pos), 'pos must be a vec2');
ASSERT(isVector2(size), 'size must be a vec2');
ASSERT(isColor(color), 'color must be a color');
ASSERT(isNumber(lineWidth), 'lineWidth must be a number');
ASSERT(isColor(lineColor), 'lineColor must be a color');
ASSERT(isNumber(cornerRadius), 'cornerRadius must be a number');
const context = uiSystem.uiContext;
if (gradientColor)
{
const g = context.createLinearGradient(
pos.x, pos.y-size.y/2, pos.x, pos.y+size.y/2);
const c = color.toString();
g.addColorStop(0, c);
g.addColorStop(.5, gradientColor.toString());
g.addColorStop(1, c);
context.fillStyle = g;
}
else
context.fillStyle = color.toString();
if (shadowBlur || shadowOffset.x || shadowOffset.y)
if (shadowColor.a > 0)
{
// setup shadow
context.shadowColor = shadowColor.toString();
context.shadowBlur = shadowBlur;
context.shadowOffsetX = shadowOffset.x;
context.shadowOffsetY = shadowOffset.y;
}
context.beginPath();
if (cornerRadius && context['roundRect'])
context['roundRect'](pos.x-size.x/2, pos.y-size.y/2, size.x, size.y, cornerRadius);
else
context.rect(pos.x-size.x/2, pos.y-size.y/2, size.x, size.y);
context.fill();
context.shadowColor = '#0000';
if (lineWidth && lineColor.a > 0)
{
context.strokeStyle = lineColor.toString();
context.lineWidth = lineWidth;
context.stroke();
}
}
/** Draw a line to the UI context
* @param {Vector2} posA
* @param {Vector2} posB
* @param {number} [lineWidth=uiSystem.defaultLineWidth]
* @param {Color} [lineColor=uiSystem.defaultLineColor] */
drawLine(posA, posB, lineWidth=uiSystem.defaultLineWidth, lineColor=uiSystem.defaultLineColor)
{
ASSERT(isVector2(posA), 'posA must be a vec2');
ASSERT(isVector2(posB), 'posB must be a vec2');
ASSERT(isNumber(lineWidth), 'lineWidth must be a number');
ASSERT(isColor(lineColor), 'lineColor must be a color');
const context = uiSystem.uiContext;
context.strokeStyle = lineColor.toString();
context.lineWidth = lineWidth;
context.beginPath();
context.lineTo(posA.x, posA.y);
context.lineTo(posB.x, posB.y);
context.stroke();
}
/** Draw a tile to the UI context
* @param {Vector2} pos
* @param {Vector2} size
* @param {TileInfo} tileInfo
* @param {Color} [color=uiSystem.defaultColor]
* @param {number} [angle]
* @param {boolean} [mirror]
* @param {Color} [shadowColor]
* @param {number} [shadowBlur]
* @param {Color} [shadowOffset] */
drawTile(pos, size, tileInfo, color=uiSystem.defaultColor, angle=0, mirror=false, shadowColor=BLACK, shadowBlur=0, shadowOffset=vec2())
{
const context = uiSystem.uiContext;
if (shadowBlur || shadowOffset.x || shadowOffset.y)
if (shadowColor.a > 0)
{
// setup shadow
context.shadowColor = shadowColor.toString();
context.shadowBlur = shadowBlur;
context.shadowOffsetX = shadowOffset.x;
context.shadowOffsetY = shadowOffset.y;
}
drawTile(pos, size, tileInfo, color, angle, mirror, CLEAR_BLACK, false, true, context);
context.shadowColor = '#0000';
}
/** Draw text to the UI context
* @param {string} text
* @param {Vector2} pos
* @param {Vector2} size
* @param {Color} [color=uiSystem.defaultColor]
* @param {number} [lineWidth=uiSystem.defaultLineWidth]
* @param {Color} [lineColor=uiSystem.defaultLineColor]
* @param {string} [align]
* @param {string} [font=uiSystem.defaultFont]
* @param {string} [fontStyle]
* @param {boolean} [applyMaxWidth=true]
* @param {Vector2} [textShadow]
* @param {Color} [shadowColor]
* @param {number} [shadowBlur]
* @param {Color} [shadowOffset] */
drawText(text, pos, size, color=uiSystem.defaultColor, lineWidth=uiSystem.defaultLineWidth, lineColor=uiSystem.defaultLineColor, align='center', font=uiSystem.defaultFont, fontStyle='', applyMaxWidth=true, textShadow=undefined, shadowColor=BLACK, shadowBlur=0, shadowOffset=vec2())
{
const context = uiSystem.uiContext;
if (shadowColor.a > 0)
{
if (textShadow)
drawTextScreen(text, pos.add(textShadow), size.y, shadowColor, lineWidth, lineColor, align, font, fontStyle, applyMaxWidth ? size.x : undefined, 0, context);
if (shadowBlur || shadowOffset.x || shadowOffset.y)
{
// setup shadow
context.shadowColor = shadowColor.toString();
context.shadowBlur = shadowBlur;
context.shadowOffsetX = shadowOffset.x;
context.shadowOffsetY = shadowOffset.y;
}
}
drawTextScreen(text, pos, size.y, color, lineWidth, lineColor, align, font, fontStyle, applyMaxWidth ? size.x : undefined, 0, context);
context.shadowColor = '#0000';
}
/**
* @callback DragAndDropCallback - Callback for drag and drop events
* @param {DragEvent} event - The drag event
* @memberof UISystem
*/
/** Setup drag and drop event handlers
* Automatically prevents defaults and calls the given functions
* @param {DragAndDropCallback} [onDrop] - when a file is dropped
* @param {DragAndDropCallback} [onDragEnter] - when a file is dragged onto the window
* @param {DragAndDropCallback} [onDragLeave] - when a file is dragged off the window
* @param {DragAndDropCallback} [onDragOver] - continuously when dragging over */
setupDragAndDrop(onDrop, onDragEnter, onDragLeave, onDragOver)
{
function setCallback(callback, listenerType)
{
function listener(e) { e.preventDefault(); callback && callback(e); }
document.addEventListener(listenerType, listener);
}
setCallback(onDrop, 'drop');
setCallback(onDragEnter, 'dragenter');
setCallback(onDragLeave, 'dragleave');
setCallback(onDragOver, 'dragover');
}
/** Convert a screen space position to native UI position
* @param {Vector2} pos
* @return {Vector2} */
screenToNative(pos)
{
if (!uiSystem.nativeHeight)
return pos;
const s = mainCanvasSize.y / uiSystem.nativeHeight;
const sInv = 1/s;
const p = pos.copy();
p.x += s*mainCanvasSize.x/2;
p.x *= sInv;
p.y *= sInv;
p.x -= sInv*mainCanvasSize.x/2;
return p;
}
/** Destroy and remove all objects
* @memberof Engine */
destroyObjects()
{
for (const o of this.uiObjects)
o.parent || o.destroy();
this.uiObjects = this.uiObjects.filter(o=>!o.destroyed);
this.activeObject = undefined;
this.hoverObject = undefined;
this.lastHoverObject = undefined;
}
/** Get all navigable UI objects sorted by navigationIndex
* @return {Array<UIObject>} */
getNavigableObjects()
{
function getNavigableRecursive(o)
{
if (!o.visible || o.disabled)
return; // skip children if parent is invisible or disabled
if (o.isInteractive() && o.navigationIndex !== undefined)
objects.push(o);
for (let i=o.children.length; i--;)
getNavigableRecursive(o.children[i]);
}
// get all the valid navigable objects recursively
let objects = [];
for (let i = uiSystem.uiObjects.length; i--;)
{
const o = uiSystem.uiObjects[i];
if (uiSystem.confirmDialog && o !== uiSystem.confirmDialog)
continue;
o.parent || getNavigableRecursive(o);
}
// sort by navigationIndex (lower numbers first)
objects.sort((a, b)=> a.navigationIndex - b.navigationIndex);
return objects;
}
/** Get navigation direction from gamepad or keyboard
* @return {number} */
getNavigationDirection()
{
const vertical = uiSystem.navigationDirection === 1;
const both = uiSystem.navigationDirection === 2;
if (isUsingGamepad)
{
const stick = gamepadStick(0, gamepadPrimary);
const dpad = gamepadDpad(gamepadPrimary);
if (both)
return -(stick.y || dpad.y) || (stick.x || dpad.x);
return vertical ? -(stick.y || dpad.y) : (stick.x || dpad.x);
}
const up = 'ArrowUp', down = 'ArrowDown', left = 'ArrowLeft', right = 'ArrowRight';
if (both)
{
return keyIsDown(up) || keyIsDown(left) ? -1 :
keyIsDown(down) || keyIsDown(right) ? 1 : 0;
}
const back = vertical ? up : left;
const forward = vertical ? down : right;
return keyIsDown(back) ? -1 : keyIsDown(forward) ? 1 : 0;
}
/** Get other axis navigation direction from gamepad or keyboard
* @return {Vector2} */
getNavigationOtherDirection()
{
if (uiSystem.navigationDirection === 2)
return 0; // other direction disabled
const vertical = uiSystem.navigationDirection === 1;
if (isUsingGamepad)
{
const stick = gamepadStick(0, gamepadPrimary);
const dpad = gamepadDpad(gamepadPrimary);
return !vertical ? (stick.y || dpad.y) : (stick.x || dpad.x);
}
const back = !vertical ? 'ArrowUp' : 'ArrowLeft';
const forward = !vertical ? 'ArrowDown' : 'ArrowRight';
return keyIsDown(back) ? -1 : keyIsDown(forward) ? 1 : 0;
}
/** Get if navigation button was pressed from gamepad or keyboard
* @return {boolean} */
getNavigationWasPressed()
{
return isUsingGamepad ? gamepadWasPressed(0, gamepadPrimary) :
keyWasPressed('Space') || keyWasPressed('Enter');
}
/** Show a confirmation dialog with Yes/No buttons
* Centers the dialog on the screen with darkened background
* @param {string} [text] - The message to display
* @param {Function} [yesCallback] - Called when Yes is clicked
* @param {Function} [noCallback] - Called when No is clicked
* @param {Vector2} [size] - Size of the confirmation dialog
* @param {string} [exitKey] - Key that can exit the menu
* @return {UIObject} The confirmation menu object
*/
showConfirmDialog(text='Are you sure?', yesCallback, noCallback, size=vec2(500,250), exitKey='Escape')
{
ASSERT(!uiSystem.confirmDialog);
const savedNavigationDirection = uiSystem.navigationDirection;
// allow both axes for navigation
uiSystem.navigationDirection = 2;
// confirm menu
const confirmMenu = new UIObject(vec2(), size);
uiSystem.confirmDialog = confirmMenu;
confirmMenu.onRender = ()=>
{
confirmMenu.pos = uiSystem.screenToNative(mainCanvasSize.scale(.5));
const backgroundColor = hsl(0,0,0,.7);
uiSystem.drawRect(vec2(), vec2(1e9), backgroundColor);
}
confirmMenu.onUpdate = ()=>
{
if (keyWasPressed(exitKey))
closeMenu();
}
confirmMenu.isMouseOverlapping = ()=> true; // always hover
// title text
const gap = 50;
const textTitle = new UIText(vec2(0,-50), vec2(size.x-gap,70), text);
confirmMenu.addChild(textTitle);
// yes button
const buttonYes = new UIButton(vec2(-80,50), vec2(120,70), 'Yes');
buttonYes.textHeight = 40;
buttonYes.navigationIndex = 1;
buttonYes.hoverColor = hsl(0,1,.5);
buttonYes.onClick = ()=> { closeMenu(); yesCallback && yesCallback(); };
confirmMenu.addChild(buttonYes);
// no button
const buttonNo = new UIButton(vec2(80,50), vec2(120,70), 'No');
buttonNo.textHeight = 40;
buttonNo.navigationIndex = 2;
buttonNo.navigationAutoSelect = true;
buttonNo.onClick = ()=> { closeMenu(); noCallback && noCallback(); };
confirmMenu.addChild(buttonNo);
// close menu and return to normal navigation
function closeMenu()
{
ASSERT(uiSystem.confirmDialog === confirmMenu);
confirmMenu.destroy();
uiSystem.confirmDialog = undefined;
uiSystem.navigationDirection = savedNavigationDirection;
inputClear();
}
}
}
///////////////////////////////////////////////////////////////////////////////
/**
* UI Object - Base level object for all UI elements
* @memberof UISystem */
class UIObject
{
/** Create a UIObject
* @param {Vector2} [pos=vec2()]
* @param {Vector2} [size=vec2(1)]
*/
constructor(pos=vec2(), size=vec2())
{
ASSERT(isVector2(pos), 'ui object pos must be a vec2');
ASSERT(isVector2(size), 'ui object size must be a vec2');
/** @property {Vector2} - Local position of the object */
this.localPos = pos.copy();
/** @property {Vector2} - Screen space position of the object */
this.pos = pos.copy();
/** @property {Vector2} - Screen space size of the object */
this.size = size.copy();
/** @property {Color} - Color of the object */
this.color = uiSystem.defaultColor.copy();
/** @property {Color} - Color of the object when active, uses hoverColor if undefined */
this.activeColor = undefined;
/** @property {string} - Text for this ui object */
this.text = undefined;
/** @property {Color} - Color when disabled */
this.disabledColor = uiSystem.defaultDisabledColor.copy();
/** @property {boolean} - Is this object disabled? */
this.disabled = false;
/** @property {Color} - Color for text */
this.textColor = uiSystem.defaultTextColor.copy();
/** @property {Color} - Color used when hovering over the object */
this.hoverColor = uiSystem.defaultHoverColor.copy();
/** @property {Color} - Color for line drawing */
this.lineColor = uiSystem.defaultLineColor.copy();
/** @property {Color} - Uses a gradient fill combined with color */
this.gradientColor = uiSystem.defaultGradientColor ? uiSystem.defaultGradientColor.copy() : undefined;
/** @property {number} - Width for line drawing */
this.lineWidth = uiSystem.defaultLineWidth;
/** @property {number} - Corner radius for rounded rects */
this.cornerRadius = uiSystem.defaultCornerRadius;
/** @property {string} - Font for this object */
this.font = uiSystem.defaultFont;
/** @property {string} - Font style for this object or undefined */
this.fontStyle = undefined;
/** @property {number} - Override for text width */
this.textWidth = undefined;
/** @property {number} - Override for text height */
this.textHeight = undefined;
/** @property {number} - Scale text to fit in the object */
this.textFitScale = uiSystem.defaultTextFitScale;
/** @property {Vector2} - How much to offset the text shadow or undefined */
this.textShadow = undefined;
/** @property {number} - Color for text line drawing */
this.textLineColor = uiSystem.defaultLineColor.copy();
/** @property {number} - Width for text line drawing */
this.textLineWidth = 0;
/** @property {boolean} - Should this object be drawn */
this.visible = true;
/** @property {Array<UIObject>} - A list of this object's children */
this.children = [];
/** @property {UIObject} - This object's parent, position is in parent space */
this.parent = undefined;
/** @property {number} - Added size to make small buttons easier to touch on mobile devices */
this.extraTouchSize = 0;
/** @property {Sound} - Sound when interactive element is pressed */
this.soundPress = uiSystem.defaultSoundPress;
/** @property {Sound} - Sound when interactive element is released */
this.soundRelease = uiSystem.defaultSoundRelease;
/** @property {Sound} - Sound when interactive element is clicked */
this.soundClick = uiSystem.defaultSoundClick;
/** @property {boolean} - Is this element interactive */
this.interactive = false;
/** @property {boolean} - Activate when dragged over with mouse held down */
this.dragActivate = false;
/** @property {boolean} - True if this can be a hover object */
this.canBeHover = true;
/** @property {Color} - Color for shadow, undefined if no shadow */
this.shadowColor = uiSystem.defaultShadowColor?.copy();
/** @property {number} - Size of shadow blur */
this.shadowBlur = uiSystem.defaultShadowBlur;
/** @property {Vector2} - Offset of shadow blur */
this.shadowOffset = uiSystem.defaultShadowOffset?.copy();
/** @property {number} - Optional navigation order index, lower values are selected first */
this.navigationIndex = undefined;
/** @property {boolean} - Should this be auto selected by navigation? Must also have valid navigation index. */
this.navigationAutoSelect = false;
uiSystem.uiObjects.push(this);
}
/** Add a child UIObject to this object, returns child for chaining
* @param {UIObject} child
* @return {UIObject} The child object added */
addChild(child)
{
ASSERT(!child.parent && !this.children.includes(child));
this.children.push(child);
child.parent = this;
return child;
}
/** Remove a child UIObject from this object
* @param {UIObject} child */
removeChild(child)
{
ASSERT(child.parent === this && this.children.includes(child));
this.children.splice(this.children.indexOf(child), 1);
child.parent = undefined;
}
/** Destroy this object, destroy its children, detach its parent, and mark it for removal */
destroy()
{
if (this.destroyed)
return;
// disconnect from parent and destroy children
this.destroyed = 1;
this.parent?.removeChild(this);
for (const child of this.children)
{
child.parent = undefined;
child.destroy();
}
}
/** Check if the mouse is overlapping a box in screen space
* @return {boolean} - True if overlapping */
isMouseOverlapping()
{
if (!mouseInWindow) return false;
const size = !isTouchDevice ? this.size :
this.size.add(vec2(this.extraTouchSize || 0));
const pos = uiSystem.screenToNative(mousePosScreen);
return isOverlapping(this.pos, size, pos);
}
/** Update the object, called automatically by plugin once each frame */
update()
{
// call the custom update callback
this.onUpdate();
// unset active if disabled
if (this.disabled && this === uiSystem.activeObject)
uiSystem.activeObject = undefined;
const wasHover = uiSystem.lastHoverObject === this;
const isActive = this.isActiveObject();
const mouseDown = mouseIsDown(0);
const mousePress = this.dragActivate ? mouseDown : mouseWasPressed(0);
if (this.canBeHover)
if (!uiSystem.navigationMode) // no mouse hover in navigation mode
if (mousePress || isActive || (!mouseDown && !isTouchDevice))
if (!uiSystem.hoverObject && this.isMouseOverlapping())
uiSystem.hoverObject = this;
if (this.isHoverObject())
{
if (!this.disabled)
{
if (mousePress)
{
if (this.interactive)
{
if (!this.dragActivate || (!wasHover || mouseWasPressed(0)))
this.onPress();
this.soundPress && this.soundPress.play();
if (uiSystem.activeObject && !isActive)
uiSystem.activeObject.onRelease();
uiSystem.activeObject = this;
if (uiSystem.activateOnPress)
{
this.onClick();
if (!this.soundPress && this.soundClick)
this.soundClick.play();
}
}
}
if (!uiSystem.activateOnPress)
if (!mouseDown && this.isActiveObject() && this.interactive)
{
this.onClick();
this.soundClick && this.soundClick.play();
}
}
// clear mouse was pressed state even when disabled
mousePress && inputClearKey(0,0,0,1,0);
}
if (isActive)
if (!mouseDown || (this.dragActivate && !this.isHoverObject()))
{
this.onRelease();
this.soundRelease && this.soundRelease.play();
uiSystem.activeObject = undefined;
}
// call enter/leave events
if (this.isHoverObject() !== wasHover)
this.isHoverObject() ? this.onEnter() : this.onLeave();
}
/** Render the object, called automatically by plugin once each frame */
render()
{
// call the custom render callback
this.onRender();
if (!this.size.x || !this.size.y) return;
const isNavigationObject = this.isNavigationObject();
const lineColor = isNavigationObject ? this.color :
this.interactive && this.isActiveObject() && !this.disabled ?
this.color : this.lineColor;
const color = isNavigationObject ? this.hoverColor :
this.disabled ? this.disabledColor :
this.interactive ?
this.isActiveObject() ? this.activeColor || this.hoverColor :
this.isHoverObject() ? this.hoverColor :
this.color : this.color;
const lineWidth = this.lineWidth * (isNavigationObject ? 1.5 : 1);
uiSystem.drawRect(this.pos, this.size, color, lineWidth, lineColor, this.cornerRadius, this.gradientColor, this.shadowColor, this.shadowBlur, this.shadowOffset);
}
/** Get the size for text with overrides and scale
* @return {Vector2} */
getTextSize()
{
return vec2(
this.textWidth || this.textFitScale * this.size.x,
this.textHeight || this.textFitScale * this.size.y);
}
/** Called when the navigation button is pressed on this object */
navigatePressed()
{
this.onClick();
this.soundClick && this.soundClick.play();
}
/** @return {boolean} - Is the mouse hovering over this element */
isHoverObject() { return uiSystem.hoverObject === this; }
/** @return {boolean} - Is the mouse held onto this element */
isActiveObject() { return uiSystem.activeObject === this; }
/** @return {boolean} - Is the gamepad or keyboard navigation object */
isNavigationObject() { return uiSystem.navigationObject === this; }
/** @return {boolean} - Can it be interacted with */
isInteractive() { return this.interactive && this.visible && !this.disabled;}
/** Returns string containing info about this object for debugging
* @return {string} */
toString()
{
if (!debug) return;
let text = 'type = ' + this.constructor.name;
if (this.text)
text += '\ntext = ' + this.text;
if (this.pos.x || this.pos.y)
text += '\npos = ' + this.pos;
if (this.localPos.x || this.localPos.y)
text += '\localPos = ' + this.localPos;
if (this.size.x || this.size.y)
text += '\nsize = ' + this.size;
if (this.color)
text += '\ncolor = ' + this.color;
return text;
}
/** Called if uiDebug is enabled
* @param {boolean} visible */
renderDebug(visible=true)
{
// apply color based on state
const color =
!visible ? GREEN :
this.isHoverObject() ? YELLOW :
this.disabled ? PURPLE :
this.interactive ? RED : BLUE;
uiSystem.drawRect(this.pos, this.size, CLEAR_BLACK, 4, color);
}
/** Called each frame before object updates */
onUpdate() {}
/** Called each frame before object renders */
onRender() {}
/** Called when the mouse enters the object */
onEnter() {}
/** Called when the mouse leaves the object */
onLeave() {}
/** Called when the mouse is pressed while over the object */
onPress() {}
/** Called when the mouse is released while over the object */
onRelease() {}
/** Called when user clicks on this object */
onClick() {}
/** Called when the state of this object changes */
onChange() {}
};
///////////////////////////////////////////////////////////////////////////////
/**
* UIText - A UI object that displays text
* @extends UIObject
* @memberof UISystem
*/
class UIText extends UIObject
{
/** Create a UIText object
* @param {Vector2} [pos]
* @param {Vector2} [size]
* @param {string} [text]
* @param {string} [align]
* @param {string} [font=uiSystem.defaultFont]
*/
constructor(pos, size, text='', align='center', font=uiSystem.defaultFont)
{
super(pos, size);
ASSERT(isString(text), 'ui text must be a string');
ASSERT(['left','center','right'].includes(align), 'ui text align must be left, center, or right');
ASSERT(isString(font), 'ui text font must be a string');
// set properties
this.text = text;
this.align = align;
this.font = font;
// text can not be a hover object by default
this.canBeHover = false;
// no background by default
this.color = CLEAR_BLACK;
this.shadowColor = CLEAR_BLACK;
this.gradientColor = undefined;
this.lineWidth = 0;
// use max fit scale by default
this.textFitScale = 1;
}
render()
{
super.render();
// render the text
const textSize = this.getTextSize();
uiSystem.drawText(this.text, this.pos, textSize, this.textColor, this.textLineWidth, this.textLineColor, this.align, this.font, this.fontStyle, true, this.textShadow, this.shadowColor, this.shadowBlur, this.shadowOffset);
}
}
///////////////////////////////////////////////////////////////////////////////
/**
* UITile - A UI object that displays a tile image
* @extends UIObject
* @memberof UISystem
*/
class UITile extends UIObject
{
/** Create a UITile object
* @param {Vector2} [pos]
* @param {Vector2} [size]
* @param {TileInfo} [tileInfo]
* @param {Color} [color=WHITE]
* @param {number} [angle]
* @param {boolean} [mirror]
*/