three-low-poly 0.9.18 → 0.9.19

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { MeshLambertMaterial } from 'three';
 import { MeshPhongMaterial } from 'three';
 import { MeshPhysicalMaterial } from 'three';
 import { MeshStandardMaterial } from 'three';
+import { ParametricGeometry } from 'three-stdlib';
 import { PerspectiveCamera } from 'three';
 import { ShaderMaterial } from 'three';
 import { Shape } from 'three';
@@ -575,14 +576,38 @@ export declare function cameraWobbleAnimation(camera: Camera, intensity: number,
  */
 export declare function cameraZoomInAnimation(camera: PerspectiveCamera, target: Vector3, startFov: number, endFov: number, duration: number, onComplete?: () => void): void;
 
-export declare class Candle extends Group {
-    private candle;
-    private flame;
-    private candleLight;
-    private height;
-    private radius;
-    constructor(height?: number, radius?: number);
-    animateFlicker(): void;
+/**
+ * Material indices
+ * 0: Stick
+ * 1: Flame
+ */
+export declare class Candle extends Mesh<CandleGeometry, MeshStandardMaterial[]> {
+    constructor({ radiusTop, //
+        radiusBottom, height, flameHeight, flameRadius, segments, }?: {
+        radiusTop?: number | undefined;
+        radiusBottom?: number | undefined;
+        height?: number | undefined;
+        flameHeight?: number | undefined;
+        flameRadius?: number | undefined;
+        segments?: number | undefined;
+    });
+}
+
+/**
+ * Group indices
+ * 0: Stick
+ * 1: Flame
+ */
+export declare class CandleGeometry extends BufferGeometry {
+    constructor({ radiusTop, //
+        radiusBottom, height, flameHeight, flameRadius, segments, }?: {
+        radiusTop?: number | undefined;
+        radiusBottom?: number | undefined;
+        height?: number | undefined;
+        flameHeight?: number | undefined;
+        flameRadius?: number | undefined;
+        segments?: number | undefined;
+    });
 }
 
 /**
@@ -623,12 +648,22 @@ export declare function centerInstancedMesh<T extends InstancedMesh>(mesh: T): v
 export declare function centerMesh<T extends Mesh>(mesh: T): void;
 
 /**
- * Centers the geometry of the given mesh at the local origin (0, 0, 0) by modifying the geometry vertices.
+ * Centers a Mesh at the specified target position.
+ */
+export declare function centerMeshAtTarget<T extends Mesh>(mesh: T, target?: Vector3): void;
+
+/**
+ * Centers the geometry of the Mesh at the local origin (0, 0, 0) by modifying the geometry vertices.
  * This method moves the geometry itself so that its center is at the local origin,
  * without affecting the position, rotation, or scale of the mesh.
  */
 export declare function centerMeshGeometry<T extends Mesh>(mesh: T): void;
 
+/**
+ * Centers the geometry of a Mesh at the specified target position.
+ */
+export declare function centerMeshGeometryAtTarget<T extends Mesh>(mesh: T, target?: Vector3): void;
+
 /**
  * Create a checkerboard texture
  *
@@ -1250,6 +1285,24 @@ export declare function findClosestColor(inputColor: number, dataset: number[]):
 
 export declare function findClosestColorChannelWise(inputColor: number, dataset: number[]): number | null;
 
+export declare class Flame extends Mesh<FlameGeometry, MeshStandardMaterial> {
+    constructor({ height, radius, segmentsU, segmentsV }?: {
+        height?: number | undefined;
+        radius?: number | undefined;
+        segmentsU?: number | undefined;
+        segmentsV?: number | undefined;
+    });
+}
+
+export declare class FlameGeometry extends ParametricGeometry {
+    constructor({ height, radius, segmentsU, segmentsV }?: {
+        height?: number | undefined;
+        radius?: number | undefined;
+        segmentsU?: number | undefined;
+        segmentsV?: number | undefined;
+    });
+}
+
 /**
  * Flattens vertices to a given plane defined by a target height or normal direction.
  */
@@ -1398,6 +1451,65 @@ export declare class LeverPanel extends Group {
     constructor();
 }
 
+/**
+ * Create a light flicker animation that will randomly change the intensity and position of a light.
+ * Effect resembles a flickering flame of candlelight.
+ *
+ * Example usage:
+ * ```
+ *    // Create a candle
+ *    const candle = new Candle({
+ *      height: 1,
+ *      flameHeight: 0.25,
+ *    });
+ *    scene.add(candle);
+ *
+ *    // Create a point light
+ *    const candleLight = new THREE.PointLight(0xffa500, 1, 5);
+ *    scene.add(candleLight);
+ *
+ *    // Apply the animator to the light
+ *    const lightAnimation = new LightFlickerAnimation({
+ *      light: candleLight,
+ *      maxIntensity: 2.2,
+ *      x: candle.position.x,
+ *      y: candle.position.y + 1 + 0.125, // height + half flame height
+ *      z: candle.position.z,
+ *    });
+ *    animations.push(lightAnimation);
+ *
+ *    // Update the light animation in the render loop
+ *    renderer.setAnimationLoop(() => {
+ *      lightAnimation.update();
+ *    });
+ * ```
+ */
+export declare class LightFlickerAnimation {
+    private light?;
+    minIntensity: number;
+    maxIntensity: number;
+    x: number;
+    y: number;
+    z: number;
+    jitterX: number;
+    jitterY: number;
+    jitterZ: number;
+    constructor({ light, minIntensity, maxIntensity, x, y, z, jitterX, jitterY, jitterZ, }?: Partial<LightFlickerAnimationOptions>);
+    update(): void;
+}
+
+export declare interface LightFlickerAnimationOptions {
+    light?: Light;
+    minIntensity: number;
+    maxIntensity: number;
+    x: number;
+    y: number;
+    z: number;
+    jitterX: number;
+    jitterY: number;
+    jitterZ: number;
+}
+
 /**
  * A lightning animation that can be used to simulate a lightning storm.
  * This effect is applied to a light source.