@playcanvas/web-components 0.13.1 → 0.15.0

package/dist/colors.d.cts

@@ -1 +1 @@
-export declare const CSS_COLORS: Record<string, string>;
+export {};

package/dist/colors.d.ts

@@ -1 +1 @@
-export declare const CSS_COLORS: Record<string, string>;
+export {};

package/dist/components/joint-component.d.cts

@@ -0,0 +1,521 @@
+import type { JointComponent } from 'playcanvas';
+import { Vec2, Vec3 } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+type JointType = 'fixed' | 'ball' | 'hinge' | 'slider' | '6dof';
+type MotionMode = 'locked' | 'limited' | 'free';
+/**
+ * The JointComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-joint/ | `<pc-joint>`} elements.
+ * The JointComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * The entity holding the joint is not itself constrained. Its world transform defines the joint
+ * frame — the anchor point and axes the constraint operates about — with the local X axis as the
+ * primary axis: a hinge rotates about it, a slider translates along it and a ball joint twists
+ * about it. The constrained bodies are referenced by `entity-a` and `entity-b`, both of which need
+ * a rigid body component; leaving `entity-b` empty constrains `entity-a` to a fixed point in world
+ * space. The underlying engine component is in alpha, so its API may change.
+ *
+ * @fires {CustomEvent} break - 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.
+ *
+ * @category Components
+ */
+declare class JointComponentElement extends ComponentElement {
+    /**
+     * The spring damping of the joint per angular axis.
+     */
+    private _angularDamping;
+    /**
+     * The rest angle of the joint's angular springs.
+     */
+    private _angularEquilibrium;
+    /**
+     * The rotation limits of the joint about its X axis.
+     */
+    private _angularLimitsX;
+    /**
+     * The rotation limits of the joint about its Y axis.
+     */
+    private _angularLimitsY;
+    /**
+     * The rotation limits of the joint about its Z axis.
+     */
+    private _angularLimitsZ;
+    /**
+     * The rotational degree of freedom of the joint about its X axis.
+     */
+    private _angularMotionX;
+    /**
+     * The rotational degree of freedom of the joint about its Y axis.
+     */
+    private _angularMotionY;
+    /**
+     * The rotational degree of freedom of the joint about its Z axis.
+     */
+    private _angularMotionZ;
+    /**
+     * The spring stiffness of the joint per angular axis.
+     */
+    private _angularStiffness;
+    /**
+     * The impulse above which the joint breaks.
+     */
+    private _breakImpulse;
+    /**
+     * Whether collision is enabled between the constrained bodies.
+     */
+    private _enableCollision;
+    /**
+     * Whether the joint's limits are enforced.
+     */
+    private _enableLimits;
+    /**
+     * The reference to the entity providing the first constrained body.
+     */
+    private _entityA;
+    /**
+     * The reference to the entity providing the second constrained body.
+     */
+    private _entityB;
+    /**
+     * The rotation or travel limits of the joint.
+     */
+    private _limits;
+    /**
+     * The spring damping of the joint per linear axis.
+     */
+    private _linearDamping;
+    /**
+     * The rest point of the joint's linear springs.
+     */
+    private _linearEquilibrium;
+    /**
+     * The translation limits of the joint along its X axis.
+     */
+    private _linearLimitsX;
+    /**
+     * The translation limits of the joint along its Y axis.
+     */
+    private _linearLimitsY;
+    /**
+     * The translation limits of the joint along its Z axis.
+     */
+    private _linearLimitsZ;
+    /**
+     * The linear degree of freedom of the joint along its X axis.
+     */
+    private _linearMotionX;
+    /**
+     * The linear degree of freedom of the joint along its Y axis.
+     */
+    private _linearMotionY;
+    /**
+     * The linear degree of freedom of the joint along its Z axis.
+     */
+    private _linearMotionZ;
+    /**
+     * The spring stiffness of the joint per linear axis.
+     */
+    private _linearStiffness;
+    /**
+     * The maximum torque or force of the joint's motor.
+     */
+    private _maxMotorForce;
+    /**
+     * The target speed of the joint's motor.
+     */
+    private _motorSpeed;
+    /**
+     * The maximum swing of the joint around the joint frame's Y axis.
+     */
+    private _swingLimitY;
+    /**
+     * The maximum swing of the joint around the joint frame's Z axis.
+     */
+    private _swingLimitZ;
+    /**
+     * The maximum twist of the joint about its primary axis.
+     */
+    private _twistLimit;
+    /**
+     * The type of the joint.
+     */
+    private _type;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): {
+        angularDamping: Vec3;
+        angularEquilibrium: Vec3;
+        angularLimitsX: Vec2;
+        angularLimitsY: Vec2;
+        angularLimitsZ: Vec2;
+        angularMotionX: MotionMode;
+        angularMotionY: MotionMode;
+        angularMotionZ: MotionMode;
+        angularStiffness: Vec3;
+        breakImpulse: number;
+        enableCollision: boolean;
+        enableLimits: boolean;
+        entityA: import("playcanvas").Entity | null;
+        entityB: import("playcanvas").Entity | null;
+        limits: Vec2;
+        linearDamping: Vec3;
+        linearEquilibrium: Vec3;
+        linearLimitsX: Vec2;
+        linearLimitsY: Vec2;
+        linearLimitsZ: Vec2;
+        linearMotionX: MotionMode;
+        linearMotionY: MotionMode;
+        linearMotionZ: MotionMode;
+        linearStiffness: Vec3;
+        maxMotorForce: number;
+        motorSpeed: number;
+        swingLimitY: number;
+        swingLimitZ: number;
+        twistLimit: number;
+        type: JointType;
+    };
+    private _onBreak;
+    protected initComponent(): void;
+    /**
+     * Gets the underlying PlayCanvas joint component.
+     * @returns The joint component.
+     */
+    get component(): JointComponent;
+    /**
+     * Sets the spring damping of a 6dof joint per angular axis, used on axes with a non-zero
+     * angular-stiffness.
+     * @param value - The angular spring damping.
+     */
+    set angularDamping(value: Vec3);
+    /**
+     * Gets the spring damping of the joint per angular axis.
+     * @returns The angular spring damping.
+     */
+    get angularDamping(): Vec3;
+    /**
+     * Sets the rest angle of a 6dof joint's angular springs in degrees per axis, used on axes with
+     * a non-zero angular-stiffness.
+     * @param value - The angular spring rest angles.
+     */
+    set angularEquilibrium(value: Vec3);
+    /**
+     * Gets the rest angle of the joint's angular springs.
+     * @returns The angular spring rest angles.
+     */
+    get angularEquilibrium(): Vec3;
+    /**
+     * Sets the lower and upper rotation limit of a 6dof joint about its X axis in degrees, used
+     * when angular-motion-x is limited.
+     * @param value - The X axis rotation limits.
+     */
+    set angularLimitsX(value: Vec2);
+    /**
+     * Gets the rotation limits of the joint about its X axis.
+     * @returns The X axis rotation limits.
+     */
+    get angularLimitsX(): Vec2;
+    /**
+     * Sets the lower and upper rotation limit of a 6dof joint about its Y axis in degrees, used
+     * when angular-motion-y is limited.
+     * @param value - The Y axis rotation limits.
+     */
+    set angularLimitsY(value: Vec2);
+    /**
+     * Gets the rotation limits of the joint about its Y axis.
+     * @returns The Y axis rotation limits.
+     */
+    get angularLimitsY(): Vec2;
+    /**
+     * Sets the lower and upper rotation limit of a 6dof joint about its Z axis in degrees, used
+     * when angular-motion-z is limited.
+     * @param value - The Z axis rotation limits.
+     */
+    set angularLimitsZ(value: Vec2);
+    /**
+     * Gets the rotation limits of the joint about its Z axis.
+     * @returns The Z axis rotation limits.
+     */
+    get angularLimitsZ(): Vec2;
+    /**
+     * Sets how a 6dof joint constrains rotation about its X axis. Can be `locked`, `limited` or
+     * `free`. Defaults to `locked`.
+     * @param value - The X axis rotational degree of freedom.
+     */
+    set angularMotionX(value: MotionMode);
+    /**
+     * Gets how the joint constrains rotation about its X axis.
+     * @returns The X axis rotational degree of freedom.
+     */
+    get angularMotionX(): MotionMode;
+    /**
+     * Sets how a 6dof joint constrains rotation about its Y axis. Can be `locked`, `limited` or
+     * `free`. Defaults to `locked`.
+     * @param value - The Y axis rotational degree of freedom.
+     */
+    set angularMotionY(value: MotionMode);
+    /**
+     * Gets how the joint constrains rotation about its Y axis.
+     * @returns The Y axis rotational degree of freedom.
+     */
+    get angularMotionY(): MotionMode;
+    /**
+     * Sets how a 6dof joint constrains rotation about its Z axis. Can be `locked`, `limited` or
+     * `free`. Defaults to `locked`.
+     * @param value - The Z axis rotational degree of freedom.
+     */
+    set angularMotionZ(value: MotionMode);
+    /**
+     * Gets how the joint constrains rotation about its Z axis.
+     * @returns The Z axis rotational degree of freedom.
+     */
+    get angularMotionZ(): MotionMode;
+    /**
+     * Sets the spring stiffness of a 6dof joint per angular axis, where 0 disables the spring on
+     * that axis.
+     * @param value - The angular spring stiffness.
+     */
+    set angularStiffness(value: Vec3);
+    /**
+     * Gets the spring stiffness of the joint per angular axis.
+     * @returns The angular spring stiffness.
+     */
+    get angularStiffness(): Vec3;
+    /**
+     * Sets the impulse in newton seconds above which the joint breaks. Defaults to `Infinity`,
+     * which makes the joint unbreakable.
+     * @param value - The break impulse.
+     */
+    set breakImpulse(value: number);
+    /**
+     * Gets the impulse above which the joint breaks.
+     * @returns The break impulse.
+     */
+    get breakImpulse(): number;
+    /**
+     * Sets whether collision is enabled between the two constrained bodies.
+     * @param value - Whether collision is enabled.
+     */
+    set enableCollision(value: boolean);
+    /**
+     * Gets whether collision is enabled between the two constrained bodies.
+     * @returns Whether collision is enabled.
+     */
+    get enableCollision(): boolean;
+    /**
+     * Sets whether the limits of a hinge, slider or ball joint are enforced.
+     * @param value - Whether the limits are enforced.
+     */
+    set enableLimits(value: boolean);
+    /**
+     * Gets whether the limits of the joint are enforced.
+     * @returns Whether the limits are enforced.
+     */
+    get enableLimits(): boolean;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` providing
+     * the first constrained body. The reference resolves when it is set, so an entity created
+     * later is picked up by setting the attribute again.
+     * @param value - The first body's entity reference.
+     */
+    set entityA(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` providing the first constrained body.
+     * @returns The first body's entity reference.
+     */
+    get entityA(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` providing
+     * the second constrained body, or empty to constrain the first body to a fixed point in world
+     * space. The reference resolves when it is set, so an entity created later is picked up by
+     * setting the attribute again.
+     * @param value - The second body's entity reference.
+     */
+    set entityB(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` providing the second constrained body.
+     * @returns The second body's entity reference.
+     */
+    get entityB(): string;
+    /**
+     * Sets the lower and upper limit of a hinge joint's rotation in degrees, or a slider joint's
+     * travel in meters, applied when enable-limits is set.
+     * @param value - The rotation or travel limits.
+     */
+    set limits(value: Vec2);
+    /**
+     * Gets the rotation or travel limits of the joint.
+     * @returns The rotation or travel limits.
+     */
+    get limits(): Vec2;
+    /**
+     * Sets the spring damping of a 6dof joint per linear axis, used on axes with a non-zero
+     * linear-stiffness.
+     * @param value - The linear spring damping.
+     */
+    set linearDamping(value: Vec3);
+    /**
+     * Gets the spring damping of the joint per linear axis.
+     * @returns The linear spring damping.
+     */
+    get linearDamping(): Vec3;
+    /**
+     * Sets the rest point of a 6dof joint's linear springs in meters per axis, used on axes with a
+     * non-zero linear-stiffness.
+     * @param value - The linear spring rest points.
+     */
+    set linearEquilibrium(value: Vec3);
+    /**
+     * Gets the rest point of the joint's linear springs.
+     * @returns The linear spring rest points.
+     */
+    get linearEquilibrium(): Vec3;
+    /**
+     * Sets the lower and upper translation limit of a 6dof joint along its X axis in meters, used
+     * when linear-motion-x is limited.
+     * @param value - The X axis translation limits.
+     */
+    set linearLimitsX(value: Vec2);
+    /**
+     * Gets the translation limits of the joint along its X axis.
+     * @returns The X axis translation limits.
+     */
+    get linearLimitsX(): Vec2;
+    /**
+     * Sets the lower and upper translation limit of a 6dof joint along its Y axis in meters, used
+     * when linear-motion-y is limited.
+     * @param value - The Y axis translation limits.
+     */
+    set linearLimitsY(value: Vec2);
+    /**
+     * Gets the translation limits of the joint along its Y axis.
+     * @returns The Y axis translation limits.
+     */
+    get linearLimitsY(): Vec2;
+    /**
+     * Sets the lower and upper translation limit of a 6dof joint along its Z axis in meters, used
+     * when linear-motion-z is limited.
+     * @param value - The Z axis translation limits.
+     */
+    set linearLimitsZ(value: Vec2);
+    /**
+     * Gets the translation limits of the joint along its Z axis.
+     * @returns The Z axis translation limits.
+     */
+    get linearLimitsZ(): Vec2;
+    /**
+     * Sets how a 6dof joint constrains translation along its X axis. Can be `locked`, `limited` or
+     * `free`. Defaults to `locked`.
+     * @param value - The X axis linear degree of freedom.
+     */
+    set linearMotionX(value: MotionMode);
+    /**
+     * Gets how the joint constrains translation along its X axis.
+     * @returns The X axis linear degree of freedom.
+     */
+    get linearMotionX(): MotionMode;
+    /**
+     * Sets how a 6dof joint constrains translation along its Y axis. Can be `locked`, `limited` or
+     * `free`. Defaults to `locked`.
+     * @param value - The Y axis linear degree of freedom.
+     */
+    set linearMotionY(value: MotionMode);
+    /**
+     * Gets how the joint constrains translation along its Y axis.
+     * @returns The Y axis linear degree of freedom.
+     */
+    get linearMotionY(): MotionMode;
+    /**
+     * Sets how a 6dof joint constrains translation along its Z axis. Can be `locked`, `limited` or
+     * `free`. Defaults to `locked`.
+     * @param value - The Z axis linear degree of freedom.
+     */
+    set linearMotionZ(value: MotionMode);
+    /**
+     * Gets how the joint constrains translation along its Z axis.
+     * @returns The Z axis linear degree of freedom.
+     */
+    get linearMotionZ(): MotionMode;
+    /**
+     * Sets the spring stiffness of a 6dof joint per linear axis, where 0 disables the spring on
+     * that axis.
+     * @param value - The linear spring stiffness.
+     */
+    set linearStiffness(value: Vec3);
+    /**
+     * Gets the spring stiffness of the joint per linear axis.
+     * @returns The linear spring stiffness.
+     */
+    get linearStiffness(): Vec3;
+    /**
+     * Sets the maximum torque in newton meters of a hinge joint's motor, or the maximum force in
+     * newtons of a slider joint's motor, where 0 disables the motor.
+     * @param value - The maximum motor torque or force.
+     */
+    set maxMotorForce(value: number);
+    /**
+     * Gets the maximum torque or force of the joint's motor.
+     * @returns The maximum motor torque or force.
+     */
+    get maxMotorForce(): number;
+    /**
+     * Sets the target speed of a hinge joint's motor in degrees per second, or a slider joint's
+     * motor in meters per second, active while max-motor-force is greater than 0.
+     * @param value - The motor's target speed.
+     */
+    set motorSpeed(value: number);
+    /**
+     * Gets the target speed of the joint's motor.
+     * @returns The motor's target speed.
+     */
+    get motorSpeed(): number;
+    /**
+     * Sets the maximum swing of a ball joint around the joint frame's Y axis in degrees, applied
+     * when enable-limits is set.
+     * @param value - The Y axis swing limit.
+     */
+    set swingLimitY(value: number);
+    /**
+     * Gets the maximum swing of the joint around the joint frame's Y axis.
+     * @returns The Y axis swing limit.
+     */
+    get swingLimitY(): number;
+    /**
+     * Sets the maximum swing of a ball joint around the joint frame's Z axis in degrees, applied
+     * when enable-limits is set.
+     * @param value - The Z axis swing limit.
+     */
+    set swingLimitZ(value: number);
+    /**
+     * Gets the maximum swing of the joint around the joint frame's Z axis.
+     * @returns The Z axis swing limit.
+     */
+    get swingLimitZ(): number;
+    /**
+     * Sets the maximum twist of a ball joint about its primary axis in degrees, applied when
+     * enable-limits is set.
+     * @param value - The twist limit.
+     */
+    set twistLimit(value: number);
+    /**
+     * Gets the maximum twist of the joint about its primary axis.
+     * @returns The twist limit.
+     */
+    get twistLimit(): number;
+    /**
+     * Sets the type of the joint. Can be `fixed`, `ball`, `hinge`, `slider` or `6dof`. Defaults to
+     * `fixed`.
+     * @param value - The joint type.
+     */
+    set type(value: JointType);
+    /**
+     * Gets the type of the joint.
+     * @returns The joint type.
+     */
+    get type(): JointType;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { JointComponentElement };