@playcanvas/web-components 0.13.1 → 0.15.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.
@@ -1594,6 +1594,14 @@
1594
1594
  "module": "src/index.ts"
1595
1595
  }
1596
1596
  },
1597
+ {
1598
+ "kind": "js",
1599
+ "name": "JointComponentElement",
1600
+ "declaration": {
1601
+ "name": "JointComponentElement",
1602
+ "module": "src/index.ts"
1603
+ }
1604
+ },
1597
1605
  {
1598
1606
  "kind": "js",
1599
1607
  "name": "LayoutChildComponentElement",
@@ -1777,6 +1785,30 @@
1777
1785
  "name": "AsyncElementTagName",
1778
1786
  "module": "./async-element"
1779
1787
  }
1788
+ },
1789
+ {
1790
+ "kind": "js",
1791
+ "name": "HierarchyMaterial",
1792
+ "declaration": {
1793
+ "name": "HierarchyMaterial",
1794
+ "module": "./model"
1795
+ }
1796
+ },
1797
+ {
1798
+ "kind": "js",
1799
+ "name": "HierarchyNode",
1800
+ "declaration": {
1801
+ "name": "HierarchyNode",
1802
+ "module": "./model"
1803
+ }
1804
+ },
1805
+ {
1806
+ "kind": "js",
1807
+ "name": "MaterialOverrides",
1808
+ "declaration": {
1809
+ "name": "MaterialOverrides",
1810
+ "module": "./node"
1811
+ }
1780
1812
  }
1781
1813
  ]
1782
1814
  },
@@ -2715,6 +2747,22 @@
2715
2747
  }
2716
2748
  }
2717
2749
  },
2750
+ {
2751
+ "kind": "field",
2752
+ "name": "name",
2753
+ "description": "Gets the name of the material - the label shown wherever materials surface by name, such\nas profilers, GPU captures and the assignments `pc-model.hierarchy()` reports. Purely a\nlabel: element references resolve through `id`.",
2754
+ "parameters": [
2755
+ {
2756
+ "description": "The material name.",
2757
+ "name": "value"
2758
+ }
2759
+ ],
2760
+ "return": {
2761
+ "type": {
2762
+ "text": ""
2763
+ }
2764
+ }
2765
+ },
2718
2766
  {
2719
2767
  "kind": "field",
2720
2768
  "name": "normalMap",
@@ -3657,6 +3705,14 @@
3657
3705
  "default": "0",
3658
3706
  "description": "The UV channel the metalness map samples."
3659
3707
  },
3708
+ {
3709
+ "name": "name",
3710
+ "type": {
3711
+ "text": "string"
3712
+ },
3713
+ "fieldName": "name",
3714
+ "description": "The name of the material - the label shown wherever materials surface by name, such as profilers, GPU captures and the assignments `pc-model.hierarchy()` reports."
3715
+ },
3660
3716
  {
3661
3717
  "name": "normal-map",
3662
3718
  "type": {
@@ -3937,6 +3993,10 @@
3937
3993
  "kind": "javascript-module",
3938
3994
  "path": "src/model.ts",
3939
3995
  "declarations": [
3996
+ {
3997
+ "kind": "variable",
3998
+ "name": "index"
3999
+ },
3940
4000
  {
3941
4001
  "kind": "class",
3942
4002
  "description": "The ModelElement interface provides properties and methods for manipulating\n[`<pc-model>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-model/) elements.\nThe ModelElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once its container asset has loaded and the instantiated hierarchy has\nbeen added to the scene — `entity` is non-null by then. A failed load also settles readiness,\nwith `entity` remaining `null`: readiness means the load settled, not that it succeeded — listen\nfor `error`, or check `entity`, to tell the outcomes apart. Changing `asset` re-arms readiness\nand instantiates anew, so a `ready()` obtained after the change resolves against the new\nhierarchy. A `pc-model` outside a `pc-app`, or referencing an unknown asset id, warns and never\nbecomes ready.\n",
@@ -4011,6 +4071,16 @@
4011
4071
  },
4012
4072
  "readonly": true
4013
4073
  },
4074
+ {
4075
+ "kind": "method",
4076
+ "name": "hierarchy",
4077
+ "return": {
4078
+ "type": {
4079
+ "text": ""
4080
+ }
4081
+ },
4082
+ "description": "Returns a snapshot of the instantiated node tree, or `null` while there is none (the\ncontainer asset has not loaded, or the element has left the document). One call grounds a\nsession — a browser console, a test, an agent — in the vocabulary `pc-node` binding\nresolves against: the instantiated names (HierarchyNode.name), paths, match\nindices, attached component types and the material assignments of render components\n(HierarchyNode.materials). `String(...)` of the result, or of any node in it,\nis the printable form.\n\nThe snapshot is plain data, computed afresh each call: it does not follow later changes\nto the hierarchy, and mutating it changes nothing."
4083
+ },
4014
4084
  {
4015
4085
  "kind": "method",
4016
4086
  "name": "ready",
@@ -4087,6 +4157,22 @@
4087
4157
  "name": "ModelElement",
4088
4158
  "module": "src/model.ts"
4089
4159
  }
4160
+ },
4161
+ {
4162
+ "kind": "js",
4163
+ "name": "HierarchyMaterial",
4164
+ "declaration": {
4165
+ "name": "HierarchyMaterial",
4166
+ "module": "src/model.ts"
4167
+ }
4168
+ },
4169
+ {
4170
+ "kind": "js",
4171
+ "name": "HierarchyNode",
4172
+ "declaration": {
4173
+ "name": "HierarchyNode",
4174
+ "module": "src/model.ts"
4175
+ }
4090
4176
  }
4091
4177
  ]
4092
4178
  },
@@ -4350,6 +4436,25 @@
4350
4436
  }
4351
4437
  }
4352
4438
  },
4439
+ {
4440
+ "kind": "field",
4441
+ "name": "materialOverrides",
4442
+ "description": "Gets the material overrides.",
4443
+ "parameters": [
4444
+ {
4445
+ "description": "The mapping, or `null`.",
4446
+ "name": "value"
4447
+ }
4448
+ ],
4449
+ "type": {
4450
+ "text": "MaterialOverrides | null"
4451
+ },
4452
+ "return": {
4453
+ "type": {
4454
+ "text": ""
4455
+ }
4456
+ }
4457
+ },
4353
4458
  {
4354
4459
  "kind": "field",
4355
4460
  "name": "name",
@@ -4582,6 +4687,14 @@
4582
4687
  "description": "Which match to bind when `name` matches more than one node, 0-based in depth-first order. Optional for a unique match; required for an ambiguous one.",
4583
4688
  "fieldName": "index"
4584
4689
  },
4690
+ {
4691
+ "name": "material-overrides",
4692
+ "type": {
4693
+ "text": "string"
4694
+ },
4695
+ "description": "Overrides material assignments on the bound node's render component, as a JSON object from selector to `pc-material` id — for example `{\"name:CarPaint\": \"candy-red\", \"index:7\": \"smoked-glass\"}`. A `name:X` key selects every mesh instance whose baseline material is named `X`; an `index:N` key selects mesh instance `N` and wins over a name rule for the same instance. Assignments no rule matches keep their baseline materials, and removing the attribute restores all of them. Use `pc-model.hierarchy()` to discover the names and indices a node offers.",
4696
+ "fieldName": "materialOverrides"
4697
+ },
4585
4698
  {
4586
4699
  "name": "name",
4587
4700
  "type": {
@@ -4687,6 +4800,14 @@
4687
4800
  "name": "NodeElement",
4688
4801
  "module": "src/node.ts"
4689
4802
  }
4803
+ },
4804
+ {
4805
+ "kind": "js",
4806
+ "name": "MaterialOverrides",
4807
+ "declaration": {
4808
+ "name": "MaterialOverrides",
4809
+ "module": "src/node.ts"
4810
+ }
4690
4811
  }
4691
4812
  ]
4692
4813
  },
@@ -7923,6 +8044,914 @@
7923
8044
  }
7924
8045
  ]
7925
8046
  },
8047
+ {
8048
+ "kind": "javascript-module",
8049
+ "path": "src/components/joint-component.ts",
8050
+ "declarations": [
8051
+ {
8052
+ "kind": "class",
8053
+ "description": "The JointComponentElement interface provides properties and methods for manipulating\n[`<pc-joint>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-joint/) elements.\nThe JointComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe entity holding the joint is not itself constrained. Its world transform defines the joint\nframe — the anchor point and axes the constraint operates about — with the local X axis as the\nprimary axis: a hinge rotates about it, a slider translates along it and a ball joint twists\nabout it. The constrained bodies are referenced by `entity-a` and `entity-b`, both of which need\na rigid body component; leaving `entity-b` empty constrains `entity-a` to a fixed point in world\nspace. The underlying engine component is in alpha, so its API may change.\n",
8054
+ "name": "JointComponentElement",
8055
+ "members": [
8056
+ {
8057
+ "kind": "field",
8058
+ "name": "angularDamping",
8059
+ "description": "Gets the spring damping of the joint per angular axis.",
8060
+ "parameters": [
8061
+ {
8062
+ "description": "The angular spring damping.",
8063
+ "name": "value"
8064
+ }
8065
+ ],
8066
+ "return": {
8067
+ "type": {
8068
+ "text": ""
8069
+ }
8070
+ }
8071
+ },
8072
+ {
8073
+ "kind": "field",
8074
+ "name": "angularEquilibrium",
8075
+ "description": "Gets the rest angle of the joint's angular springs.",
8076
+ "parameters": [
8077
+ {
8078
+ "description": "The angular spring rest angles.",
8079
+ "name": "value"
8080
+ }
8081
+ ],
8082
+ "return": {
8083
+ "type": {
8084
+ "text": ""
8085
+ }
8086
+ }
8087
+ },
8088
+ {
8089
+ "kind": "field",
8090
+ "name": "angularLimitsX",
8091
+ "description": "Gets the rotation limits of the joint about its X axis.",
8092
+ "parameters": [
8093
+ {
8094
+ "description": "The X axis rotation limits.",
8095
+ "name": "value"
8096
+ }
8097
+ ],
8098
+ "return": {
8099
+ "type": {
8100
+ "text": ""
8101
+ }
8102
+ }
8103
+ },
8104
+ {
8105
+ "kind": "field",
8106
+ "name": "angularLimitsY",
8107
+ "description": "Gets the rotation limits of the joint about its Y axis.",
8108
+ "parameters": [
8109
+ {
8110
+ "description": "The Y axis rotation limits.",
8111
+ "name": "value"
8112
+ }
8113
+ ],
8114
+ "return": {
8115
+ "type": {
8116
+ "text": ""
8117
+ }
8118
+ }
8119
+ },
8120
+ {
8121
+ "kind": "field",
8122
+ "name": "angularLimitsZ",
8123
+ "description": "Gets the rotation limits of the joint about its Z axis.",
8124
+ "parameters": [
8125
+ {
8126
+ "description": "The Z axis rotation limits.",
8127
+ "name": "value"
8128
+ }
8129
+ ],
8130
+ "return": {
8131
+ "type": {
8132
+ "text": ""
8133
+ }
8134
+ }
8135
+ },
8136
+ {
8137
+ "kind": "field",
8138
+ "name": "angularMotionX",
8139
+ "description": "Gets how the joint constrains rotation about its X axis.",
8140
+ "parameters": [
8141
+ {
8142
+ "description": "The X axis rotational degree of freedom.",
8143
+ "name": "value"
8144
+ }
8145
+ ],
8146
+ "return": {
8147
+ "type": {
8148
+ "text": ""
8149
+ }
8150
+ }
8151
+ },
8152
+ {
8153
+ "kind": "field",
8154
+ "name": "angularMotionY",
8155
+ "description": "Gets how the joint constrains rotation about its Y axis.",
8156
+ "parameters": [
8157
+ {
8158
+ "description": "The Y axis rotational degree of freedom.",
8159
+ "name": "value"
8160
+ }
8161
+ ],
8162
+ "return": {
8163
+ "type": {
8164
+ "text": ""
8165
+ }
8166
+ }
8167
+ },
8168
+ {
8169
+ "kind": "field",
8170
+ "name": "angularMotionZ",
8171
+ "description": "Gets how the joint constrains rotation about its Z axis.",
8172
+ "parameters": [
8173
+ {
8174
+ "description": "The Z axis rotational degree of freedom.",
8175
+ "name": "value"
8176
+ }
8177
+ ],
8178
+ "return": {
8179
+ "type": {
8180
+ "text": ""
8181
+ }
8182
+ }
8183
+ },
8184
+ {
8185
+ "kind": "field",
8186
+ "name": "angularStiffness",
8187
+ "description": "Gets the spring stiffness of the joint per angular axis.",
8188
+ "parameters": [
8189
+ {
8190
+ "description": "The angular spring stiffness.",
8191
+ "name": "value"
8192
+ }
8193
+ ],
8194
+ "return": {
8195
+ "type": {
8196
+ "text": ""
8197
+ }
8198
+ }
8199
+ },
8200
+ {
8201
+ "kind": "field",
8202
+ "name": "breakImpulse",
8203
+ "description": "Gets the impulse above which the joint breaks.",
8204
+ "parameters": [
8205
+ {
8206
+ "description": "The break impulse.",
8207
+ "name": "value"
8208
+ }
8209
+ ],
8210
+ "return": {
8211
+ "type": {
8212
+ "text": ""
8213
+ }
8214
+ }
8215
+ },
8216
+ {
8217
+ "kind": "field",
8218
+ "name": "closestApp",
8219
+ "type": {
8220
+ "text": "AppElement | null"
8221
+ },
8222
+ "description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
8223
+ "return": {
8224
+ "type": {
8225
+ "text": ""
8226
+ }
8227
+ },
8228
+ "readonly": true,
8229
+ "inheritedFrom": {
8230
+ "name": "AsyncElement",
8231
+ "module": "src/async-element.ts"
8232
+ }
8233
+ },
8234
+ {
8235
+ "kind": "field",
8236
+ "name": "closestEntity",
8237
+ "type": {
8238
+ "text": "EntityBaseElement | null"
8239
+ },
8240
+ "description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or `<pc-node>` — or\n`null` if this element has no such ancestor. The search starts at the parent, so an element\nnever resolves to itself.",
8241
+ "return": {
8242
+ "type": {
8243
+ "text": ""
8244
+ }
8245
+ },
8246
+ "readonly": true,
8247
+ "inheritedFrom": {
8248
+ "name": "AsyncElement",
8249
+ "module": "src/async-element.ts"
8250
+ }
8251
+ },
8252
+ {
8253
+ "kind": "field",
8254
+ "name": "component",
8255
+ "type": {
8256
+ "text": "Component | null"
8257
+ },
8258
+ "description": "Gets the underlying PlayCanvas joint component.",
8259
+ "return": {
8260
+ "type": {
8261
+ "text": ""
8262
+ }
8263
+ },
8264
+ "readonly": true,
8265
+ "inheritedFrom": {
8266
+ "name": "ComponentElement",
8267
+ "module": "src/components/component.ts"
8268
+ }
8269
+ },
8270
+ {
8271
+ "kind": "field",
8272
+ "name": "enableCollision",
8273
+ "description": "Gets whether collision is enabled between the two constrained bodies.",
8274
+ "parameters": [
8275
+ {
8276
+ "description": "Whether collision is enabled.",
8277
+ "name": "value"
8278
+ }
8279
+ ],
8280
+ "return": {
8281
+ "type": {
8282
+ "text": ""
8283
+ }
8284
+ }
8285
+ },
8286
+ {
8287
+ "kind": "field",
8288
+ "name": "enabled",
8289
+ "description": "Gets the enabled state of the component.",
8290
+ "parameters": [
8291
+ {
8292
+ "description": "The enabled state of the component.",
8293
+ "name": "value"
8294
+ }
8295
+ ],
8296
+ "return": {
8297
+ "type": {
8298
+ "text": ""
8299
+ }
8300
+ },
8301
+ "inheritedFrom": {
8302
+ "name": "ComponentElement",
8303
+ "module": "src/components/component.ts"
8304
+ }
8305
+ },
8306
+ {
8307
+ "kind": "field",
8308
+ "name": "enableLimits",
8309
+ "description": "Gets whether the limits of the joint are enforced.",
8310
+ "parameters": [
8311
+ {
8312
+ "description": "Whether the limits are enforced.",
8313
+ "name": "value"
8314
+ }
8315
+ ],
8316
+ "return": {
8317
+ "type": {
8318
+ "text": ""
8319
+ }
8320
+ }
8321
+ },
8322
+ {
8323
+ "kind": "field",
8324
+ "name": "entityA",
8325
+ "description": "Gets the reference to the `<pc-entity>` providing the first constrained body.",
8326
+ "parameters": [
8327
+ {
8328
+ "description": "The first body's entity reference.",
8329
+ "name": "value"
8330
+ }
8331
+ ],
8332
+ "return": {
8333
+ "type": {
8334
+ "text": ""
8335
+ }
8336
+ }
8337
+ },
8338
+ {
8339
+ "kind": "field",
8340
+ "name": "entityB",
8341
+ "description": "Gets the reference to the `<pc-entity>` providing the second constrained body.",
8342
+ "parameters": [
8343
+ {
8344
+ "description": "The second body's entity reference.",
8345
+ "name": "value"
8346
+ }
8347
+ ],
8348
+ "return": {
8349
+ "type": {
8350
+ "text": ""
8351
+ }
8352
+ }
8353
+ },
8354
+ {
8355
+ "kind": "field",
8356
+ "name": "limits",
8357
+ "description": "Gets the rotation or travel limits of the joint.",
8358
+ "parameters": [
8359
+ {
8360
+ "description": "The rotation or travel limits.",
8361
+ "name": "value"
8362
+ }
8363
+ ],
8364
+ "return": {
8365
+ "type": {
8366
+ "text": ""
8367
+ }
8368
+ }
8369
+ },
8370
+ {
8371
+ "kind": "field",
8372
+ "name": "linearDamping",
8373
+ "description": "Gets the spring damping of the joint per linear axis.",
8374
+ "parameters": [
8375
+ {
8376
+ "description": "The linear spring damping.",
8377
+ "name": "value"
8378
+ }
8379
+ ],
8380
+ "return": {
8381
+ "type": {
8382
+ "text": ""
8383
+ }
8384
+ }
8385
+ },
8386
+ {
8387
+ "kind": "field",
8388
+ "name": "linearEquilibrium",
8389
+ "description": "Gets the rest point of the joint's linear springs.",
8390
+ "parameters": [
8391
+ {
8392
+ "description": "The linear spring rest points.",
8393
+ "name": "value"
8394
+ }
8395
+ ],
8396
+ "return": {
8397
+ "type": {
8398
+ "text": ""
8399
+ }
8400
+ }
8401
+ },
8402
+ {
8403
+ "kind": "field",
8404
+ "name": "linearLimitsX",
8405
+ "description": "Gets the translation limits of the joint along its X axis.",
8406
+ "parameters": [
8407
+ {
8408
+ "description": "The X axis translation limits.",
8409
+ "name": "value"
8410
+ }
8411
+ ],
8412
+ "return": {
8413
+ "type": {
8414
+ "text": ""
8415
+ }
8416
+ }
8417
+ },
8418
+ {
8419
+ "kind": "field",
8420
+ "name": "linearLimitsY",
8421
+ "description": "Gets the translation limits of the joint along its Y axis.",
8422
+ "parameters": [
8423
+ {
8424
+ "description": "The Y axis translation limits.",
8425
+ "name": "value"
8426
+ }
8427
+ ],
8428
+ "return": {
8429
+ "type": {
8430
+ "text": ""
8431
+ }
8432
+ }
8433
+ },
8434
+ {
8435
+ "kind": "field",
8436
+ "name": "linearLimitsZ",
8437
+ "description": "Gets the translation limits of the joint along its Z axis.",
8438
+ "parameters": [
8439
+ {
8440
+ "description": "The Z axis translation limits.",
8441
+ "name": "value"
8442
+ }
8443
+ ],
8444
+ "return": {
8445
+ "type": {
8446
+ "text": ""
8447
+ }
8448
+ }
8449
+ },
8450
+ {
8451
+ "kind": "field",
8452
+ "name": "linearMotionX",
8453
+ "description": "Gets how the joint constrains translation along its X axis.",
8454
+ "parameters": [
8455
+ {
8456
+ "description": "The X axis linear degree of freedom.",
8457
+ "name": "value"
8458
+ }
8459
+ ],
8460
+ "return": {
8461
+ "type": {
8462
+ "text": ""
8463
+ }
8464
+ }
8465
+ },
8466
+ {
8467
+ "kind": "field",
8468
+ "name": "linearMotionY",
8469
+ "description": "Gets how the joint constrains translation along its Y axis.",
8470
+ "parameters": [
8471
+ {
8472
+ "description": "The Y axis linear degree of freedom.",
8473
+ "name": "value"
8474
+ }
8475
+ ],
8476
+ "return": {
8477
+ "type": {
8478
+ "text": ""
8479
+ }
8480
+ }
8481
+ },
8482
+ {
8483
+ "kind": "field",
8484
+ "name": "linearMotionZ",
8485
+ "description": "Gets how the joint constrains translation along its Z axis.",
8486
+ "parameters": [
8487
+ {
8488
+ "description": "The Z axis linear degree of freedom.",
8489
+ "name": "value"
8490
+ }
8491
+ ],
8492
+ "return": {
8493
+ "type": {
8494
+ "text": ""
8495
+ }
8496
+ }
8497
+ },
8498
+ {
8499
+ "kind": "field",
8500
+ "name": "linearStiffness",
8501
+ "description": "Gets the spring stiffness of the joint per linear axis.",
8502
+ "parameters": [
8503
+ {
8504
+ "description": "The linear spring stiffness.",
8505
+ "name": "value"
8506
+ }
8507
+ ],
8508
+ "return": {
8509
+ "type": {
8510
+ "text": ""
8511
+ }
8512
+ }
8513
+ },
8514
+ {
8515
+ "kind": "field",
8516
+ "name": "maxMotorForce",
8517
+ "description": "Gets the maximum torque or force of the joint's motor.",
8518
+ "parameters": [
8519
+ {
8520
+ "description": "The maximum motor torque or force.",
8521
+ "name": "value"
8522
+ }
8523
+ ],
8524
+ "return": {
8525
+ "type": {
8526
+ "text": ""
8527
+ }
8528
+ }
8529
+ },
8530
+ {
8531
+ "kind": "field",
8532
+ "name": "motorSpeed",
8533
+ "description": "Gets the target speed of the joint's motor.",
8534
+ "parameters": [
8535
+ {
8536
+ "description": "The motor's target speed.",
8537
+ "name": "value"
8538
+ }
8539
+ ],
8540
+ "return": {
8541
+ "type": {
8542
+ "text": ""
8543
+ }
8544
+ }
8545
+ },
8546
+ {
8547
+ "kind": "method",
8548
+ "name": "ready",
8549
+ "return": {
8550
+ "type": {
8551
+ "text": ""
8552
+ }
8553
+ },
8554
+ "description": "Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
8555
+ "inheritedFrom": {
8556
+ "name": "AsyncElement",
8557
+ "module": "src/async-element.ts"
8558
+ }
8559
+ },
8560
+ {
8561
+ "kind": "field",
8562
+ "name": "swingLimitY",
8563
+ "description": "Gets the maximum swing of the joint around the joint frame's Y axis.",
8564
+ "parameters": [
8565
+ {
8566
+ "description": "The Y axis swing limit.",
8567
+ "name": "value"
8568
+ }
8569
+ ],
8570
+ "return": {
8571
+ "type": {
8572
+ "text": ""
8573
+ }
8574
+ }
8575
+ },
8576
+ {
8577
+ "kind": "field",
8578
+ "name": "swingLimitZ",
8579
+ "description": "Gets the maximum swing of the joint around the joint frame's Z axis.",
8580
+ "parameters": [
8581
+ {
8582
+ "description": "The Z axis swing limit.",
8583
+ "name": "value"
8584
+ }
8585
+ ],
8586
+ "return": {
8587
+ "type": {
8588
+ "text": ""
8589
+ }
8590
+ }
8591
+ },
8592
+ {
8593
+ "kind": "field",
8594
+ "name": "twistLimit",
8595
+ "description": "Gets the maximum twist of the joint about its primary axis.",
8596
+ "parameters": [
8597
+ {
8598
+ "description": "The twist limit.",
8599
+ "name": "value"
8600
+ }
8601
+ ],
8602
+ "return": {
8603
+ "type": {
8604
+ "text": ""
8605
+ }
8606
+ }
8607
+ },
8608
+ {
8609
+ "kind": "field",
8610
+ "name": "type",
8611
+ "description": "Gets the type of the joint.",
8612
+ "parameters": [
8613
+ {
8614
+ "description": "The joint type.",
8615
+ "name": "value"
8616
+ }
8617
+ ],
8618
+ "return": {
8619
+ "type": {
8620
+ "text": ""
8621
+ }
8622
+ }
8623
+ }
8624
+ ],
8625
+ "events": [
8626
+ {
8627
+ "name": "break",
8628
+ "type": {
8629
+ "text": "CustomEvent"
8630
+ },
8631
+ "description": "Fired when the impulse on the joint exceeds `break-impulse` and the constraint breaks. A broken joint no longer constrains its bodies; calling `refreshFrames()` on the underlying component re-attaches it. Bubbles and is composed."
8632
+ },
8633
+ {
8634
+ "name": "ready",
8635
+ "type": {
8636
+ "text": "CustomEvent"
8637
+ },
8638
+ "description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
8639
+ "inheritedFrom": {
8640
+ "name": "AsyncElement",
8641
+ "module": "src/async-element.ts"
8642
+ }
8643
+ }
8644
+ ],
8645
+ "attributes": [
8646
+ {
8647
+ "name": "angular-damping",
8648
+ "type": {
8649
+ "text": "string"
8650
+ },
8651
+ "fieldName": "angularDamping",
8652
+ "default": "1 1 1",
8653
+ "description": "The spring damping of the joint per angular axis. Accepts 3 space-separated numbers."
8654
+ },
8655
+ {
8656
+ "name": "angular-equilibrium",
8657
+ "type": {
8658
+ "text": "string"
8659
+ },
8660
+ "fieldName": "angularEquilibrium",
8661
+ "default": "0 0 0",
8662
+ "description": "The rest angle of the joint's angular springs. Accepts 3 space-separated numbers."
8663
+ },
8664
+ {
8665
+ "name": "angular-limits-x",
8666
+ "type": {
8667
+ "text": "string"
8668
+ },
8669
+ "fieldName": "angularLimitsX",
8670
+ "default": "0 0",
8671
+ "description": "The rotation limits of the joint about its X axis. Accepts 2 space-separated numbers."
8672
+ },
8673
+ {
8674
+ "name": "angular-limits-y",
8675
+ "type": {
8676
+ "text": "string"
8677
+ },
8678
+ "fieldName": "angularLimitsY",
8679
+ "default": "0 0",
8680
+ "description": "The rotation limits of the joint about its Y axis. Accepts 2 space-separated numbers."
8681
+ },
8682
+ {
8683
+ "name": "angular-limits-z",
8684
+ "type": {
8685
+ "text": "string"
8686
+ },
8687
+ "fieldName": "angularLimitsZ",
8688
+ "default": "0 0",
8689
+ "description": "The rotation limits of the joint about its Z axis. Accepts 2 space-separated numbers."
8690
+ },
8691
+ {
8692
+ "name": "angular-motion-x",
8693
+ "type": {
8694
+ "text": "'locked' | 'limited' | 'free'"
8695
+ },
8696
+ "fieldName": "angularMotionX",
8697
+ "default": "locked",
8698
+ "description": "How the joint constrains rotation about its X axis."
8699
+ },
8700
+ {
8701
+ "name": "angular-motion-y",
8702
+ "type": {
8703
+ "text": "'locked' | 'limited' | 'free'"
8704
+ },
8705
+ "fieldName": "angularMotionY",
8706
+ "default": "locked",
8707
+ "description": "How the joint constrains rotation about its Y axis."
8708
+ },
8709
+ {
8710
+ "name": "angular-motion-z",
8711
+ "type": {
8712
+ "text": "'locked' | 'limited' | 'free'"
8713
+ },
8714
+ "fieldName": "angularMotionZ",
8715
+ "default": "locked",
8716
+ "description": "How the joint constrains rotation about its Z axis."
8717
+ },
8718
+ {
8719
+ "name": "angular-stiffness",
8720
+ "type": {
8721
+ "text": "string"
8722
+ },
8723
+ "fieldName": "angularStiffness",
8724
+ "default": "0 0 0",
8725
+ "description": "The spring stiffness of the joint per angular axis. Accepts 3 space-separated numbers."
8726
+ },
8727
+ {
8728
+ "name": "break-impulse",
8729
+ "type": {
8730
+ "text": "number"
8731
+ },
8732
+ "fieldName": "breakImpulse",
8733
+ "default": "Infinity",
8734
+ "description": "The impulse above which the joint breaks."
8735
+ },
8736
+ {
8737
+ "name": "enable-collision",
8738
+ "type": {
8739
+ "text": "boolean"
8740
+ },
8741
+ "fieldName": "enableCollision",
8742
+ "default": "false",
8743
+ "description": "Whether collision is enabled between the two constrained bodies."
8744
+ },
8745
+ {
8746
+ "name": "enable-limits",
8747
+ "type": {
8748
+ "text": "boolean"
8749
+ },
8750
+ "fieldName": "enableLimits",
8751
+ "default": "false",
8752
+ "description": "Whether the limits of the joint are enforced."
8753
+ },
8754
+ {
8755
+ "name": "enabled",
8756
+ "type": {
8757
+ "text": "boolean"
8758
+ },
8759
+ "fieldName": "enabled",
8760
+ "default": "true",
8761
+ "description": "The enabled state of the component.",
8762
+ "inheritedFrom": {
8763
+ "name": "ComponentElement",
8764
+ "module": "src/components/component.ts"
8765
+ }
8766
+ },
8767
+ {
8768
+ "name": "entity-a",
8769
+ "type": {
8770
+ "text": "string"
8771
+ },
8772
+ "fieldName": "entityA",
8773
+ "description": "The reference to the `<pc-entity>` providing the first constrained body."
8774
+ },
8775
+ {
8776
+ "name": "entity-b",
8777
+ "type": {
8778
+ "text": "string"
8779
+ },
8780
+ "fieldName": "entityB",
8781
+ "description": "The reference to the `<pc-entity>` providing the second constrained body."
8782
+ },
8783
+ {
8784
+ "name": "limits",
8785
+ "type": {
8786
+ "text": "string"
8787
+ },
8788
+ "fieldName": "limits",
8789
+ "default": "-45 45",
8790
+ "description": "The rotation or travel limits of the joint. Accepts 2 space-separated numbers."
8791
+ },
8792
+ {
8793
+ "name": "linear-damping",
8794
+ "type": {
8795
+ "text": "string"
8796
+ },
8797
+ "fieldName": "linearDamping",
8798
+ "default": "1 1 1",
8799
+ "description": "The spring damping of the joint per linear axis. Accepts 3 space-separated numbers."
8800
+ },
8801
+ {
8802
+ "name": "linear-equilibrium",
8803
+ "type": {
8804
+ "text": "string"
8805
+ },
8806
+ "fieldName": "linearEquilibrium",
8807
+ "default": "0 0 0",
8808
+ "description": "The rest point of the joint's linear springs. Accepts 3 space-separated numbers."
8809
+ },
8810
+ {
8811
+ "name": "linear-limits-x",
8812
+ "type": {
8813
+ "text": "string"
8814
+ },
8815
+ "fieldName": "linearLimitsX",
8816
+ "default": "0 0",
8817
+ "description": "The translation limits of the joint along its X axis. Accepts 2 space-separated numbers."
8818
+ },
8819
+ {
8820
+ "name": "linear-limits-y",
8821
+ "type": {
8822
+ "text": "string"
8823
+ },
8824
+ "fieldName": "linearLimitsY",
8825
+ "default": "0 0",
8826
+ "description": "The translation limits of the joint along its Y axis. Accepts 2 space-separated numbers."
8827
+ },
8828
+ {
8829
+ "name": "linear-limits-z",
8830
+ "type": {
8831
+ "text": "string"
8832
+ },
8833
+ "fieldName": "linearLimitsZ",
8834
+ "default": "0 0",
8835
+ "description": "The translation limits of the joint along its Z axis. Accepts 2 space-separated numbers."
8836
+ },
8837
+ {
8838
+ "name": "linear-motion-x",
8839
+ "type": {
8840
+ "text": "'locked' | 'limited' | 'free'"
8841
+ },
8842
+ "fieldName": "linearMotionX",
8843
+ "default": "locked",
8844
+ "description": "How the joint constrains translation along its X axis."
8845
+ },
8846
+ {
8847
+ "name": "linear-motion-y",
8848
+ "type": {
8849
+ "text": "'locked' | 'limited' | 'free'"
8850
+ },
8851
+ "fieldName": "linearMotionY",
8852
+ "default": "locked",
8853
+ "description": "How the joint constrains translation along its Y axis."
8854
+ },
8855
+ {
8856
+ "name": "linear-motion-z",
8857
+ "type": {
8858
+ "text": "'locked' | 'limited' | 'free'"
8859
+ },
8860
+ "fieldName": "linearMotionZ",
8861
+ "default": "locked",
8862
+ "description": "How the joint constrains translation along its Z axis."
8863
+ },
8864
+ {
8865
+ "name": "linear-stiffness",
8866
+ "type": {
8867
+ "text": "string"
8868
+ },
8869
+ "fieldName": "linearStiffness",
8870
+ "default": "0 0 0",
8871
+ "description": "The spring stiffness of the joint per linear axis. Accepts 3 space-separated numbers."
8872
+ },
8873
+ {
8874
+ "name": "max-motor-force",
8875
+ "type": {
8876
+ "text": "number"
8877
+ },
8878
+ "fieldName": "maxMotorForce",
8879
+ "default": "0",
8880
+ "description": "The maximum torque or force of the joint's motor."
8881
+ },
8882
+ {
8883
+ "name": "motor-speed",
8884
+ "type": {
8885
+ "text": "number"
8886
+ },
8887
+ "fieldName": "motorSpeed",
8888
+ "default": "0",
8889
+ "description": "The target speed of the joint's motor."
8890
+ },
8891
+ {
8892
+ "name": "swing-limit-y",
8893
+ "type": {
8894
+ "text": "number"
8895
+ },
8896
+ "fieldName": "swingLimitY",
8897
+ "default": "45",
8898
+ "description": "The maximum swing of the joint around the joint frame's Y axis."
8899
+ },
8900
+ {
8901
+ "name": "swing-limit-z",
8902
+ "type": {
8903
+ "text": "number"
8904
+ },
8905
+ "fieldName": "swingLimitZ",
8906
+ "default": "45",
8907
+ "description": "The maximum swing of the joint around the joint frame's Z axis."
8908
+ },
8909
+ {
8910
+ "name": "twist-limit",
8911
+ "type": {
8912
+ "text": "number"
8913
+ },
8914
+ "fieldName": "twistLimit",
8915
+ "default": "20",
8916
+ "description": "The maximum twist of the joint about its primary axis."
8917
+ },
8918
+ {
8919
+ "name": "type",
8920
+ "type": {
8921
+ "text": "'fixed' | 'ball' | 'hinge' | 'slider' | '6dof'"
8922
+ },
8923
+ "fieldName": "type",
8924
+ "default": "fixed",
8925
+ "description": "The type of the joint."
8926
+ }
8927
+ ],
8928
+ "superclass": {
8929
+ "name": "ComponentElement",
8930
+ "module": "/src/components/component"
8931
+ },
8932
+ "tagName": "pc-joint",
8933
+ "customElement": true
8934
+ }
8935
+ ],
8936
+ "exports": [
8937
+ {
8938
+ "kind": "custom-element-definition",
8939
+ "name": "pc-joint",
8940
+ "declaration": {
8941
+ "name": "JointComponentElement",
8942
+ "module": "src/components/joint-component.ts"
8943
+ }
8944
+ },
8945
+ {
8946
+ "kind": "js",
8947
+ "name": "JointComponentElement",
8948
+ "declaration": {
8949
+ "name": "JointComponentElement",
8950
+ "module": "src/components/joint-component.ts"
8951
+ }
8952
+ }
8953
+ ]
8954
+ },
7926
8955
  {
7927
8956
  "kind": "javascript-module",
7928
8957
  "path": "src/components/layoutchild-component.ts",