@wodzik/cubecore 0.1.0

package/skin/skin.d.ts

@@ -0,0 +1,911 @@
+/**
+ * Skin — how the cube looks, as plain data (serialisable, presets below).
+ * Everything the renderer draws comes from here, per theme.
+ */
+import type { MaskState } from "../core/index.js";
+import type { Decal, FeatureUse } from "./attachments.js";
+import type { PieceKind, StickerOverlay, StickerPaths, StickerShape } from "./shapes.js";
+export interface Skin {
+    /** Plastic colour. */
+    body: string;
+    /**
+     * Plastic between the tiles in 2D pictures (@cubecore/image); null =
+     * see-through (the page shows in the gaps). Default: `body`. Light
+     * plastic with light tiles (white on ivory) blurs together in 2D.
+     */
+    pictureBody?: string | null;
+    /** Cubie size relative to the 1-unit grid (1 = no gap between cubies). */
+    cubieSize: number;
+    /** Rounding of the cubie edges, 0..0.5. */
+    cubieRadius: number;
+    /**
+     * Shrinks the black body under the tiles (cubie units per side): thick
+     * stickerless tiles then form the piece's outside and the core shows only
+     * deep in the gaps. Tiles reach down to meet it. Default 0.
+     */
+    bodyInset?: number;
+    /**
+     * Stickerless piece bodies shaped like their tiles instead of a box: under
+     * each tile the plastic continues `depth` deep into the cubie, narrowing
+     * by `taper` (the front of a piece is larger than its back; a centre piece
+     * is as round as its tile), around a rounded core `core` × the cubie size.
+     * Cubie units.
+     */
+    pieces?: {
+        depth: number;
+        taper: number;
+        core: number;
+        /**
+         * Coloured plastic: the piece under each tile takes the tile's colour (a
+         * corner is three coloured parts, an edge two, a centre one — like
+         * stickerless cubes moulded in colour); the core stays `body`.
+         */
+        colored?: boolean;
+        /**
+         * "skirt" (default): plastic `depth` deep under each tile; "solid": the
+         * same shape run through the whole piece, so the piece is filled with
+         * colour — the tapered walls meet inside it, the nearer tile's outermost,
+         * so inner faces split along the diagonals (a corner in three colours, an
+         * edge in two). Needs `colored`.
+         */
+        fill?: "skirt" | "solid";
+        /**
+         * Straight walls: the plastic first runs straight down along the tile
+         * outline to this depth, then narrows (`taper`) — real pieces have a flat
+         * bit of wall behind the tile before they narrow. Default: narrows at once.
+         */
+        wall?: number;
+        /**
+         * Corner-cutting relief: behind the tile, the material at the tile's
+         * corner(s) next to the face centre is cut away in a cone — `start` wide
+         * right under the tile (default 0), `radius` at `depth` below it. The tile's corner
+         * overhangs and passes in front of the centre when you cut a corner.
+         * `tile`: the cut reaches up into the tile to this height above the face
+         * (a thinner overhanging corner; at most where the tile's bevel starts).
+         * Corner pieces only, unless `edges`.
+         */
+        relief?: {
+            radius: number;
+            depth: number;
+            start?: number;
+            tile?: number;
+            edges?: boolean;
+        };
+        /**
+         * Radius of the dark mechanism ball in the middle (cubie units, default
+         * 1.15). The pieces' insides are cut flat where they would reach it —
+         * a corner's inner point, an edge's inner edge, a centre's back.
+         */
+        mechanism?: number;
+    };
+    stickers: {
+        /** Colour of each colour class, U R F D L B home-face order. */
+        colors: readonly [string, string, string, string, string, string];
+        /** Side of a sticker relative to a cubie face, 0..1. */
+        size: number;
+        /** Corner radius relative to the sticker, 0..0.5 (0.5 = circle) — used when `shape` is not given. */
+        radius: number;
+        /** Per-piece-kind corner radii (see shapes.ts) — overrides `radius`. */
+        shape?: StickerShape;
+        /** Custom outlines as SVG path data — override `shape` per piece kind. */
+        paths?: StickerPaths;
+        /** How far a tile stands out from the plastic (cubie units) — stickerless tiles are thicker. */
+        thickness?: number;
+        /**
+         * Per piece kind: a different tile size / thickness / edge round — e.g. a
+         * centre cap that is smaller and stands out more than the other tiles.
+         * Unset values fall back to `size` / `thickness` / `bevel`. `dome`: a top
+         * that is flat inside a circle (`flat` × the tile's reach) and falls `drop`
+         * lower at the corners.
+         */
+        kinds?: Partial<Record<PieceKind, {
+            size?: number;
+            thickness?: number;
+            bevel?: number;
+            dome?: {
+                flat: number;
+                drop: number;
+            };
+        }>>;
+        /** Radius of the rounded top edge of a tile (cubie units, ≤ thickness). Default 0 (sharp). */
+        bevel?: number;
+        /**
+         * "flat" — unlit, exact colours (printed-sticker look, default);
+         * "plastic" — lit with a soft highlight, so thick bevelled tiles read as moulded plastic.
+         */
+        material?: "flat" | "plastic";
+        /** Plastic finish: 0 = glossy (UV coated) … 1 = matte. Default 0.4. */
+        roughness?: number;
+        /**
+         * Sticker finish as on real cubes (implies lit plastic):
+         * "matte" — soft, diffuse, no sharp highlight;
+         * "uv" — UV-coated: a clear glossy coat with sharp reflections.
+         * Overrides `roughness`.
+         */
+        finish?: "matte" | "uv";
+        /**
+         * Stickerless: rounding of the cube's outer edges (cubie units). The two
+         * tiles meeting there each curve over half of it, so colour runs round
+         * the edge. Default 0 (a sharp edge).
+         */
+        edgeRadius?: number;
+        /**
+         * Stickerless: tile sides on the cube's outer edge reach the edge, so two
+         * faces' colours meet directly on edges and corners (no black line there);
+         * gaps remain only between neighbouring pieces on a face.
+         */
+        fillOuter?: boolean;
+        /**
+         * Stickers on the tiles: the tiles become the body's plastic (a raised
+         * black platform, rounded at the cube's edges) and a thin sticker of its
+         * own shape lies on each, kept `margin` from the cube's edges — a
+         * stickered cube.
+         */
+        overlay?: StickerOverlay;
+        /**
+         * A cube corner rounder than its edges (cubie units): the corner pieces
+         * are rounded off by a ball of this radius at the cube's corners.
+         */
+        cornerRound?: number;
+    };
+    /**
+     * The brand's sticker shapes for its stickered version (`withStickers`):
+     * tile size, outlines, and optionally a different centre size.
+     */
+    stickerSet?: StickerSet;
+    /**
+     * Images on stickers — logos, symbols, printed patterns (see
+     * attachments.ts). They follow their sticker. Brand logos are trademarks:
+     * apps supply their own, the library ships none.
+     */
+    decals?: readonly Decal[];
+    /** Extra geometry on stickers — holes, charging slots, your own types (see `defineFeature`). */
+    features?: readonly FeatureUse[];
+    /**
+     * Your own 3D pieces (glTF / GLB URLs) instead of the built-in geometry —
+     * see @cubecore/render pieceModels.ts for the convention (UFR corner, UF
+     * edge, U centre; materials sticker-U / sticker-F / sticker-R are
+     * recoloured). Kinds left out keep the built-in pieces; until a model has
+     * loaded (or if it fails), the built-in pieces are drawn. Stickers /
+     * outlines above still drive the 2D pictures.
+     */
+    models?: {
+        corner?: string;
+        edge?: string;
+        center?: string;
+        /** Uniform scale if the models aren't in cubie units. Default 1. */
+        scale?: number;
+        /** Height of the sticker surface above the cubie's face (for decals / features). Default: stickers.thickness. */
+        surface?: number;
+    };
+    /**
+     * Colours for masked stickers. `dim` fades the sticker colour towards the
+     * `ignored` grey by `dimAmount` — faded, but lighter / more coloured than
+     * a hidden sticker (towards the black body, white turned into that grey).
+     */
+    mask: {
+        ignored: string;
+        oriented: string;
+        dimAmount: number;
+    };
+    /**
+     * Floating "back" stickers showing the hidden faces. `colors`: a palette of
+     * their own (e.g. white hints turned blue-grey so they show on a light page).
+     */
+    hints: {
+        enabled: boolean;
+        distance: number;
+        opacity: number;
+        ignoredOpacity: number;
+        colors?: readonly [string, string, string, string, string, string];
+    };
+    background: string | null;
+    /**
+     * Adjustments for light and dark pages — whatever reads badly on one of
+     * them (grey masked stickers, white back stickers, the background). Pick
+     * one with `themed(skin, theme)`; renderers / pictures / the player take a
+     * `theme` option.
+     */
+    themes?: {
+        light?: SkinTheme;
+        dark?: SkinTheme;
+    };
+}
+/**
+ * A brand's stickers for its stickered cube (`withStickers`): the sticker's
+ * size, margin from the cube's edges and corner radii (see StickerOverlay),
+ * and how round the body is at the cube's edges.
+ */
+export interface StickerSet extends Omit<StickerOverlay, "thickness" | "bevel"> {
+    /** Rounding of the body at the cube's edges (cubie units). Default 0.1. */
+    edgeRadius?: number;
+    /** The stickered cube's plastic. Default a soft black (#222222). */
+    body?: string;
+    /** A cube corner rounder than the edges (cubie units) — see `stickers.cornerRound`. */
+    cornerRound?: number;
+    /** The centre piece's top under its sticker: flat in a circle, sloping to the corners (see `kinds.dome`). */
+    centerDome?: {
+        flat: number;
+        drop: number;
+    };
+    /** Corner radii of the plastic tops the stickers lie on (fractions of a face). Default: the stickers' own. */
+    base?: StickerShape;
+}
+/** How a stickered version's stickers stand: thick and rounded, thin (a real sticker) or a flat print. */
+export type StickerStyle = "raised" | "thin" | "flat";
+export interface SkinTheme {
+    body?: string;
+    background?: string | null;
+    mask?: Partial<Skin["mask"]>;
+    hints?: Partial<Skin["hints"]>;
+}
+export type Theme = "light" | "dark";
+/** The skin as it should look on a `theme` page (its `themes` overrides applied). */
+export declare function themed(skin: Skin, theme: Theme): Skin;
+/** Back-sticker colour: the hint palette if the skin has one, else the sticker's own. */
+export declare function hintColor(skin: Skin, colorClass: number, state: MaskState): string | null;
+/**
+ * QiYi SC tile outlines (corner, edge), measured from the plates of the cube
+ * model in QiYi's app: rounded corners, a big round towards the face centre
+ * and the edge tiles' long curve there. Stickerless — outer sides run to the
+ * cube edge.
+ */
+/**
+ * QiYi's stickered cubes, measured from the models in QiYi's app ("black
+ * rounded" / "black square"): flat stickers on black pedestals, ~0.87–0.89 of
+ * a face, kept 0.21 from the cube's edges; a big round on a corner sticker
+ * at the cube's corner; round centre stickers on a domed centre. The two
+ * differ only in how round the body is: at the edges 0.24 / 0.15, at the
+ * corners 0.37 / 0.22.
+ */
+export declare const QIYI_ROUND_STICKERS: StickerSet;
+/** The square one: the same stickers and pieces, only less rounded at the cube's edges and corners. */
+export declare const QIYI_SQUARE_STICKERS: StickerSet;
+/**
+ * Earlier skins, kept for reference (not in SKINS): the first GAN look, the
+ * i4 (with its holes — `default` is built from it), the GAN 356 M measured
+ * from a 3D model (`gan` / `ganStickers` are built from it), and the first
+ * generic looks `standard` (black plastic, stickers) and `stickerless`.
+ */
+export declare const ARCHIVED_SKINS: {
+    /**
+     * GAN-style stickerless: tiles almost fill each cubie face; corner tiles
+     * round off the corner facing the centre, edge tiles round their inner side
+     * into a tongue, centre tiles are nearly round. Add a logo as a decal.
+     */
+    gan: {
+        body: string;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        pieces: {
+            depth: number;
+            taper: number;
+            core: number;
+        };
+        stickers: {
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            thickness: number;
+            bevel: number;
+            edgeRadius: number;
+            material: "plastic";
+            fillOuter: true;
+        };
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /**
+     * GAN i4-style smart cube (from product photos): light translucent-grey
+     * internals showing in minimal gaps, thick matte tiles with soft edges, the
+     * cube's edges rounded so colour runs round them, squarish centres with
+     * four adjustment holes. The brand logo is up to the app (a decal).
+     */
+    ganI4: {
+        body: string;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        pieces: {
+            depth: number;
+            taper: number;
+            core: number;
+        };
+        stickers: {
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            thickness: number;
+            bevel: number;
+            edgeRadius: number;
+            material: "plastic";
+            roughness: number;
+            fillOuter: true;
+        };
+        features: {
+            select: {
+                kinds: "center"[];
+            };
+            type: string;
+            params: {
+                radius: number;
+                at: number[][];
+            };
+        }[];
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /**
+     * GAN 356 M (stickerless): square corner tiles, edge tiles with a round
+     * "tongue" towards the centre, near-round centres; thin glossy tiles.
+     * Shapes, sizes and colours measured from "GAN CUBE 356s M air" by Amyyu
+     * (https://sketchfab.com/3d-models/gan-cube-356s-m-air-dd4768b8fe2841c78e418230e5d9e192,
+     * CC BY 4.0); smoothed after the cube in GAN's app. No logo — that's up to the app (a decal).
+     */
+    gan356m: {
+        body: string;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        pieces: {
+            depth: number;
+            taper: number;
+            wall: number;
+            relief: {
+                radius: number;
+                depth: number;
+                start: number;
+                tile: number;
+            };
+            mechanism: number;
+            core: number;
+            fill: "solid";
+        };
+        stickers: {
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            thickness: number;
+            bevel: number;
+            kinds: {
+                center: {
+                    size: number;
+                    thickness: number;
+                    bevel: number;
+                };
+            };
+            edgeRadius: number;
+            material: "plastic";
+            roughness: number;
+            fillOuter: true;
+        };
+        stickerSet: {
+            size: number;
+            centerSize: number;
+            margin: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            edgeRadius: number;
+        };
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /** Black plastic, rounded stickers — a typical modern speed cube. */
+    standard: {
+        body: string;
+        cubieSize: number;
+        cubieRadius: number;
+        stickers: {
+            colors: readonly ["#ffffff", "#e8322f", "#1fb24a", "#ffd500", "#ff8a00", "#1e5eff"];
+            size: number;
+            radius: number;
+        };
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /** Stickerless look: tiles fill the face, small radius, dark grey core. */
+    stickerless: {
+        body: string;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        stickers: {
+            colors: readonly ["#ffffff", "#e8322f", "#1fb24a", "#ffd500", "#ff8a00", "#1e5eff"];
+            size: number;
+            radius: number;
+            fillOuter: true;
+            thickness: number;
+            bevel: number;
+            edgeRadius: number;
+            material: "plastic";
+        };
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+};
+export declare const SKINS: {
+    /** GAN, stickered: GAN's stickers (rounded squares, edges with a round tongue, round centres), flat prints on black. */
+    ganStickers: Skin;
+    /** MoYu, stickered: MoYu's stickers on black. */
+    moyuStickers: Skin;
+    /** The default look, stickered: its shapes as stickers on black plastic that follows their curves. */
+    defaultStickers: Skin;
+    /** QiYi, stickered — the round black cube ("black rounded" in QiYi's app). */
+    qiyiStickersRounded: Skin;
+    /** QiYi, stickered — the square black cube ("black square" in QiYi's app). */
+    qiyiStickersSquare: Skin;
+    /**
+     * The default look: a modern stickerless speed cube, after the GAN i4's
+     * pieces (the sample glTF models are exported from it) — thick matte tiles
+     * with soft edges, corners towards the centre rounded, squarish centres,
+     * pieces moulded in colour. Stickered: `defaultStickers`.
+     */
+    default: {
+        features: undefined;
+        body: string;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        pieces: {
+            depth: number;
+            taper: number;
+            wall: number;
+            relief: {
+                radius: number;
+                depth: number;
+                start: number;
+                tile: number;
+            };
+            mechanism: number;
+            core: number;
+            colored: true;
+            fill: "solid";
+        };
+        stickerSet: {
+            size: number;
+            centerSize: number;
+            margin: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            edgeRadius: number;
+        };
+        stickers: {
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            thickness: number;
+            bevel: number;
+            edgeRadius: number;
+            material: "plastic";
+            roughness: number;
+            fillOuter: true;
+        };
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /**
+     * GAN (stickerless), after the GAN 356 M: square corner tiles, edge tiles
+     * with a round tongue towards the centre, near-round centres — thick tiles
+     * with soft, well-rounded edges on pieces moulded in colour. No logo —
+     * that's up to the app (a decal).
+     */
+    gan: {
+        body: string;
+        pictureBody: null;
+        pieces: {
+            colored: true;
+            depth: number;
+            taper: number;
+            wall: number;
+            relief: {
+                radius: number;
+                depth: number;
+                start: number;
+                tile: number;
+            };
+            mechanism: number;
+            core: number;
+            fill: "solid";
+        };
+        stickers: {
+            thickness: number;
+            bevel: number;
+            edgeRadius: number;
+            kinds: {
+                center: {
+                    size: number;
+                    thickness: number;
+                    bevel: number;
+                };
+            };
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            material: "plastic";
+            roughness: number;
+            fillOuter: true;
+        };
+        stickerSet: {
+            size: number;
+            centerSize: number;
+            margin: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            edgeRadius: number;
+        };
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /**
+     * QiYi QY-SC smart cube (from photos): stickerless, moulded in colour
+     * (a corner is three coloured parts, an edge two) around an ivory core;
+     * thick "pillow" tiles with minimal gaps — corner tiles nearly square,
+     * edge tiles rounded towards the centre, a smaller raised squircle
+     * centre. The brand logo is up to the app (a decal).
+     */
+    qiyiSC: {
+        body: string;
+        pictureBody: null;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        pieces: {
+            depth: number;
+            taper: number;
+            wall: number;
+            relief: {
+                radius: number;
+                depth: number;
+                start: number;
+                tile: number;
+            };
+            mechanism: number;
+            core: number;
+            colored: true;
+            fill: "solid";
+        };
+        stickers: {
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            paths: {
+                corner: string;
+                edge: string;
+            };
+            thickness: number;
+            bevel: number;
+            kinds: {
+                center: {
+                    size: number;
+                    bevel: number;
+                    dome: {
+                        flat: number;
+                        drop: number;
+                    };
+                };
+            };
+            edgeRadius: number;
+            material: "plastic";
+            roughness: number;
+            fillOuter: true;
+        };
+        stickerSet: StickerSet;
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+    /**
+     * MoYu smart cubes (WCU — MY32 and friends): stickerless, moulded in colour;
+     * thick tiles, corner tiles nearly square with a rounder corner towards the
+     * centre, edge tiles well rounded towards the centre, rounded-square
+     * centres. Shapes and colours from the cube model in MoYu's app (WCU CUBE).
+     * No logo — that's up to the app (a decal).
+     */
+    moyu: {
+        body: string;
+        pictureBody: null;
+        cubieSize: number;
+        cubieRadius: number;
+        bodyInset: number;
+        pieces: {
+            depth: number;
+            taper: number;
+            wall: number;
+            relief: {
+                radius: number;
+                depth: number;
+                start: number;
+                tile: number;
+            };
+            mechanism: number;
+            core: number;
+            colored: true;
+            fill: "solid";
+        };
+        stickers: {
+            colors: [string, string, string, string, string, string];
+            size: number;
+            radius: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            thickness: number;
+            bevel: number;
+            edgeRadius: number;
+            material: "plastic";
+            roughness: number;
+            fillOuter: true;
+        };
+        stickerSet: {
+            size: number;
+            margin: number;
+            shape: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            base: {
+                corner: {
+                    inner: number;
+                    outer: number;
+                };
+                edge: {
+                    inner: number;
+                    outer: number;
+                };
+                center: number;
+            };
+            edgeRadius: number;
+            body: string;
+        };
+        mask: {
+            ignored: string;
+            oriented: string;
+            dimAmount: number;
+        };
+        hints: {
+            enabled: false;
+            distance: number;
+            opacity: number;
+            ignoredOpacity: number;
+        };
+        background: null;
+        themes: {
+            light: SkinTheme;
+        };
+    };
+};
+/** Tile side of a piece kind, relative to a cubie face (`stickers.kinds` or `stickers.size`). */
+export declare const tileSize: (skin: Skin, kind: PieceKind) => number;
+/** How far a piece kind's tiles stand out (`stickers.kinds` or `stickers.thickness`). */
+export declare const tileThickness: (skin: Skin, kind: PieceKind) => number;
+export declare function stickerColor(skin: Skin, colorClass: number, state: MaskState): string | null;
+export declare function mix(hex: string, towards: string, amount: number): string;
+/** The same skin with other sticker colours (U R F D L B home-face order) — e.g. a Japanese scheme or a custom one. */
+export declare function withColors(skin: Skin, colors: readonly [string, string, string, string, string, string]): Skin;
+/**
+ * The stickered version of a skin: a black, rounded body with the brand's
+ * stickers (`skin.stickerSet`, else the skin's own shapes, at most 0.88 of a face)
+ * on top — `raised` (thick, rounded), `thin` (like a real sticker) or `flat`
+ * (a print). `options.set`: another sticker set of the brand (e.g. QiYi's
+ * square cube). Colours, logos and the rest stay.
+ */
+export declare function withStickers(skin: Skin, style?: StickerStyle, options?: {
+    set?: StickerSet;
+}): Skin;
+/** The same skin with another finish on its tiles / stickers: `matte`, `uv` (a glossy coat) or the skin's own (undefined). */
+export declare function withFinish(skin: Skin, finish: "matte" | "uv" | undefined): Skin;