skinview3d-node 3.4.2-node.1

package/libs/model.d.ts

@@ -0,0 +1,76 @@
+import { NameTagObject } from './nametag.js';
+import type { ModelType } from './utils/index.js';
+import { Group, Mesh, Object3D, Texture } from 'three';
+/**
+ * Notice that innerLayer and outerLayer may NOT be the direct children of the Group.
+ */
+export declare class BodyPart extends Group {
+    readonly innerLayer: Object3D;
+    readonly outerLayer: Object3D;
+    constructor(innerLayer: Object3D, outerLayer: Object3D);
+}
+export declare class SkinObject extends Group {
+    readonly head: BodyPart;
+    readonly body: BodyPart;
+    readonly rightArm: BodyPart;
+    readonly leftArm: BodyPart;
+    readonly rightLeg: BodyPart;
+    readonly leftLeg: BodyPart;
+    private modelListeners;
+    private slim;
+    private _map;
+    private layer1Material;
+    private layer1MaterialBiased;
+    private layer2Material;
+    private layer2MaterialBiased;
+    constructor();
+    get map(): Texture | null;
+    set map(newMap: Texture | null);
+    get modelType(): ModelType;
+    set modelType(value: ModelType);
+    private getBodyParts;
+    setInnerLayerVisible(value: boolean): void;
+    setOuterLayerVisible(value: boolean): void;
+    resetJoints(): void;
+}
+export declare class CapeObject extends Group {
+    readonly cape: Mesh;
+    private material;
+    constructor();
+    get map(): Texture | null;
+    set map(newMap: Texture | null);
+}
+export declare class ElytraObject extends Group {
+    readonly leftWing: Group;
+    readonly rightWing: Group;
+    private material;
+    constructor();
+    resetJoints(): void;
+    /**
+     * Mirrors the position & rotation of left wing,
+     * and apply them to the right wing.
+     */
+    updateRightWing(): void;
+    get map(): Texture | null;
+    set map(newMap: Texture | null);
+}
+export declare class EarsObject extends Group {
+    readonly rightEar: Mesh;
+    readonly leftEar: Mesh;
+    private material;
+    constructor();
+    get map(): Texture | null;
+    set map(newMap: Texture | null);
+}
+export type BackEquipment = 'cape' | 'elytra';
+export declare class PlayerObject extends Group {
+    readonly skin: SkinObject;
+    readonly cape: CapeObject;
+    readonly elytra: ElytraObject;
+    readonly ears: EarsObject;
+    nameTag?: NameTagObject;
+    constructor();
+    get backEquipment(): BackEquipment | null;
+    set backEquipment(value: BackEquipment | null);
+    resetJoints(): void;
+}

package/libs/nametag.d.ts

@@ -0,0 +1,89 @@
+import { Sprite } from 'three';
+export interface NameTagOptions {
+    /**
+     * A font specification using the CSS value syntax.
+     *
+     * The default value uses `Minecraft` font from
+     * {@link https://github.com/South-Paw/typeface-minecraft | South-Paw/typeface-minecraft},
+     * which is available at `skinview3d/assets/minecraft.woff2`.
+     *
+     * In order to use this font, please add the `@font-face` rule to your CSS:
+     * ```css
+     * ＠font-face {
+     *   font-family: 'Minecraft';
+     *   src: url('/path/to/minecraft.woff2') format('woff2');
+     * }
+     * ```
+     * Remember to replace the font URL based on your situation.
+     *
+     * @defaultValue `"48px Minecraft"`
+     */
+    font?: string;
+    /**
+     * Whether to repaint the name tag after the desired font is loaded.
+     *
+     * The font specified in `font` option may not be available when a {@link NameTagObject} is created,
+     * especially when you are using a web font. In this case, a fallback font will be used.
+     *
+     * If `repaintAfterLoaded` is `true`, the name tag is repainted after the desired font is loaded.
+     * This process can be monitored using {@link NameTagObject.painted}.
+     *
+     * @defaultValue `true`
+     */
+    repaintAfterLoaded?: boolean;
+    /**
+     * The space (in pixels) between the text and the border of the name tag.
+     *
+     * Order: **top**, **right**, **bottom**, **left** (clockwise).
+     *
+     * @defaultValue `[5, 10, 5, 10]`
+     */
+    margin?: [number, number, number, number];
+    /**
+     * The color, gradient, or pattern used to draw the text.
+     *
+     * @defaultValue `"white"`
+     */
+    textStyle?: string | CanvasGradient | CanvasPattern;
+    /**
+     * The color, gradient, or pattern used to draw the background.
+     *
+     * @defaultValue `"rgba(0,0,0,.25)"`
+     */
+    backgroundStyle?: string | CanvasGradient | CanvasPattern;
+    /**
+     * The height of the name tag object.
+     *
+     * @defaultValue `4.0`
+     */
+    height?: number;
+}
+/**
+ * A Minecraft name tag, i.e. a text label with background.
+ */
+export declare class NameTagObject extends Sprite {
+    /**
+     * A promise that is resolved after the name tag is fully painted.
+     *
+     * This will be a resolved promise, if
+     * {@link NameTagOptions.repaintAfterLoaded} is `false`, or
+     * the desired font is available when the `NameTagObject` is created.
+     *
+     * If {@link NameTagOptions.repaintAfterLoaded} is `true`, and
+     * the desired font hasn't been loaded when the `NameTagObject` is created,
+     * the name tag will be painted with the fallback font first, and then
+     * repainted with the desired font after it's loaded. This promise is
+     * resolved after repainting is done.
+     */
+    readonly painted: Promise<void>;
+    private text;
+    private font;
+    private margin;
+    private textStyle;
+    private backgroundStyle;
+    private height;
+    private textMaterial;
+    constructor(text?: string, options?: NameTagOptions);
+    private loadAndPaint;
+    private paint;
+}