@playcanvas/web-components 0.14.0 → 0.15.0

package/dist/custom-elements.json

@@ -1594,6 +1594,14 @@
             "module": "src/index.ts"
           }
         },
+        {
+          "kind": "js",
+          "name": "JointComponentElement",
+          "declaration": {
+            "name": "JointComponentElement",
+            "module": "src/index.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "LayoutChildComponentElement",
@@ -8036,6 +8044,914 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/joint-component.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "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",
+          "name": "JointComponentElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "angularDamping",
+              "description": "Gets the spring damping of the joint per angular axis.",
+              "parameters": [
+                {
+                  "description": "The angular spring damping.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularEquilibrium",
+              "description": "Gets the rest angle of the joint's angular springs.",
+              "parameters": [
+                {
+                  "description": "The angular spring rest angles.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularLimitsX",
+              "description": "Gets the rotation limits of the joint about its X axis.",
+              "parameters": [
+                {
+                  "description": "The X axis rotation limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularLimitsY",
+              "description": "Gets the rotation limits of the joint about its Y axis.",
+              "parameters": [
+                {
+                  "description": "The Y axis rotation limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularLimitsZ",
+              "description": "Gets the rotation limits of the joint about its Z axis.",
+              "parameters": [
+                {
+                  "description": "The Z axis rotation limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularMotionX",
+              "description": "Gets how the joint constrains rotation about its X axis.",
+              "parameters": [
+                {
+                  "description": "The X axis rotational degree of freedom.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularMotionY",
+              "description": "Gets how the joint constrains rotation about its Y axis.",
+              "parameters": [
+                {
+                  "description": "The Y axis rotational degree of freedom.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularMotionZ",
+              "description": "Gets how the joint constrains rotation about its Z axis.",
+              "parameters": [
+                {
+                  "description": "The Z axis rotational degree of freedom.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "angularStiffness",
+              "description": "Gets the spring stiffness of the joint per angular axis.",
+              "parameters": [
+                {
+                  "description": "The angular spring stiffness.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "breakImpulse",
+              "description": "Gets the impulse above which the joint breaks.",
+              "parameters": [
+                {
+                  "description": "The break impulse.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "closestApp",
+              "type": {
+                "text": "AppElement | null"
+              },
+              "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.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "closestEntity",
+              "type": {
+                "text": "EntityBaseElement | null"
+              },
+              "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.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "component",
+              "type": {
+                "text": "Component | null"
+              },
+              "description": "Gets the underlying PlayCanvas joint component.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "ComponentElement",
+                "module": "src/components/component.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "enableCollision",
+              "description": "Gets whether collision is enabled between the two constrained bodies.",
+              "parameters": [
+                {
+                  "description": "Whether collision is enabled.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "enabled",
+              "description": "Gets the enabled state of the component.",
+              "parameters": [
+                {
+                  "description": "The enabled state of the component.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "inheritedFrom": {
+                "name": "ComponentElement",
+                "module": "src/components/component.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "enableLimits",
+              "description": "Gets whether the limits of the joint are enforced.",
+              "parameters": [
+                {
+                  "description": "Whether the limits are enforced.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "entityA",
+              "description": "Gets the reference to the `<pc-entity>` providing the first constrained body.",
+              "parameters": [
+                {
+                  "description": "The first body's entity reference.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "entityB",
+              "description": "Gets the reference to the `<pc-entity>` providing the second constrained body.",
+              "parameters": [
+                {
+                  "description": "The second body's entity reference.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "limits",
+              "description": "Gets the rotation or travel limits of the joint.",
+              "parameters": [
+                {
+                  "description": "The rotation or travel limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearDamping",
+              "description": "Gets the spring damping of the joint per linear axis.",
+              "parameters": [
+                {
+                  "description": "The linear spring damping.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearEquilibrium",
+              "description": "Gets the rest point of the joint's linear springs.",
+              "parameters": [
+                {
+                  "description": "The linear spring rest points.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearLimitsX",
+              "description": "Gets the translation limits of the joint along its X axis.",
+              "parameters": [
+                {
+                  "description": "The X axis translation limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearLimitsY",
+              "description": "Gets the translation limits of the joint along its Y axis.",
+              "parameters": [
+                {
+                  "description": "The Y axis translation limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearLimitsZ",
+              "description": "Gets the translation limits of the joint along its Z axis.",
+              "parameters": [
+                {
+                  "description": "The Z axis translation limits.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearMotionX",
+              "description": "Gets how the joint constrains translation along its X axis.",
+              "parameters": [
+                {
+                  "description": "The X axis linear degree of freedom.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearMotionY",
+              "description": "Gets how the joint constrains translation along its Y axis.",
+              "parameters": [
+                {
+                  "description": "The Y axis linear degree of freedom.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearMotionZ",
+              "description": "Gets how the joint constrains translation along its Z axis.",
+              "parameters": [
+                {
+                  "description": "The Z axis linear degree of freedom.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "linearStiffness",
+              "description": "Gets the spring stiffness of the joint per linear axis.",
+              "parameters": [
+                {
+                  "description": "The linear spring stiffness.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "maxMotorForce",
+              "description": "Gets the maximum torque or force of the joint's motor.",
+              "parameters": [
+                {
+                  "description": "The maximum motor torque or force.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "motorSpeed",
+              "description": "Gets the target speed of the joint's motor.",
+              "parameters": [
+                {
+                  "description": "The motor's target speed.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "ready",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "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.",
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "swingLimitY",
+              "description": "Gets the maximum swing of the joint around the joint frame's Y axis.",
+              "parameters": [
+                {
+                  "description": "The Y axis swing limit.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "swingLimitZ",
+              "description": "Gets the maximum swing of the joint around the joint frame's Z axis.",
+              "parameters": [
+                {
+                  "description": "The Z axis swing limit.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "twistLimit",
+              "description": "Gets the maximum twist of the joint about its primary axis.",
+              "parameters": [
+                {
+                  "description": "The twist limit.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "type",
+              "description": "Gets the type of the joint.",
+              "parameters": [
+                {
+                  "description": "The joint type.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "break",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "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."
+            },
+            {
+              "name": "ready",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "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.",
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "angular-damping",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "angularDamping",
+              "default": "1 1 1",
+              "description": "The spring damping of the joint per angular axis. Accepts 3 space-separated numbers."
+            },
+            {
+              "name": "angular-equilibrium",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "angularEquilibrium",
+              "default": "0 0 0",
+              "description": "The rest angle of the joint's angular springs. Accepts 3 space-separated numbers."
+            },
+            {
+              "name": "angular-limits-x",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "angularLimitsX",
+              "default": "0 0",
+              "description": "The rotation limits of the joint about its X axis. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "angular-limits-y",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "angularLimitsY",
+              "default": "0 0",
+              "description": "The rotation limits of the joint about its Y axis. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "angular-limits-z",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "angularLimitsZ",
+              "default": "0 0",
+              "description": "The rotation limits of the joint about its Z axis. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "angular-motion-x",
+              "type": {
+                "text": "'locked' | 'limited' | 'free'"
+              },
+              "fieldName": "angularMotionX",
+              "default": "locked",
+              "description": "How the joint constrains rotation about its X axis."
+            },
+            {
+              "name": "angular-motion-y",
+              "type": {
+                "text": "'locked' | 'limited' | 'free'"
+              },
+              "fieldName": "angularMotionY",
+              "default": "locked",
+              "description": "How the joint constrains rotation about its Y axis."
+            },
+            {
+              "name": "angular-motion-z",
+              "type": {
+                "text": "'locked' | 'limited' | 'free'"
+              },
+              "fieldName": "angularMotionZ",
+              "default": "locked",
+              "description": "How the joint constrains rotation about its Z axis."
+            },
+            {
+              "name": "angular-stiffness",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "angularStiffness",
+              "default": "0 0 0",
+              "description": "The spring stiffness of the joint per angular axis. Accepts 3 space-separated numbers."
+            },
+            {
+              "name": "break-impulse",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "breakImpulse",
+              "default": "Infinity",
+              "description": "The impulse above which the joint breaks."
+            },
+            {
+              "name": "enable-collision",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "enableCollision",
+              "default": "false",
+              "description": "Whether collision is enabled between the two constrained bodies."
+            },
+            {
+              "name": "enable-limits",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "enableLimits",
+              "default": "false",
+              "description": "Whether the limits of the joint are enforced."
+            },
+            {
+              "name": "enabled",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "enabled",
+              "default": "true",
+              "description": "The enabled state of the component.",
+              "inheritedFrom": {
+                "name": "ComponentElement",
+                "module": "src/components/component.ts"
+              }
+            },
+            {
+              "name": "entity-a",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "entityA",
+              "description": "The reference to the `<pc-entity>` providing the first constrained body."
+            },
+            {
+              "name": "entity-b",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "entityB",
+              "description": "The reference to the `<pc-entity>` providing the second constrained body."
+            },
+            {
+              "name": "limits",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "limits",
+              "default": "-45 45",
+              "description": "The rotation or travel limits of the joint. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "linear-damping",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "linearDamping",
+              "default": "1 1 1",
+              "description": "The spring damping of the joint per linear axis. Accepts 3 space-separated numbers."
+            },
+            {
+              "name": "linear-equilibrium",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "linearEquilibrium",
+              "default": "0 0 0",
+              "description": "The rest point of the joint's linear springs. Accepts 3 space-separated numbers."
+            },
+            {
+              "name": "linear-limits-x",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "linearLimitsX",
+              "default": "0 0",
+              "description": "The translation limits of the joint along its X axis. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "linear-limits-y",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "linearLimitsY",
+              "default": "0 0",
+              "description": "The translation limits of the joint along its Y axis. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "linear-limits-z",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "linearLimitsZ",
+              "default": "0 0",
+              "description": "The translation limits of the joint along its Z axis. Accepts 2 space-separated numbers."
+            },
+            {
+              "name": "linear-motion-x",
+              "type": {
+                "text": "'locked' | 'limited' | 'free'"
+              },
+              "fieldName": "linearMotionX",
+              "default": "locked",
+              "description": "How the joint constrains translation along its X axis."
+            },
+            {
+              "name": "linear-motion-y",
+              "type": {
+                "text": "'locked' | 'limited' | 'free'"
+              },
+              "fieldName": "linearMotionY",
+              "default": "locked",
+              "description": "How the joint constrains translation along its Y axis."
+            },
+            {
+              "name": "linear-motion-z",
+              "type": {
+                "text": "'locked' | 'limited' | 'free'"
+              },
+              "fieldName": "linearMotionZ",
+              "default": "locked",
+              "description": "How the joint constrains translation along its Z axis."
+            },
+            {
+              "name": "linear-stiffness",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "linearStiffness",
+              "default": "0 0 0",
+              "description": "The spring stiffness of the joint per linear axis. Accepts 3 space-separated numbers."
+            },
+            {
+              "name": "max-motor-force",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "maxMotorForce",
+              "default": "0",
+              "description": "The maximum torque or force of the joint's motor."
+            },
+            {
+              "name": "motor-speed",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "motorSpeed",
+              "default": "0",
+              "description": "The target speed of the joint's motor."
+            },
+            {
+              "name": "swing-limit-y",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "swingLimitY",
+              "default": "45",
+              "description": "The maximum swing of the joint around the joint frame's Y axis."
+            },
+            {
+              "name": "swing-limit-z",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "swingLimitZ",
+              "default": "45",
+              "description": "The maximum swing of the joint around the joint frame's Z axis."
+            },
+            {
+              "name": "twist-limit",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "twistLimit",
+              "default": "20",
+              "description": "The maximum twist of the joint about its primary axis."
+            },
+            {
+              "name": "type",
+              "type": {
+                "text": "'fixed' | 'ball' | 'hinge' | 'slider' | '6dof'"
+              },
+              "fieldName": "type",
+              "default": "fixed",
+              "description": "The type of the joint."
+            }
+          ],
+          "superclass": {
+            "name": "ComponentElement",
+            "module": "/src/components/component"
+          },
+          "tagName": "pc-joint",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "pc-joint",
+          "declaration": {
+            "name": "JointComponentElement",
+            "module": "src/components/joint-component.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "JointComponentElement",
+          "declaration": {
+            "name": "JointComponentElement",
+            "module": "src/components/joint-component.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/layoutchild-component.ts",