three-low-poly 0.9.16 → 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();
 }
 
@@ -295,9 +295,11 @@ export declare class BoneGeometry extends BufferGeometry {
 }
 
 /**
- * Material Order:
- *   1. Cover
- *   2. Page
+ * Book prefab
+ *
+ * Material indices:
+ * 0. cover
+ * 1. page
  */
 export declare class Book extends Mesh<BookGeometry, MeshStandardMaterial[]> {
     constructor({ width, height, depth, coverThickness, pageIndent, coverColor, pageColor, }?: {
@@ -311,11 +313,18 @@ export declare class Book extends Mesh<BookGeometry, MeshStandardMaterial[]> {
     });
 }
 
+/**
+ * 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;
@@ -339,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;
@@ -408,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;
@@ -480,15 +511,19 @@ 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;
@@ -496,41 +531,53 @@ export declare const ColorPalette: {
     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;
-    DEEP_VIOLET: number;
-    TAUPE: 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;
-    COOL_GRAY: number;
+    DIM_GRAY: number;
     IRON: number;
     GRAY: number;
     STONE: number;
     SILVER: number;
+    LIGHT_GRAY: number;
     PALE_GRAY: number;
     WHITE_SMOKE: number;
-    WHITE: number;
+    TITANIUM_WHITE: number;
 };
 
 export declare const concave: (t: number) => number;
@@ -815,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();
 }
@@ -1003,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;
@@ -1059,21 +1114,6 @@ export declare const Falloff: {
     SMOOTHSTEP: (distance: number, radius: number) => number;
 };
 
-export declare class FenceColumn extends Mesh<FenceColumnGeometry, MeshStandardMaterial> {
-    constructor({ height }?: {
-        height?: number | undefined;
-    });
-}
-
-/**
- * Fence Column Geometry, a stone slab fence column shape
- */
-export declare class FenceColumnGeometry extends BufferGeometry {
-    constructor({ height }?: {
-        height?: number | undefined;
-    });
-}
-
 export declare function findClosestColor(inputColor: number, dataset: number[]): number | null;
 
 export declare function findClosestColorChannelWise(inputColor: number, dataset: number[]): number | null;
@@ -1087,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();
 }
 
@@ -1272,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;
@@ -1304,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();
 }
 
@@ -1619,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;
@@ -1677,7 +1764,7 @@ export declare function rgbToHex(r: number, g: number, b: number): number;
  */
 export declare function rgbToHsl(r: number, g: number, b: number): [number, number, number];
 
-export declare class Rock extends Mesh {
+export declare class Rock extends Mesh<RockGeometry, MeshStandardMaterial> {
     constructor(radius?: number, widthSegments?: number, heightSegments?: number);
 }
 
@@ -1839,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;
@@ -1871,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);
 }
 
@@ -1888,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,
@@ -1901,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;
@@ -1956,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();
 }