@playcanvas/web-components 0.10.1 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/dist/app.d.ts +103 -32
  2. package/dist/components/camera-component.d.ts +13 -13
  3. package/dist/components/screen-component.d.ts +25 -4
  4. package/dist/components/scrollview-component.d.ts +6 -4
  5. package/dist/custom-elements.json +239 -96
  6. package/dist/entity.d.ts +13 -0
  7. package/dist/parse.d.ts +4 -2
  8. package/dist/pwc.cjs +308 -156
  9. package/dist/pwc.cjs.map +1 -1
  10. package/dist/pwc.js +308 -156
  11. package/dist/pwc.js.map +1 -1
  12. package/dist/pwc.min.js +1 -1
  13. package/dist/pwc.min.js.map +1 -1
  14. package/dist/pwc.min.mjs +1 -1
  15. package/dist/pwc.min.mjs.map +1 -1
  16. package/dist/pwc.mjs +309 -157
  17. package/dist/pwc.mjs.map +1 -1
  18. package/dist/sky.d.ts +12 -11
  19. package/dist/vscode.html-custom-data.json +40 -20
  20. package/dist/web-types.json +67 -48
  21. package/package.json +1 -1
  22. package/src/app.ts +189 -79
  23. package/src/components/camera-component.ts +31 -26
  24. package/src/components/screen-component.ts +42 -12
  25. package/src/components/scrollview-component.ts +6 -4
  26. package/src/entity.ts +35 -17
  27. package/src/parse.ts +5 -3
  28. package/src/sky.ts +26 -25
package/dist/custom-elements.json CHANGED
@@ -50,7 +50,7 @@
50
50
  },
51
51
  {
52
52
  "kind": "field",
53
- "name": "_depth",
53
+ "name": "_depthBuffer",
54
54
  "type": {
55
55
  "text": "boolean"
56
56
  },
@@ -59,7 +59,7 @@
59
59
  },
60
60
  {
61
61
  "kind": "field",
62
- "name": "_stencil",
62
+ "name": "_stencilBuffer",
63
63
  "type": {
64
64
  "text": "boolean"
65
65
  },
@@ -68,7 +68,13 @@
68
68
  },
69
69
  {
70
70
  "kind": "field",
71
- "name": "_highResolution",
71
+ "name": "_maxPixelRatio",
72
+ "privacy": "private",
73
+ "default": "Infinity"
74
+ },
75
+ {
76
+ "kind": "field",
77
+ "name": "_loadingBar",
72
78
  "type": {
73
79
  "text": "boolean"
74
80
  },
@@ -77,12 +83,13 @@
77
83
  },
78
84
  {
79
85
  "kind": "field",
80
- "name": "_loadingBar",
86
+ "name": "_optionsLocked",
81
87
  "type": {
82
88
  "text": "boolean"
83
89
  },
84
90
  "privacy": "private",
85
- "default": "true"
91
+ "default": "false",
92
+ "description": "Set once the graphics options above have been handed to `createGraphicsDevice`, after which\nwriting any of them changes nothing. Guards the warning in _warnIfBooted, and is\ncleared on disconnect so a re-connected element boots from its current attributes."
86
93
  },
87
94
  {
88
95
  "kind": "field",
@@ -102,6 +109,13 @@
102
109
  "privacy": "private",
103
110
  "default": "false"
104
111
  },
112
+ {
113
+ "kind": "field",
114
+ "name": "_entityElements",
115
+ "privacy": "private",
116
+ "default": "new Map<GraphNode, EntityElement>()",
117
+ "description": "The elements backing this application's entities, keyed by the entity itself. Registered\nby EntityElement at creation and removed when an entity is destroyed, this joins engine\nscene nodes back to their owning elements by identity - never by name."
118
+ },
105
119
  {
106
120
  "kind": "field",
107
121
  "name": "_picker",
@@ -205,6 +219,72 @@
205
219
  "kind": "method",
206
220
  "name": "_pickerDestroy"
207
221
  },
222
+ {
223
+ "kind": "method",
224
+ "name": "elementFromEntity",
225
+ "return": {
226
+ "type": {
227
+ "text": ""
228
+ }
229
+ },
230
+ "parameters": [
231
+ {
232
+ "name": "entity",
233
+ "type": {
234
+ "text": "Entity"
235
+ },
236
+ "description": "The entity to look up."
237
+ }
238
+ ],
239
+ "description": "Returns the `<pc-entity>` element whose backing entity is `entity`, or `null` if the\nentity was not created by an element of this application - for example, a node inside a\nmodel's instantiated hierarchy, or an entity created through the engine API."
240
+ },
241
+ {
242
+ "kind": "method",
243
+ "name": "_elementFromNode",
244
+ "privacy": "private",
245
+ "return": {
246
+ "type": {
247
+ "text": ""
248
+ }
249
+ },
250
+ "parameters": [
251
+ {
252
+ "name": "node",
253
+ "type": {
254
+ "text": "GraphNode | null"
255
+ },
256
+ "description": "The picked node, or `null`."
257
+ }
258
+ ],
259
+ "description": "Resolves the element that owns a picked node: the nearest node up the parent chain -\nstarting with the node itself - that was created by a `<pc-entity>` of this application.\nA hit inside a model's instantiated hierarchy therefore resolves to the element hosting\nthe model."
260
+ },
261
+ {
262
+ "kind": "method",
263
+ "name": "_elementWithListener",
264
+ "privacy": "private",
265
+ "return": {
266
+ "type": {
267
+ "text": ""
268
+ }
269
+ },
270
+ "parameters": [
271
+ {
272
+ "name": "node",
273
+ "type": {
274
+ "text": "GraphNode | null"
275
+ },
276
+ "description": "The picked node, or `null`."
277
+ },
278
+ {
279
+ "name": "type",
280
+ "type": {
281
+ "text": "string"
282
+ },
283
+ "description": "The pointer event type a listener is required for."
284
+ }
285
+ ],
286
+ "description": "Like _elementFromNode, but skips elements without a listener for `type`, so a hit\non an unlistened child still reaches a listening ancestor."
287
+ },
208
288
  {
209
289
  "kind": "method",
210
290
  "name": "_getPickerCoordinates",
@@ -303,10 +383,25 @@
303
383
  }
304
384
  ]
305
385
  },
386
+ {
387
+ "kind": "method",
388
+ "name": "_warnIfBooted",
389
+ "privacy": "private",
390
+ "parameters": [
391
+ {
392
+ "name": "name",
393
+ "type": {
394
+ "text": "string"
395
+ },
396
+ "description": "The name of the option, as its attribute."
397
+ }
398
+ ],
399
+ "description": "Warns that a graphics option was written too late to have any effect. These options are read\nonce, when the element connects and creates its graphics device, so a later write updates\nonly the element's own property - silently, without this."
400
+ },
306
401
  {
307
402
  "kind": "field",
308
403
  "name": "alpha",
309
- "description": "Gets the alpha flag.",
404
+ "description": "Gets whether the frame buffer has an alpha channel.",
310
405
  "parameters": [
311
406
  {
312
407
  "description": "The alpha flag.",
@@ -322,7 +417,7 @@
322
417
  {
323
418
  "kind": "field",
324
419
  "name": "antialias",
325
- "description": "Gets the antialias flag.",
420
+ "description": "Gets whether the frame buffer is anti-aliased.",
326
421
  "parameters": [
327
422
  {
328
423
  "description": "The antialias flag.",
@@ -353,11 +448,11 @@
353
448
  },
354
449
  {
355
450
  "kind": "field",
356
- "name": "depth",
357
- "description": "Gets the depth flag.",
451
+ "name": "depthBuffer",
452
+ "description": "Gets whether the frame buffer has a depth buffer.",
358
453
  "parameters": [
359
454
  {
360
- "description": "The depth flag.",
455
+ "description": "The depth buffer flag.",
361
456
  "name": "value"
362
457
  }
363
458
  ],
@@ -369,11 +464,11 @@
369
464
  },
370
465
  {
371
466
  "kind": "field",
372
- "name": "highResolution",
373
- "description": "Gets the high resolution flag.",
467
+ "name": "loadingBar",
468
+ "description": "Gets whether the application shows its built-in loading bar while it boots and preloads\nits assets.",
374
469
  "parameters": [
375
470
  {
376
- "description": "The high resolution flag.",
471
+ "description": "The loading bar flag.",
377
472
  "name": "value"
378
473
  }
379
474
  ],
@@ -385,11 +480,11 @@
385
480
  },
386
481
  {
387
482
  "kind": "field",
388
- "name": "loadingBar",
389
- "description": "Gets whether the application shows its built-in loading bar while it boots and preloads\nits assets.",
483
+ "name": "maxPixelRatio",
484
+ "description": "Gets the cap on the pixel ratio the application renders at.",
390
485
  "parameters": [
391
486
  {
392
- "description": "The loading bar flag.",
487
+ "description": "The maximum pixel ratio.",
393
488
  "name": "value"
394
489
  }
395
490
  ],
@@ -401,11 +496,11 @@
401
496
  },
402
497
  {
403
498
  "kind": "field",
404
- "name": "stencil",
405
- "description": "Gets the stencil flag.",
499
+ "name": "stencilBuffer",
500
+ "description": "Gets whether the frame buffer has a stencil buffer.",
406
501
  "parameters": [
407
502
  {
408
- "description": "The stencil flag.",
503
+ "description": "The stencil buffer flag.",
409
504
  "name": "value"
410
505
  }
411
506
  ],
@@ -529,7 +624,7 @@
529
624
  },
530
625
  "fieldName": "alpha",
531
626
  "default": "true",
532
- "description": "The alpha flag."
627
+ "description": "Whether the frame buffer has an alpha channel."
533
628
  },
534
629
  {
535
630
  "name": "antialias",
@@ -538,7 +633,7 @@
538
633
  },
539
634
  "fieldName": "antialias",
540
635
  "default": "true",
541
- "description": "The antialias flag."
636
+ "description": "Whether the frame buffer is anti-aliased."
542
637
  },
543
638
  {
544
639
  "name": "backend",
@@ -550,40 +645,40 @@
550
645
  "description": "The graphics backend."
551
646
  },
552
647
  {
553
- "name": "depth",
648
+ "name": "depth-buffer",
554
649
  "type": {
555
650
  "text": "boolean"
556
651
  },
557
- "fieldName": "depth",
652
+ "fieldName": "depthBuffer",
558
653
  "default": "true",
559
- "description": "The depth flag."
654
+ "description": "Whether the frame buffer has a depth buffer."
560
655
  },
561
656
  {
562
- "name": "high-resolution",
657
+ "name": "loading-bar",
563
658
  "type": {
564
659
  "text": "boolean"
565
660
  },
566
- "fieldName": "highResolution",
661
+ "fieldName": "loadingBar",
567
662
  "default": "true",
568
- "description": "The high resolution flag."
663
+ "description": "Whether the application shows its built-in loading bar while it boots and preloads its assets."
569
664
  },
570
665
  {
571
- "name": "loading-bar",
666
+ "name": "max-pixel-ratio",
572
667
  "type": {
573
- "text": "boolean"
668
+ "text": "number"
574
669
  },
575
- "fieldName": "loadingBar",
576
- "default": "true",
577
- "description": "Whether the application shows its built-in loading bar while it boots and preloads its assets."
670
+ "fieldName": "maxPixelRatio",
671
+ "default": "Infinity",
672
+ "description": "The cap on the pixel ratio the application renders at."
578
673
  },
579
674
  {
580
- "name": "stencil",
675
+ "name": "stencil-buffer",
581
676
  "type": {
582
677
  "text": "boolean"
583
678
  },
584
- "fieldName": "stencil",
679
+ "fieldName": "stencilBuffer",
585
680
  "default": "true",
586
- "description": "The stencil flag."
681
+ "description": "Whether the frame buffer has a stencil buffer."
587
682
  }
588
683
  ],
589
684
  "superclass": {
@@ -1205,6 +1300,16 @@
1205
1300
  "privacy": "private",
1206
1301
  "default": "null"
1207
1302
  },
1303
+ {
1304
+ "kind": "field",
1305
+ "name": "_appElement",
1306
+ "type": {
1307
+ "text": "AppElement | null"
1308
+ },
1309
+ "privacy": "private",
1310
+ "default": "null",
1311
+ "description": "The application element this entity is registered with, cached at creation time so the\nentity can be unregistered even once this element has left the DOM."
1312
+ },
1208
1313
  {
1209
1314
  "kind": "field",
1210
1315
  "name": "entity",
@@ -1231,6 +1336,21 @@
1231
1336
  }
1232
1337
  ]
1233
1338
  },
1339
+ {
1340
+ "kind": "method",
1341
+ "name": "_onEntityDestroy",
1342
+ "privacy": "private",
1343
+ "parameters": [
1344
+ {
1345
+ "name": "entity",
1346
+ "type": {
1347
+ "text": "Entity"
1348
+ },
1349
+ "description": "The entity that was destroyed."
1350
+ }
1351
+ ],
1352
+ "description": "Handles the destruction of the backing entity. Resets the element so a later re-insertion\nstarts clean: `_built` must be cleared alongside `_entity`, or buildHierarchy would bail\nand a re-created entity would never be parented."
1353
+ },
1234
1354
  {
1235
1355
  "kind": "method",
1236
1356
  "name": "buildHierarchy",
@@ -5567,7 +5687,7 @@
5567
5687
  },
5568
5688
  {
5569
5689
  "kind": "field",
5570
- "name": "_level",
5690
+ "name": "_mipLevel",
5571
5691
  "type": {
5572
5692
  "text": "number"
5573
5693
  },
@@ -5689,11 +5809,11 @@
5689
5809
  },
5690
5810
  {
5691
5811
  "kind": "field",
5692
- "name": "level",
5693
- "description": "Gets the mip level of the skybox.",
5812
+ "name": "lighting",
5813
+ "description": "Gets whether the skybox is used as a light source.",
5694
5814
  "parameters": [
5695
5815
  {
5696
- "description": "The mip level.",
5816
+ "description": "Whether to use lighting.",
5697
5817
  "name": "value"
5698
5818
  }
5699
5819
  ],
@@ -5705,11 +5825,11 @@
5705
5825
  },
5706
5826
  {
5707
5827
  "kind": "field",
5708
- "name": "lighting",
5709
- "description": "Gets whether the skybox is used as a light source.",
5828
+ "name": "mipLevel",
5829
+ "description": "Gets the mip level of the skybox.",
5710
5830
  "parameters": [
5711
5831
  {
5712
- "description": "Whether to use lighting.",
5832
+ "description": "The mip level.",
5713
5833
  "name": "value"
5714
5834
  }
5715
5835
  ],
@@ -5880,15 +6000,6 @@
5880
6000
  "default": "1",
5881
6001
  "description": "The intensity of the skybox."
5882
6002
  },
5883
- {
5884
- "name": "level",
5885
- "type": {
5886
- "text": "number"
5887
- },
5888
- "fieldName": "level",
5889
- "default": "0",
5890
- "description": "The mip level of the skybox."
5891
- },
5892
6003
  {
5893
6004
  "name": "lighting",
5894
6005
  "type": {
@@ -5898,6 +6009,15 @@
5898
6009
  "default": "false",
5899
6010
  "description": "Whether the skybox is used as a light source."
5900
6011
  },
6012
+ {
6013
+ "name": "mip-level",
6014
+ "type": {
6015
+ "text": "number"
6016
+ },
6017
+ "fieldName": "mipLevel",
6018
+ "default": "0",
6019
+ "description": "The mip level of the skybox."
6020
+ },
5901
6021
  {
5902
6022
  "name": "rotation",
5903
6023
  "type": {
@@ -6806,12 +6926,12 @@
6806
6926
  },
6807
6927
  {
6808
6928
  "kind": "field",
6809
- "name": "_orthographic",
6929
+ "name": "_projection",
6810
6930
  "type": {
6811
- "text": "boolean"
6931
+ "text": "'perspective' | 'orthographic'"
6812
6932
  },
6813
6933
  "privacy": "private",
6814
- "default": "false"
6934
+ "default": "'perspective'"
6815
6935
  },
6816
6936
  {
6817
6937
  "kind": "field",
@@ -7139,17 +7259,14 @@
7139
7259
  },
7140
7260
  {
7141
7261
  "kind": "field",
7142
- "name": "orthographic",
7143
- "description": "Gets the orthographic projection of the camera.",
7262
+ "name": "orthoHeight",
7263
+ "description": "Gets the orthographic height of the camera.",
7144
7264
  "parameters": [
7145
7265
  {
7146
- "description": "The orthographic projection.",
7266
+ "description": "The orthographic height.",
7147
7267
  "name": "value"
7148
7268
  }
7149
7269
  ],
7150
- "type": {
7151
- "text": "boolean"
7152
- },
7153
7270
  "return": {
7154
7271
  "type": {
7155
7272
  "text": ""
@@ -7158,14 +7275,17 @@
7158
7275
  },
7159
7276
  {
7160
7277
  "kind": "field",
7161
- "name": "orthoHeight",
7162
- "description": "Gets the orthographic height of the camera.",
7278
+ "name": "priority",
7279
+ "description": "Gets the priority of the camera.",
7163
7280
  "parameters": [
7164
7281
  {
7165
- "description": "The orthographic height.",
7282
+ "description": "The priority.",
7166
7283
  "name": "value"
7167
7284
  }
7168
7285
  ],
7286
+ "type": {
7287
+ "text": "number"
7288
+ },
7169
7289
  "return": {
7170
7290
  "type": {
7171
7291
  "text": ""
@@ -7174,17 +7294,14 @@
7174
7294
  },
7175
7295
  {
7176
7296
  "kind": "field",
7177
- "name": "priority",
7178
- "description": "Gets the priority of the camera.",
7297
+ "name": "projection",
7298
+ "description": "Gets the projection of the camera.",
7179
7299
  "parameters": [
7180
7300
  {
7181
- "description": "The priority.",
7301
+ "description": "The projection ('perspective' or 'orthographic').",
7182
7302
  "name": "value"
7183
7303
  }
7184
7304
  ],
7185
- "type": {
7186
- "text": "number"
7187
- },
7188
7305
  "return": {
7189
7306
  "type": {
7190
7307
  "text": ""
@@ -7553,15 +7670,6 @@
7553
7670
  "default": "10",
7554
7671
  "description": "The orthographic height of the camera."
7555
7672
  },
7556
- {
7557
- "name": "orthographic",
7558
- "type": {
7559
- "text": "boolean"
7560
- },
7561
- "fieldName": "orthographic",
7562
- "default": "false",
7563
- "description": "The orthographic projection of the camera."
7564
- },
7565
7673
  {
7566
7674
  "name": "priority",
7567
7675
  "type": {
@@ -7571,6 +7679,15 @@
7571
7679
  "default": "0",
7572
7680
  "description": "The priority of the camera."
7573
7681
  },
7682
+ {
7683
+ "name": "projection",
7684
+ "type": {
7685
+ "text": "'perspective' | 'orthographic'"
7686
+ },
7687
+ "fieldName": "projection",
7688
+ "default": "perspective",
7689
+ "description": "The projection of the camera."
7690
+ },
7574
7691
  {
7575
7692
  "name": "rect",
7576
7693
  "type": {
@@ -13389,12 +13506,12 @@
13389
13506
  },
13390
13507
  {
13391
13508
  "kind": "field",
13392
- "name": "_blend",
13509
+ "name": "_scaleMode",
13393
13510
  "type": {
13394
- "text": "boolean"
13511
+ "text": "'none' | 'blend'"
13395
13512
  },
13396
13513
  "privacy": "private",
13397
- "default": "false"
13514
+ "default": "'none'"
13398
13515
  },
13399
13516
  {
13400
13517
  "kind": "field",
@@ -13445,11 +13562,35 @@
13445
13562
  },
13446
13563
  {
13447
13564
  "kind": "field",
13448
- "name": "scaleBlend"
13565
+ "name": "scaleBlend",
13566
+ "description": "Gets how the screen's resolutions are weighted against each other.",
13567
+ "parameters": [
13568
+ {
13569
+ "description": "The scale blend factor.",
13570
+ "name": "value"
13571
+ }
13572
+ ],
13573
+ "return": {
13574
+ "type": {
13575
+ "text": ""
13576
+ }
13577
+ }
13449
13578
  },
13450
13579
  {
13451
13580
  "kind": "field",
13452
- "name": "blend"
13581
+ "name": "scaleMode",
13582
+ "description": "Gets how the screen scales its contents.",
13583
+ "parameters": [
13584
+ {
13585
+ "description": "The scale mode ('none' or 'blend').",
13586
+ "name": "value"
13587
+ }
13588
+ ],
13589
+ "return": {
13590
+ "type": {
13591
+ "text": ""
13592
+ }
13593
+ }
13453
13594
  },
13454
13595
  {
13455
13596
  "kind": "field",
@@ -13630,14 +13771,6 @@
13630
13771
  }
13631
13772
  ],
13632
13773
  "attributes": [
13633
- {
13634
- "name": "blend",
13635
- "type": {
13636
- "text": "boolean"
13637
- },
13638
- "fieldName": "blend",
13639
- "default": "false"
13640
- },
13641
13774
  {
13642
13775
  "name": "enabled",
13643
13776
  "type": {
@@ -13683,7 +13816,17 @@
13683
13816
  "text": "number"
13684
13817
  },
13685
13818
  "fieldName": "scaleBlend",
13686
- "default": "0.5"
13819
+ "default": "0.5",
13820
+ "description": "How the screen's resolutions are weighted against each other."
13821
+ },
13822
+ {
13823
+ "name": "scale-mode",
13824
+ "type": {
13825
+ "text": "'none' | 'blend'"
13826
+ },
13827
+ "fieldName": "scaleMode",
13828
+ "default": "none",
13829
+ "description": "How the screen scales its contents."
13687
13830
  },
13688
13831
  {
13689
13832
  "name": "screen-space",
@@ -15177,7 +15320,7 @@
15177
15320
  {
15178
15321
  "kind": "field",
15179
15322
  "name": "horizontal",
15180
- "description": "Gets whether horizontal scrolling is enabled.",
15323
+ "description": "Gets whether scrolling along the horizontal axis is enabled.",
15181
15324
  "parameters": [
15182
15325
  {
15183
15326
  "description": "Whether horizontal scrolling is enabled.",
@@ -15193,7 +15336,7 @@
15193
15336
  {
15194
15337
  "kind": "field",
15195
15338
  "name": "vertical",
15196
- "description": "Gets whether vertical scrolling is enabled.",
15339
+ "description": "Gets whether scrolling along the vertical axis is enabled.",
15197
15340
  "parameters": [
15198
15341
  {
15199
15342
  "description": "Whether vertical scrolling is enabled.",
@@ -15603,7 +15746,7 @@
15603
15746
  },
15604
15747
  "fieldName": "horizontal",
15605
15748
  "default": "true",
15606
- "description": "Whether horizontal scrolling is enabled."
15749
+ "description": "Whether scrolling along the horizontal axis is enabled."
15607
15750
  },
15608
15751
  {
15609
15752
  "name": "horizontal-scrollbar",
@@ -15656,7 +15799,7 @@
15656
15799
  },
15657
15800
  "fieldName": "vertical",
15658
15801
  "default": "true",
15659
- "description": "Whether vertical scrolling is enabled."
15802
+ "description": "Whether scrolling along the vertical axis is enabled."
15660
15803
  },
15661
15804
  {
15662
15805
  "name": "vertical-scrollbar",
package/dist/entity.d.ts CHANGED
@@ -62,6 +62,11 @@ declare class EntityElement extends AsyncElement {
62
62
  */
63
63
  private _built;
64
64
  private _entity;
65
+ /**
66
+ * The application element this entity is registered with, cached at creation time so the
67
+ * entity can be unregistered even once this element has left the DOM.
68
+ */
69
+ private _appElement;
65
70
  /**
66
71
  * The PlayCanvas entity instance. `null` until the element is ready, and again once it has
67
72
  * been removed from the document — await {@link whenReady} or the element's `ready()`
@@ -70,6 +75,14 @@ declare class EntityElement extends AsyncElement {
70
75
  */
71
76
  get entity(): Entity | null;
72
77
  createEntity(app: AppBase): void;
78
+ /**
79
+ * Handles the destruction of the backing entity. Resets the element so a later re-insertion
80
+ * starts clean: `_built` must be cleared alongside `_entity`, or buildHierarchy would bail
81
+ * and a re-created entity would never be parented.
82
+ *
83
+ * @param entity - The entity that was destroyed.
84
+ */
85
+ private _onEntityDestroy;
73
86
  buildHierarchy(app: AppBase): void;
74
87
  connectedCallback(): void;
75
88
  disconnectedCallback(): void;