three-low-poly 0.9.15 → 0.9.17

package/dist/index.d.ts

@@ -275,7 +275,7 @@ export declare class BifurcatedStaircaseGeometry extends BufferGeometry {
     constructor(stepWidth?: number, stepHeight?: number, stepDepth?: number, numStepsCentral?: number, numStepsBranch?: number, branchAngle?: number);
 }
 
-export declare class Bone extends Mesh {
+export declare class Bone extends Mesh<BoneGeometry, MeshStandardMaterial> {
     constructor();
 }
 
@@ -294,7 +294,14 @@ export declare class BoneGeometry extends BufferGeometry {
     constructor(radiusTop?: number, radiusBottom?: number, height?: number, radialSegments?: number);
 }
 
-export declare class Book extends Mesh {
+/**
+ * Book prefab
+ *
+ * Material indices:
+ * 0. cover
+ * 1. page
+ */
+export declare class Book extends Mesh<BookGeometry, MeshStandardMaterial[]> {
     constructor({ width, height, depth, coverThickness, pageIndent, coverColor, pageColor, }?: {
         width?: number | undefined;
         height?: number | undefined;
@@ -306,11 +313,18 @@ export declare class Book extends Mesh {
     });
 }
 
+/**
+ * Book
+ *
+ * Group indices:
+ * 0. cover
+ * 1. page
+ */
 export declare class BookGeometry extends BufferGeometry {
     constructor(width?: number, height?: number, depth?: number, coverThickness?: number, pageIndent?: number);
 }
 
-export declare class Bookshelf extends Mesh {
+export declare class Bookshelf extends Mesh<BookshelfGeometry, MeshStandardMaterial> {
     constructor({ width, //
         height, depth, shelves, frameThickness, open, }?: {
         width?: number | undefined;
@@ -334,10 +348,6 @@ export declare class BookshelfGeometry extends BufferGeometry {
     });
 }
 
-export declare class Bottle extends Group {
-    constructor();
-}
-
 export declare class BubblingEffect extends InstancedMesh {
     private bubblePositions;
     private velocities;
@@ -377,6 +387,18 @@ export declare class BurstShape extends Shape {
     constructor(sides?: number, innerRadius?: number, outerRadius?: number);
 }
 
+/**
+ * Calculate the sum of absolute differences for each channel
+ * difference = |r1 - r2| + |g1 - g2| + |b1 - b2|
+ */
+export declare function calculateChannelDifference(color1: [number, number, number], color2: [number, number, number]): number;
+
+/**
+ * Calculate the Euclidean distance between two colors in RGB space
+ * distance = sqrt((r1 - r2)^2 + (g1 - g2)^2 + (b1 - b2)^2)
+ */
+export declare function calculateDistance(color1: [number, number, number], color2: [number, number, number]): number;
+
 /**
  * Compute normal based on the quad’s vertices (using the cross product of two edges).
  */
@@ -391,6 +413,32 @@ export declare function calculateUVBounds(uvs: [number, number][]): {
     maxBounds: [number, number];
 };
 
+/**
+ * Calculate the x-coordinate for a given y-coordinate using the slope-intercept equation of a line.
+ * x = x1 + (y - y1) / m
+ *
+ * Example usage
+ * ```
+ * const x1 = 0.8, y1 = 0, x2 = 1, y2 = 1.5, y = 1.0;
+ * const x = calculateXForY(x1, y1, x2, y2, y);
+ * console.log(`The x-position for y=${y} is x=${x.toFixed(4)}`);
+ * ```
+ */
+export declare function calculateXFromSlopeIntercept(x1: number, y1: number, x2: number, y2: number, y: number): number;
+
+/**
+ * Calculate the y-coordinate for a given x-coordinate using the slope-intercept equation of a line.
+ * y = y1 + m * (x - x1)
+ *
+ * Example usage
+ * ```
+ * const x1 = 0.8, y1 = 0, x2 = 1, y2 = 1.5, x = 0.9333;
+ * const y = calculateYForX(x1, y1, x2, y2, x);
+ * console.log(`The y-position for x=${x} is y=${y.toFixed(4)}`);
+ * ```
+ */
+export declare function calculateYFromSlopeIntercept(x1: number, y1: number, x2: number, y2: number, x: number): number;
+
 export declare class Candle extends Group {
     private candle;
     private flame;
@@ -462,6 +510,76 @@ export declare const circularEaseInOut: (t: number) => number;
 
 export declare const circularEaseOut: (t: number) => number;
 
+export declare const ColorPalette: {
+    CADMIUM_RED: number;
+    CARDINAL_RED: number;
+    CHERRY_RED: number;
+    CRIMSON: number;
+    ALIZARIN_CRIMSON: number;
+    RUST: number;
+    DARK_RED: number;
+    TANGERINE: number;
+    ORANGE_PEEL: number;
+    CADMIUM_ORANGE: number;
+    ORANGE: number;
+    AMBER: number;
+    CADMIUM_YELLOW: number;
+    GOLD: number;
+    YELLOW: number;
+    LIME_GREEN: number;
+    SPRING_GREEN: number;
+    MOSS_GREEN: number;
+    FERN_GREEN: number;
+    FOREST_GREEN: number;
+    SAP_GREEN: number;
+    OLIVE_DRAB: number;
+    VIRIDIAN_GREEN: number;
+    MINT_GREEN: number;
+    AQUAMARINE: number;
+    PHTHALO_BLUE: number;
+    SKY_BLUE: number;
+    CERULEAN_BLUE: number;
+    AZURE: number;
+    OCEAN_BLUE: number;
+    ROYAL_BLUE: number;
+    MIDNIGHT_BLUE: number;
+    ULTRAMARINE_BLUE: number;
+    COBALT_VIOLET: number;
+    DEEP_VIOLET: number;
+    CORAL_PINK: number;
+    VIVID_MAGENTA: number;
+    MAGENTA: number;
+    HOT_PINK: number;
+    PINK_SHERBET: number;
+    SOFT_PINK: number;
+    BURNT_SIENNA: number;
+    BURNT_UMBER: number;
+    SIENNA: number;
+    SADDLE_BROWN: number;
+    COFFEE_BROWN: number;
+    DARK_UMBER: number;
+    RAW_UMBER: number;
+    YELLOW_OCHRE: number;
+    RAW_SIENNA: number;
+    TAUPE: number;
+    ONYX: number;
+    CARBON: number;
+    CHARCOAL: number;
+    SLATE_GRAY: number;
+    ASH_GRAY: number;
+    GRAPHITE: number;
+    STEEL_GRAY: number;
+    DIM_GRAY: number;
+    IRON: number;
+    GRAY: number;
+    STONE: number;
+    SILVER: number;
+    LIGHT_GRAY: number;
+    PALE_GRAY: number;
+    WHITE_SMOKE: number;
+    TITANIUM_WHITE: number;
+};
+
 export declare const concave: (t: number) => number;
 
 export declare const convex: (t: number) => number;
@@ -642,8 +760,8 @@ export declare const createQuadraticCurvePoints: (start: Vector2, control: Vecto
  */
 export declare const createSigmoidCurvePoints: (start: Vector2, end: Vector2, a: number, segments?: number) => Vector2[];
 
-export declare class CrossHeadstone extends Mesh {
-    constructor({ width, height, depth, material, }?: CrossHeadstoneOptions);
+export declare class CrossHeadstone extends Mesh<CrossHeadstoneGeometry, MeshStandardMaterial> {
+    constructor({ width, height, depth, }?: CrossHeadstoneOptions);
 }
 
 export declare class CrossHeadstoneGeometry extends BufferGeometry {
@@ -654,7 +772,6 @@ declare interface CrossHeadstoneOptions {
     width?: number;
     height?: number;
     depth?: number;
-    material?: Material;
 }
 
 export declare const cubicCurve: (t: number, p0: number, p1: number, p2: number, p3: number) => number;
@@ -745,12 +862,20 @@ export declare interface DaySkyUniforms {
     bottomColor: Uniform<Color>;
 }
 
-export declare class Desk extends Mesh {
-    geometry: DeskGeometry;
-    material: MeshStandardMaterial[];
+/**
+ * Material indices:
+ * 0. Desk surface
+ * 1. Desk legs
+ */
+export declare class Desk extends Mesh<DeskGeometry, MeshStandardMaterial[]> {
     constructor();
 }
 
+/**
+ * Group indices:
+ * 0. Desk surface
+ * 1. Desk legs
+ */
 export declare class DeskGeometry extends BufferGeometry {
     constructor();
 }
@@ -933,7 +1058,7 @@ export declare interface EmissivePulseEffectOptions {
     material: MeshStandardMaterial | MeshPhysicalMaterial | MeshLambertMaterial | MeshPhongMaterial;
 }
 
-export declare class ErlenmeyerFlask extends Mesh {
+export declare class ErlenmeyerFlask extends Mesh<ErlenmeyerFlaskGeometry, MeshPhysicalMaterial> {
     constructor({ flaskRadius, //
         neckRadius, height, neckHeight, radialSegments, }?: {
         flaskRadius?: number | undefined;
@@ -989,20 +1114,9 @@ export declare const Falloff: {
     SMOOTHSTEP: (distance: number, radius: number) => number;
 };
 
-export declare class FenceColumn extends Mesh {
-    constructor({ height }?: {
-        height?: number | undefined;
-    });
-}
+export declare function findClosestColor(inputColor: number, dataset: number[]): number | null;
 
-/**
- * Fence Column Geometry, a stone slab fence column shape
- */
-export declare class FenceColumnGeometry extends BufferGeometry {
-    constructor({ height }?: {
-        height?: number | undefined;
-    });
-}
+export declare function findClosestColorChannelWise(inputColor: number, dataset: number[]): number | null;
 
 export declare class Flask extends Group {
     constructor();
@@ -1013,9 +1127,7 @@ export declare class Flask extends Group {
  */
 export declare const flattenBrush: <T extends BufferGeometry>(geometry: T, position: Vector3, radius: number, targetHeight: number, strength: number, direction?: Vector3, falloffFn?: (distance: number, radius: number) => number) => void;
 
-export declare class FlorenceFlask extends Mesh {
-    geometry: FlorenceFlaskGeometry;
-    material: MeshPhysicalMaterial;
+export declare class FlorenceFlask extends Mesh<FlorenceFlaskGeometry, MeshPhysicalMaterial> {
     constructor();
 }
 
@@ -1054,6 +1166,16 @@ export declare class GearShape extends Shape {
     constructor(sides?: number, innerRadius?: number, outerRadius?: number, holeSides?: number, holeRadius?: number);
 }
 
+/**
+ * Example usage:
+ * ```
+ * const baseHue = Math.floor(Math.random() * 360);
+ * const color1 = getAnalogousColors(baseHue);
+ * const color2 = getAnalogousColors(baseHue);
+ * ```
+ */
+export declare function getAnalogousColors(baseHue: number): [number, number, number];
+
 export declare class Heart extends Mesh {
     constructor(size?: number, width?: number, height?: number, tipDepth?: number, depth?: number);
 }
@@ -1062,6 +1184,14 @@ export declare class HeartShape extends Shape {
     constructor(size?: number, width?: number, height?: number, tipDepth?: number);
 }
 
+export declare function hexToHsl(hex: number): [number, number, number];
+
+/**
+ * Convert hexadecimal literal numeric color value to RGB array
+ * @param hex
+ */
+export declare function hexToRgb(hex: number): [number, number, number];
+
 export declare class Hill extends Mesh {
     constructor({ radius, //
         height, widthSegments, heightSegments, phiStart, phiLength, }?: {
@@ -1086,6 +1216,20 @@ export declare class HillGeometry extends BufferGeometry {
     });
 }
 
+/**
+ * Example usage:
+ * ```
+ * const h = 200; // Hue
+ * const s = 75;  // Saturation
+ * const l = 50;  // Lightness
+ *
+ * const [ r, g, b ] = hslToHex(h, s, l);
+ * ```
+ */
+export declare function hslToHex(h: number, s: number, l: number): [number, number, number];
+
+export declare function hslToRgb(h: number, s: number, l: number): [number, number, number];
+
 /**
  * Generates an array of interpolated 2D points using an easing function.
  * @param curveFunction - The easing function to apply to the normalized value.
@@ -1166,6 +1310,11 @@ declare interface LightningEffectOptions {
 
 export declare const linear: (t: number) => number;
 
+export declare const LineEquations: {
+    calculateXFromSlopeIntercept: typeof calculateXFromSlopeIntercept;
+    calculateYFromSlopeIntercept: typeof calculateYFromSlopeIntercept;
+};
+
 export declare const logarithmic: (t: number) => number;
 
 export declare const logarithmicCurve: (t: number, base?: number, factor?: number) => number;
@@ -1198,7 +1347,27 @@ export declare class LShapedStaircaseGeometry extends BufferGeometry {
     constructor(stepWidth?: number, stepHeight?: number, stepDepth?: number, numStepsPerFlight?: number, landingDepth?: number);
 }
 
-export declare class Mausoleum extends Group {
+/**
+ * Material indices:
+ * 0. Base
+ * 1. Building
+ * 2. Roof
+ * 3. Arched entrance
+ */
+export declare class Mausoleum extends Mesh<MausoleumGeometry, MeshStandardMaterial[]> {
+    constructor();
+}
+
+/**
+ * Mausoleum Geometry
+ *
+ * Group indices:
+ * 0. Base
+ * 1. Building
+ * 2. Roof
+ * 3. Arched entrance
+ */
+export declare class MausoleumGeometry extends BufferGeometry {
     constructor();
 }
 
@@ -1206,10 +1375,24 @@ export declare class Microscope extends Group {
     constructor();
 }
 
-export declare class Moon extends Group {
+export declare class Moon extends Mesh<SphereGeometry, ShaderMaterial> {
     constructor();
 }
 
+/**
+ * Moon shader
+ * Simple moon effect with noise
+ */
+export declare const moonShader: {
+    uniforms: {
+        time: {
+            value: number;
+        };
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};
+
 export declare class MortarAndPestle extends Group {
     constructor();
 }
@@ -1339,6 +1522,8 @@ declare interface NoiseDisplacementOptions {
     scale?: number;
 }
 
+export declare function normalizeRgb(r: number, g: number, b: number): [number, number, number];
+
 /**
  * Generic Normalization Function
  * This function will normalize 2D UV coordinates based on given bounds.
@@ -1364,7 +1549,7 @@ export declare function normalizeUV(uv: [number, number], minU: number, maxU: nu
  */
 export declare function normalizeUVBatch(uvs: [number, number][], minBounds: [number, number], maxBounds: [number, number]): [number, number][];
 
-export declare class ObeliskHeadstone extends Mesh {
+export declare class ObeliskHeadstone extends Mesh<ObeliskHeadstoneGeometry, MeshStandardMaterial> {
     constructor({ totalHeight, baseWidth }?: ObeliskHeadstoneOptions);
 }
 
@@ -1446,6 +1631,11 @@ export declare const ParametricCurveUtils: {
     createSigmoidCurvePoints: (start: Vector2, end: Vector2, a: number, segments?: number) => Vector2[];
 };
 
+/**
+ * Convert hex color code color string to RGB array
+ */
+export declare function parseHexCode(hex: string): [number, number, number];
+
 /**
  * The camera swings back and forth like a pendulum.
  *
@@ -1492,6 +1682,30 @@ export declare function planarUVMapping(vertices: [number, number, number][], ax
  */
 export declare function polarUVMapping(vertices: [number, number, number][]): [number, number][];
 
+/**
+ * Potion bottle, with optional liquid fill
+ *
+ * Material indices
+ * 0. Bottle
+ * 1. Cork
+ * 2. Liquid (optional)
+ */
+export declare class PotionBottle extends Mesh<PotionBottleGeometry, MeshStandardMaterial[]> {
+    constructor();
+}
+
+/**
+ * Potion bottle geometry
+ *
+ * Group indices
+ * 0. Bottle
+ * 1. Cork
+ * 2. Liquid (optional)
+ */
+export declare class PotionBottleGeometry extends BufferGeometry {
+    constructor();
+}
+
 export declare const quadraticCurve: (t: number, p0: number, p1: number, p2: number) => number;
 
 export declare const quadraticEaseIn: (t: number) => number;
@@ -1536,7 +1750,21 @@ export declare function randomInteger(min?: number, max?: number): number;
 
 export declare function randomTransformVertices<T extends BufferGeometry>(geometry: T, axis?: Vector3, minScale?: number, maxScale?: number): T;
 
-export declare class Rock extends Mesh {
+export declare function rgbToHex(r: number, g: number, b: number): number;
+
+/**
+ * Converts an RGB color to HSL.
+ *
+ * Example usage:
+ * ```
+ * const rgbColor = { r: 255, g: 0, b: 0 }; // Red
+ * const hslColor = rgbToHsl(rgbColor.r, rgbColor.g, rgbColor.b);
+ * console.log(hslColor); // Output: { h: 0, s: 100, l: 50 }
+ * ```
+ */
+export declare function rgbToHsl(r: number, g: number, b: number): [number, number, number];
+
+export declare class Rock extends Mesh<RockGeometry, MeshStandardMaterial> {
     constructor(radius?: number, widthSegments?: number, heightSegments?: number);
 }
 
@@ -1548,7 +1776,7 @@ export declare class Rocks extends Group {
     constructor();
 }
 
-export declare class RoundedHeadstone extends Mesh {
+export declare class RoundedHeadstone extends Mesh<RoundedHeadstoneGeometry, MeshStandardMaterial> {
     constructor(width?: number, height?: number, depth?: number, radius?: number);
 }
 
@@ -1684,7 +1912,7 @@ export declare class SpiralTube extends Group {
     constructor();
 }
 
-export declare class SquareHeadstone extends Mesh {
+export declare class SquareHeadstone extends Mesh<SquareHeadstoneGeometry, MeshStandardMaterial> {
     constructor(width?: number, height?: number, depth?: number);
 }
 
@@ -1698,9 +1926,7 @@ export declare class StaircaseGeometry extends BufferGeometry {
     constructor(width?: number, stepHeight?: number, stepDepth?: number, numSteps?: number);
 }
 
-export declare class Stand extends Mesh {
-    geometry: StandGeometry;
-    material: MeshStandardMaterial;
+export declare class Stand extends Mesh<StandGeometry, MeshStandardMaterial> {
     constructor({ radius, //
         height, count, thickness, radialSegments, }?: {
         radius?: number | undefined;
@@ -1730,11 +1956,26 @@ export declare class StarShape extends Shape {
     constructor(points?: number, innerRadius?: number, outerRadius?: number);
 }
 
+export declare class StoneFencePost extends Mesh<StoneFencePostGeometry, MeshStandardMaterial> {
+    constructor({ height }?: {
+        height?: number | undefined;
+    });
+}
+
+/**
+ * Fence Column Geometry, a stone slab fence column shape
+ */
+export declare class StoneFencePostGeometry extends BufferGeometry {
+    constructor({ height }?: {
+        height?: number | undefined;
+    });
+}
+
 export declare class TeslaCoil extends Group {
     constructor();
 }
 
-export declare class TestTube extends Group {
+export declare class TestTube extends Mesh<TestTubeGeometry, MeshPhysicalMaterial> {
     constructor(radiusTop?: number, radiusBottom?: number, height?: number, segments?: number);
 }
 
@@ -1747,7 +1988,12 @@ export declare class TestTubeRack extends Group {
 }
 
 /**
- * @example
+ * Material indices:
+ * 0. Trunk
+ * 1. leafSize
+ *
+ * Example usage:
+ * ```
  * const tree = new Tree({
  *   trunkRadiusTop: 0.25,
  *   trunkRadiusBottom: 0.4,
@@ -1760,8 +2006,9 @@ export declare class TestTubeRack extends Group {
  *   leafSpreadRadius: 1.5,
  *   leafColor: 0x228b22,
  * });
+ * ```
  */
-export declare class Tree extends Mesh {
+export declare class Tree extends Mesh<TreeGeometry, MeshStandardMaterial[]> {
     constructor({ trunkRadiusTop, trunkRadiusBottom, trunkHeight, trunkSegments, trunkColor, leafSize, leafCount, leafDetail, leafSpreadRadius, leafColor, }?: {
         trunkRadiusTop?: number | undefined;
         trunkRadiusBottom?: number | undefined;
@@ -1815,7 +2062,7 @@ export declare function updateNoiseDisplacementTime<T extends Material>(material
  */
 export declare function updateWaterDisplacementTime<T extends Material>(material: T, deltaTime: number): void;
 
-export declare class WineBottle extends Mesh {
+export declare class WineBottle extends Mesh<WineBottleGeometry, MeshPhysicalMaterial> {
     constructor();
 }
 
@@ -1841,7 +2088,7 @@ export declare class WineBottleGeometry extends BufferGeometry {
  */
 export declare function wobbleAnimation(camera: Camera, intensity: number, duration: number, onComplete?: () => void): void;
 
-export declare class WroughtIronBar extends Mesh {
+export declare class WroughtIronBar extends Mesh<WroughtIronBarGeometry, MeshStandardMaterial> {
     constructor({ barHeight, //
         barRadius, spikeHeight, spikeRadius, spikeScaleZ, radialSegments, }?: {
         barHeight?: number | undefined;
@@ -1868,7 +2115,7 @@ export declare class WroughtIronBarGeometry extends BufferGeometry {
     });
 }
 
-export declare class WroughtIronFence extends Mesh {
+export declare class WroughtIronFence extends Mesh<WroughtIronFenceGeometry, MeshStandardMaterial> {
     constructor({ count, //
         spacing, barHeight, barRadius, spikeHeight, spikeRadius, spikeScaleZ, railHeight, railDepth, railOffset, radialSegments, }?: {
         count?: number | undefined;