three-low-poly 0.9.15 → 0.9.16

package/dist/index.d.ts

@@ -294,7 +294,12 @@ export declare class BoneGeometry extends BufferGeometry {
     constructor(radiusTop?: number, radiusBottom?: number, height?: number, radialSegments?: number);
 }
 
-export declare class Book extends Mesh {
+/**
+ * Material Order:
+ *   1. Cover
+ *   2. Page
+ */
+export declare class Book extends Mesh<BookGeometry, MeshStandardMaterial[]> {
     constructor({ width, height, depth, coverThickness, pageIndent, coverColor, pageColor, }?: {
         width?: number | undefined;
         height?: number | undefined;
@@ -377,6 +382,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).
  */
@@ -462,6 +479,60 @@ export declare const circularEaseInOut: (t: number) => number;
 
 export declare const circularEaseOut: (t: number) => number;
 
+export declare const ColorPalette: {
+    CARDINAL_RED: number;
+    CHERRY_RED: number;
+    CRIMSON: number;
+    RUST: number;
+    DARK_RED: number;
+    TANGERINE: number;
+    ORANGE_PEEL: number;
+    ORANGE: number;
+    AMBER: number;
+    GOLD: number;
+    YELLOW: number;
+    LIME_GREEN: number;
+    SPRING_GREEN: number;
+    MOSS_GREEN: number;
+    FERN_GREEN: number;
+    FOREST_GREEN: number;
+    OLIVE_DRAB: number;
+    MINT_GREEN: number;
+    AQUAMARINE: number;
+    SKY_BLUE: number;
+    CERULEAN_BLUE: number;
+    AZURE: number;
+    OCEAN_BLUE: number;
+    ROYAL_BLUE: number;
+    MIDNIGHT_BLUE: number;
+    CORAL_PINK: number;
+    VIVID_MAGENTA: number;
+    MAGENTA: number;
+    HOT_PINK: number;
+    PINK_SHERBET: number;
+    SOFT_PINK: number;
+    DEEP_VIOLET: number;
+    TAUPE: number;
+    SIENNA: number;
+    SADDLE_BROWN: number;
+    COFFEE_BROWN: number;
+    DARK_UMBER: number;
+    ONYX: number;
+    CARBON: number;
+    CHARCOAL: number;
+    SLATE_GRAY: number;
+    ASH_GRAY: number;
+    STEEL_GRAY: number;
+    COOL_GRAY: number;
+    IRON: number;
+    GRAY: number;
+    STONE: number;
+    SILVER: number;
+    PALE_GRAY: number;
+    WHITE_SMOKE: number;
+    WHITE: number;
+};
+
 export declare const concave: (t: number) => number;
 
 export declare const convex: (t: number) => number;
@@ -642,8 +713,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 +725,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;
@@ -989,7 +1059,7 @@ export declare const Falloff: {
     SMOOTHSTEP: (distance: number, radius: number) => number;
 };
 
-export declare class FenceColumn extends Mesh {
+export declare class FenceColumn extends Mesh<FenceColumnGeometry, MeshStandardMaterial> {
     constructor({ height }?: {
         height?: number | undefined;
     });
@@ -1004,6 +1074,10 @@ export declare class FenceColumnGeometry extends BufferGeometry {
     });
 }
 
+export declare function findClosestColor(inputColor: number, dataset: number[]): number | null;
+
+export declare function findClosestColorChannelWise(inputColor: number, dataset: number[]): number | null;
+
 export declare class Flask extends Group {
     constructor();
 }
@@ -1054,6 +1128,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 +1146,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 +1178,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.
@@ -1206,10 +1312,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 +1459,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 +1486,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 +1568,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.
  *
@@ -1536,6 +1663,20 @@ 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 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 {
     constructor(radius?: number, widthSegments?: number, heightSegments?: number);
 }
@@ -1548,7 +1689,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 +1825,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);
 }
 
@@ -1841,7 +1982,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 +2009,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;